oci-go-sdk: github.com/oracle/oci-go-sdk/limits Index | Files

package limits

import "github.com/oracle/oci-go-sdk/limits"

Index

Package Files

create_quota_details.go create_quota_request_response.go delete_quota_request_response.go get_quota_request_response.go get_resource_availability_request_response.go limit_definition_summary.go limit_value_summary.go limits_client.go limits_quotas_client.go list_limit_definitions_request_response.go list_limit_values_request_response.go list_quotas_request_response.go list_services_request_response.go quota.go quota_summary.go resource_availability.go service_summary.go update_quota_details.go update_quota_request_response.go

type CreateQuotaDetails Uses

type CreateQuotaDetails struct {

    // The OCID of the compartment containing the resource this quota applies to.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The description you assign to the quota.
    Description *string `mandatory:"true" json:"description"`

    // The name you assign to the quota during creation. The name must be unique across all quotas
    // in the tenancy and cannot be changed.
    Name *string `mandatory:"true" json:"name"`

    // An array of quota statements written in the declarative quota statement language.
    Statements []string `mandatory:"true" json:"statements"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateQuotaDetails Request object for create quota operation.

func (CreateQuotaDetails) String Uses

func (m CreateQuotaDetails) String() string

type CreateQuotaRequest Uses

type CreateQuotaRequest struct {

    // Request object for creating a new quota.
    CreateQuotaDetails `contributesTo:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateQuotaRequest wrapper for the CreateQuota operation

func (CreateQuotaRequest) HTTPRequest Uses

func (request CreateQuotaRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateQuotaRequest) RetryPolicy Uses

func (request CreateQuotaRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateQuotaRequest) String Uses

func (request CreateQuotaRequest) String() string

type CreateQuotaResponse Uses

type CreateQuotaResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Quota instance
    Quota `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

CreateQuotaResponse wrapper for the CreateQuota operation

func (CreateQuotaResponse) HTTPResponse Uses

func (response CreateQuotaResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateQuotaResponse) String Uses

func (response CreateQuotaResponse) String() string

type DeleteQuotaRequest Uses

type DeleteQuotaRequest struct {

    // The OCID of the quota.
    QuotaId *string `mandatory:"true" contributesTo:"path" name:"quotaId"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
    // parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
    // will be updated or deleted only if the etag you provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteQuotaRequest wrapper for the DeleteQuota operation

func (DeleteQuotaRequest) HTTPRequest Uses

func (request DeleteQuotaRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteQuotaRequest) RetryPolicy Uses

func (request DeleteQuotaRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteQuotaRequest) String Uses

func (request DeleteQuotaRequest) String() string

type DeleteQuotaResponse Uses

type DeleteQuotaResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteQuotaResponse wrapper for the DeleteQuota operation

func (DeleteQuotaResponse) HTTPResponse Uses

func (response DeleteQuotaResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteQuotaResponse) String Uses

func (response DeleteQuotaResponse) String() string

type GetQuotaRequest Uses

type GetQuotaRequest struct {

    // The OCID of the quota.
    QuotaId *string `mandatory:"true" contributesTo:"path" name:"quotaId"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetQuotaRequest wrapper for the GetQuota operation

func (GetQuotaRequest) HTTPRequest Uses

func (request GetQuotaRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetQuotaRequest) RetryPolicy Uses

func (request GetQuotaRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetQuotaRequest) String Uses

func (request GetQuotaRequest) String() string

type GetQuotaResponse Uses

type GetQuotaResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Quota instance
    Quota `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

GetQuotaResponse wrapper for the GetQuota operation

func (GetQuotaResponse) HTTPResponse Uses

func (response GetQuotaResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetQuotaResponse) String Uses

func (response GetQuotaResponse) String() string

type GetResourceAvailabilityRequest Uses

type GetResourceAvailabilityRequest struct {

    // The service name of the target quota.
    ServiceName *string `mandatory:"true" contributesTo:"path" name:"serviceName"`

    // The limit name for which to fetch the data.
    LimitName *string `mandatory:"true" contributesTo:"path" name:"limitName"`

    // The OCID of the compartment for which data is being fetched.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // This field is mandatory if the scopeType of the target resource limit is AD.
    // Otherwise, this field should be omitted.
    // If the above requirements are not met, the API will return a 400 - InvalidParameter response.
    AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetResourceAvailabilityRequest wrapper for the GetResourceAvailability operation

func (GetResourceAvailabilityRequest) HTTPRequest Uses

func (request GetResourceAvailabilityRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetResourceAvailabilityRequest) RetryPolicy Uses

func (request GetResourceAvailabilityRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetResourceAvailabilityRequest) String Uses

func (request GetResourceAvailabilityRequest) String() string

type GetResourceAvailabilityResponse Uses

type GetResourceAvailabilityResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The ResourceAvailability instance
    ResourceAvailability `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetResourceAvailabilityResponse wrapper for the GetResourceAvailability operation

func (GetResourceAvailabilityResponse) HTTPResponse Uses

func (response GetResourceAvailabilityResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetResourceAvailabilityResponse) String Uses

func (response GetResourceAvailabilityResponse) String() string

type LimitDefinitionSummary Uses

type LimitDefinitionSummary struct {

    // The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    Name *string `mandatory:"false" json:"name"`

    // The service name of the limit.
    ServiceName *string `mandatory:"false" json:"serviceName"`

    // The limit description.
    Description *string `mandatory:"false" json:"description"`

    // Reflects the scope of the resource limit: which can be Global (across all regions), regional or ad specific.
    ScopeType LimitDefinitionSummaryScopeTypeEnum `mandatory:"false" json:"scopeType,omitempty"`

    // If true, quota policies can be created on top of this resource limit.
    AreQuotasSupported *bool `mandatory:"false" json:"areQuotasSupported"`

    // Reflects if the GetResourceAvailability API is supported for this limit or not.
    // If not, the API will return an empty JSON response.
    IsResourceAvailabilitySupported *bool `mandatory:"false" json:"isResourceAvailabilitySupported"`
}

LimitDefinitionSummary The metadata specific to a resource limit definition.

func (LimitDefinitionSummary) String Uses

func (m LimitDefinitionSummary) String() string

type LimitDefinitionSummaryScopeTypeEnum Uses

type LimitDefinitionSummaryScopeTypeEnum string

LimitDefinitionSummaryScopeTypeEnum Enum with underlying type: string

const (
    LimitDefinitionSummaryScopeTypeGlobal LimitDefinitionSummaryScopeTypeEnum = "GLOBAL"
    LimitDefinitionSummaryScopeTypeRegion LimitDefinitionSummaryScopeTypeEnum = "REGION"
    LimitDefinitionSummaryScopeTypeAd     LimitDefinitionSummaryScopeTypeEnum = "AD"
)

Set of constants representing the allowable values for LimitDefinitionSummaryScopeTypeEnum

func GetLimitDefinitionSummaryScopeTypeEnumValues Uses

func GetLimitDefinitionSummaryScopeTypeEnumValues() []LimitDefinitionSummaryScopeTypeEnum

GetLimitDefinitionSummaryScopeTypeEnumValues Enumerates the set of values for LimitDefinitionSummaryScopeTypeEnum

type LimitValueSummary Uses

type LimitValueSummary struct {

    // The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    Name *string `mandatory:"false" json:"name"`

    // The scope type of the limit.
    ScopeType LimitValueSummaryScopeTypeEnum `mandatory:"false" json:"scopeType,omitempty"`

    // If present, the returned value is only specific to this availability domain.
    AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

    // The resource limit value.
    Value *int64 `mandatory:"false" json:"value"`
}

LimitValueSummary The value of a specific resource limit.

func (LimitValueSummary) String Uses

func (m LimitValueSummary) String() string

type LimitValueSummaryScopeTypeEnum Uses

type LimitValueSummaryScopeTypeEnum string

LimitValueSummaryScopeTypeEnum Enum with underlying type: string

const (
    LimitValueSummaryScopeTypeGlobal LimitValueSummaryScopeTypeEnum = "GLOBAL"
    LimitValueSummaryScopeTypeRegion LimitValueSummaryScopeTypeEnum = "REGION"
    LimitValueSummaryScopeTypeAd     LimitValueSummaryScopeTypeEnum = "AD"
)

Set of constants representing the allowable values for LimitValueSummaryScopeTypeEnum

func GetLimitValueSummaryScopeTypeEnumValues Uses

func GetLimitValueSummaryScopeTypeEnumValues() []LimitValueSummaryScopeTypeEnum

GetLimitValueSummaryScopeTypeEnumValues Enumerates the set of values for LimitValueSummaryScopeTypeEnum

type LimitsClient Uses

type LimitsClient struct {
    common.BaseClient
    // contains filtered or unexported fields
}

LimitsClient a client for Limits

func NewLimitsClientWithConfigurationProvider Uses

func NewLimitsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client LimitsClient, err error)

NewLimitsClientWithConfigurationProvider Creates a new default Limits client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewLimitsClientWithOboToken Uses

func NewLimitsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client LimitsClient, err error)

NewLimitsClientWithOboToken Creates a new default Limits client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (*LimitsClient) ConfigurationProvider Uses

func (client *LimitsClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (LimitsClient) GetResourceAvailability Uses

func (client LimitsClient) GetResourceAvailability(ctx context.Context, request GetResourceAvailabilityRequest) (response GetResourceAvailabilityResponse, err error)

GetResourceAvailability For a given compartmentId, resource limit name, and scope, returns the following:

- the number of available resources associated with the given limit
- the usage in the selected compartment for the given limit
Note: not all resource limits support this API. If the value is not available, the API will return 404.

func (LimitsClient) ListLimitDefinitions Uses

func (client LimitsClient) ListLimitDefinitions(ctx context.Context, request ListLimitDefinitionsRequest) (response ListLimitDefinitionsResponse, err error)

ListLimitDefinitions Includes a list of resource limits that are currently supported. If the 'areQuotasSupported' property is true, you can create quota policies on top of this limit at the compartment level.

func (LimitsClient) ListLimitValues Uses

func (client LimitsClient) ListLimitValues(ctx context.Context, request ListLimitValuesRequest) (response ListLimitValuesResponse, err error)

ListLimitValues Includes a full list of resource limits belonging to a given service.

func (LimitsClient) ListServices Uses

func (client LimitsClient) ListServices(ctx context.Context, request ListServicesRequest) (response ListServicesResponse, err error)

ListServices Returns the list of supported services. This will include the programmatic service name, along with the friendly service name.

func (*LimitsClient) SetRegion Uses

func (client *LimitsClient) SetRegion(region string)

SetRegion overrides the region of this client.

type ListLimitDefinitionsRequest Uses

type ListLimitDefinitionsRequest struct {

    // The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The target service name.
    ServiceName *string `mandatory:"false" contributesTo:"query" name:"serviceName"`

    // Optional field, filter for a specific resource limit.
    Name *string `mandatory:"false" contributesTo:"query" name:"name"`

    // The field to sort by.
    SortBy ListLimitDefinitionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc'. By default it will be ascending.
    SortOrder ListLimitDefinitionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The maximum number of items to return in a paginated "List" call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` response header from the previous "List" call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListLimitDefinitionsRequest wrapper for the ListLimitDefinitions operation

func (ListLimitDefinitionsRequest) HTTPRequest Uses

func (request ListLimitDefinitionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListLimitDefinitionsRequest) RetryPolicy Uses

func (request ListLimitDefinitionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListLimitDefinitionsRequest) String Uses

func (request ListLimitDefinitionsRequest) String() string

type ListLimitDefinitionsResponse Uses

type ListLimitDefinitionsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []LimitDefinitionSummary instances
    Items []LimitDefinitionSummary `presentIn:"body"`

    // For list pagination. When this header appears in the response, additional pages
    // of results remain. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListLimitDefinitionsResponse wrapper for the ListLimitDefinitions operation

func (ListLimitDefinitionsResponse) HTTPResponse Uses

func (response ListLimitDefinitionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListLimitDefinitionsResponse) String Uses

func (response ListLimitDefinitionsResponse) String() string

type ListLimitDefinitionsSortByEnum Uses

type ListLimitDefinitionsSortByEnum string

ListLimitDefinitionsSortByEnum Enum with underlying type: string

const (
    ListLimitDefinitionsSortByName        ListLimitDefinitionsSortByEnum = "name"
    ListLimitDefinitionsSortByDescription ListLimitDefinitionsSortByEnum = "description"
)

Set of constants representing the allowable values for ListLimitDefinitionsSortByEnum

func GetListLimitDefinitionsSortByEnumValues Uses

func GetListLimitDefinitionsSortByEnumValues() []ListLimitDefinitionsSortByEnum

GetListLimitDefinitionsSortByEnumValues Enumerates the set of values for ListLimitDefinitionsSortByEnum

type ListLimitDefinitionsSortOrderEnum Uses

type ListLimitDefinitionsSortOrderEnum string

ListLimitDefinitionsSortOrderEnum Enum with underlying type: string

const (
    ListLimitDefinitionsSortOrderAsc  ListLimitDefinitionsSortOrderEnum = "ASC"
    ListLimitDefinitionsSortOrderDesc ListLimitDefinitionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListLimitDefinitionsSortOrderEnum

func GetListLimitDefinitionsSortOrderEnumValues Uses

func GetListLimitDefinitionsSortOrderEnumValues() []ListLimitDefinitionsSortOrderEnum

GetListLimitDefinitionsSortOrderEnumValues Enumerates the set of values for ListLimitDefinitionsSortOrderEnum

type ListLimitValuesRequest Uses

type ListLimitValuesRequest struct {

    // The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The target service name
    ServiceName *string `mandatory:"true" contributesTo:"query" name:"serviceName"`

    // Filter entries by scope type.
    ScopeType ListLimitValuesScopeTypeEnum `mandatory:"false" contributesTo:"query" name:"scopeType" omitEmpty:"true"`

    // Filter entries by availability domain. This implies that only AD-specific values will be returned.
    AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

    // Optional field, can be used to see a specific resource limit value.
    Name *string `mandatory:"false" contributesTo:"query" name:"name"`

    // The field to sort by. We will be implicitly sorting by availabilityDomain, as a second level field, if available.
    SortBy ListLimitValuesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc'. By default it will be ascending.
    SortOrder ListLimitValuesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The maximum number of items to return in a paginated "List" call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` response header from the previous "List" call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListLimitValuesRequest wrapper for the ListLimitValues operation

func (ListLimitValuesRequest) HTTPRequest Uses

func (request ListLimitValuesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListLimitValuesRequest) RetryPolicy Uses

func (request ListLimitValuesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListLimitValuesRequest) String Uses

func (request ListLimitValuesRequest) String() string

type ListLimitValuesResponse Uses

type ListLimitValuesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []LimitValueSummary instances
    Items []LimitValueSummary `presentIn:"body"`

    // For list pagination. When this header appears in the response, additional pages
    // of results remain. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListLimitValuesResponse wrapper for the ListLimitValues operation

func (ListLimitValuesResponse) HTTPResponse Uses

func (response ListLimitValuesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListLimitValuesResponse) String Uses

func (response ListLimitValuesResponse) String() string

type ListLimitValuesScopeTypeEnum Uses

type ListLimitValuesScopeTypeEnum string

ListLimitValuesScopeTypeEnum Enum with underlying type: string

const (
    ListLimitValuesScopeTypeGlobal ListLimitValuesScopeTypeEnum = "GLOBAL"
    ListLimitValuesScopeTypeRegion ListLimitValuesScopeTypeEnum = "REGION"
    ListLimitValuesScopeTypeAd     ListLimitValuesScopeTypeEnum = "AD"
)

Set of constants representing the allowable values for ListLimitValuesScopeTypeEnum

func GetListLimitValuesScopeTypeEnumValues Uses

func GetListLimitValuesScopeTypeEnumValues() []ListLimitValuesScopeTypeEnum

GetListLimitValuesScopeTypeEnumValues Enumerates the set of values for ListLimitValuesScopeTypeEnum

type ListLimitValuesSortByEnum Uses

type ListLimitValuesSortByEnum string

ListLimitValuesSortByEnum Enum with underlying type: string

const (
    ListLimitValuesSortByName ListLimitValuesSortByEnum = "name"
)

Set of constants representing the allowable values for ListLimitValuesSortByEnum

func GetListLimitValuesSortByEnumValues Uses

func GetListLimitValuesSortByEnumValues() []ListLimitValuesSortByEnum

GetListLimitValuesSortByEnumValues Enumerates the set of values for ListLimitValuesSortByEnum

type ListLimitValuesSortOrderEnum Uses

type ListLimitValuesSortOrderEnum string

ListLimitValuesSortOrderEnum Enum with underlying type: string

const (
    ListLimitValuesSortOrderAsc  ListLimitValuesSortOrderEnum = "ASC"
    ListLimitValuesSortOrderDesc ListLimitValuesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListLimitValuesSortOrderEnum

func GetListLimitValuesSortOrderEnumValues Uses

func GetListLimitValuesSortOrderEnumValues() []ListLimitValuesSortOrderEnum

GetListLimitValuesSortOrderEnumValues Enumerates the set of values for ListLimitValuesSortOrderEnum

type ListQuotasLifecycleStateEnum Uses

type ListQuotasLifecycleStateEnum string

ListQuotasLifecycleStateEnum Enum with underlying type: string

const (
    ListQuotasLifecycleStateActive ListQuotasLifecycleStateEnum = "ACTIVE"
)

Set of constants representing the allowable values for ListQuotasLifecycleStateEnum

func GetListQuotasLifecycleStateEnumValues Uses

func GetListQuotasLifecycleStateEnumValues() []ListQuotasLifecycleStateEnum

GetListQuotasLifecycleStateEnumValues Enumerates the set of values for ListQuotasLifecycleStateEnum

type ListQuotasRequest Uses

type ListQuotasRequest struct {

    // The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The value of the `opc-next-page` response header from the previous "List" call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return in a paginated "List" call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // name
    Name *string `mandatory:"false" contributesTo:"query" name:"name"`

    // Filters returned quotas based on whether the given state.
    LifecycleState ListQuotasLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc'. By default it will be ascending.
    SortOrder ListQuotasSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. Only one sort order may be provided. Time created is default ordered as descending. Display name is default ordered as ascending.
    SortBy ListQuotasSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListQuotasRequest wrapper for the ListQuotas operation

func (ListQuotasRequest) HTTPRequest Uses

func (request ListQuotasRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListQuotasRequest) RetryPolicy Uses

func (request ListQuotasRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListQuotasRequest) String Uses

func (request ListQuotasRequest) String() string

type ListQuotasResponse Uses

type ListQuotasResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []QuotaSummary instances
    Items []QuotaSummary `presentIn:"body"`

    // For list pagination. When this header appears in the response, additional pages
    // of results remain. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListQuotasResponse wrapper for the ListQuotas operation

func (ListQuotasResponse) HTTPResponse Uses

func (response ListQuotasResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListQuotasResponse) String Uses

func (response ListQuotasResponse) String() string

type ListQuotasSortByEnum Uses

type ListQuotasSortByEnum string

ListQuotasSortByEnum Enum with underlying type: string

const (
    ListQuotasSortByName        ListQuotasSortByEnum = "NAME"
    ListQuotasSortByTimecreated ListQuotasSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListQuotasSortByEnum

func GetListQuotasSortByEnumValues Uses

func GetListQuotasSortByEnumValues() []ListQuotasSortByEnum

GetListQuotasSortByEnumValues Enumerates the set of values for ListQuotasSortByEnum

type ListQuotasSortOrderEnum Uses

type ListQuotasSortOrderEnum string

ListQuotasSortOrderEnum Enum with underlying type: string

const (
    ListQuotasSortOrderAsc  ListQuotasSortOrderEnum = "ASC"
    ListQuotasSortOrderDesc ListQuotasSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListQuotasSortOrderEnum

func GetListQuotasSortOrderEnumValues Uses

func GetListQuotasSortOrderEnumValues() []ListQuotasSortOrderEnum

GetListQuotasSortOrderEnumValues Enumerates the set of values for ListQuotasSortOrderEnum

type ListServicesRequest Uses

type ListServicesRequest struct {

    // The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The field to sort by.
    SortBy ListServicesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc'. By default it will be ascending.
    SortOrder ListServicesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The maximum number of items to return in a paginated "List" call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` response header from the previous "List" call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListServicesRequest wrapper for the ListServices operation

func (ListServicesRequest) HTTPRequest Uses

func (request ListServicesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListServicesRequest) RetryPolicy Uses

func (request ListServicesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListServicesRequest) String Uses

func (request ListServicesRequest) String() string

type ListServicesResponse Uses

type ListServicesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []ServiceSummary instances
    Items []ServiceSummary `presentIn:"body"`

    // For list pagination. When this header appears in the response, additional pages
    // of results remain. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListServicesResponse wrapper for the ListServices operation

func (ListServicesResponse) HTTPResponse Uses

func (response ListServicesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListServicesResponse) String Uses

func (response ListServicesResponse) String() string

type ListServicesSortByEnum Uses

type ListServicesSortByEnum string

ListServicesSortByEnum Enum with underlying type: string

const (
    ListServicesSortByName        ListServicesSortByEnum = "name"
    ListServicesSortByDescription ListServicesSortByEnum = "description"
)

Set of constants representing the allowable values for ListServicesSortByEnum

func GetListServicesSortByEnumValues Uses

func GetListServicesSortByEnumValues() []ListServicesSortByEnum

GetListServicesSortByEnumValues Enumerates the set of values for ListServicesSortByEnum

type ListServicesSortOrderEnum Uses

type ListServicesSortOrderEnum string

ListServicesSortOrderEnum Enum with underlying type: string

const (
    ListServicesSortOrderAsc  ListServicesSortOrderEnum = "ASC"
    ListServicesSortOrderDesc ListServicesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListServicesSortOrderEnum

func GetListServicesSortOrderEnumValues Uses

func GetListServicesSortOrderEnumValues() []ListServicesSortOrderEnum

GetListServicesSortOrderEnumValues Enumerates the set of values for ListServicesSortOrderEnum

type Quota Uses

type Quota struct {

    // The OCID of the quota.
    Id  *string `mandatory:"true" json:"id"`

    // The OCID of the compartment containing the resource this quota applies to.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The name you assign to the quota during creation. The name must be unique across all quotas
    // in the tenancy and cannot be changed.
    Name *string `mandatory:"true" json:"name"`

    // An array of one or more quota statements written in the declarative quota statement language.
    Statements []string `mandatory:"true" json:"statements"`

    // The description you assign to the quota.
    Description *string `mandatory:"true" json:"description"`

    // Date and time the quota was created, in the format defined by RFC3339.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The quota's current state. After creating a quota, make sure its `lifecycleState` is set to
    // ACTIVE before using it.
    LifecycleState QuotaLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Quota Quotas are applied on top of the service limits and inherited through the nested compartment hierarchy. They allow compartment admins to limit resource consumption and set boundaries around acceptable resource use. The word "quota" is used by people in different ways:

* An individual statement written in the declarative language
* A collection of statements in a single, named "quota" object (which has an Oracle Cloud ID (OCID) assigned to it)
* The overall body of quotas your organization uses to control access to resources

func (Quota) String Uses

func (m Quota) String() string

type QuotaLifecycleStateEnum Uses

type QuotaLifecycleStateEnum string

QuotaLifecycleStateEnum Enum with underlying type: string

const (
    QuotaLifecycleStateActive QuotaLifecycleStateEnum = "ACTIVE"
)

Set of constants representing the allowable values for QuotaLifecycleStateEnum

func GetQuotaLifecycleStateEnumValues Uses

func GetQuotaLifecycleStateEnumValues() []QuotaLifecycleStateEnum

GetQuotaLifecycleStateEnumValues Enumerates the set of values for QuotaLifecycleStateEnum

type QuotaSummary Uses

type QuotaSummary struct {

    // The OCID of the quota.
    Id  *string `mandatory:"true" json:"id"`

    // The OCID of the compartment containing the resource this quota applies to.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The name you assign to the quota during creation. The name must be unique across all quotas
    // in the tenancy and cannot be changed.
    Name *string `mandatory:"true" json:"name"`

    // The description you assign to the quota.
    Description *string `mandatory:"true" json:"description"`

    // Date and time the quota was created, in the format defined by RFC3339.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The quota's current state. After creating a quota, make sure its `lifecycleState` is set to
    // ACTIVE before using it.
    LifecycleState QuotaSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

QuotaSummary Entails a subset of all the properties of the corresponding Quota and is recommended to be used in cases requiring security of quota details and slightly better API performance.

func (QuotaSummary) String Uses

func (m QuotaSummary) String() string

type QuotaSummaryLifecycleStateEnum Uses

type QuotaSummaryLifecycleStateEnum string

QuotaSummaryLifecycleStateEnum Enum with underlying type: string

const (
    QuotaSummaryLifecycleStateActive QuotaSummaryLifecycleStateEnum = "ACTIVE"
)

Set of constants representing the allowable values for QuotaSummaryLifecycleStateEnum

func GetQuotaSummaryLifecycleStateEnumValues Uses

func GetQuotaSummaryLifecycleStateEnumValues() []QuotaSummaryLifecycleStateEnum

GetQuotaSummaryLifecycleStateEnumValues Enumerates the set of values for QuotaSummaryLifecycleStateEnum

type QuotasClient Uses

type QuotasClient struct {
    common.BaseClient
    // contains filtered or unexported fields
}

QuotasClient a client for Quotas

func NewQuotasClientWithConfigurationProvider Uses

func NewQuotasClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client QuotasClient, err error)

NewQuotasClientWithConfigurationProvider Creates a new default Quotas client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewQuotasClientWithOboToken Uses

func NewQuotasClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client QuotasClient, err error)

NewQuotasClientWithOboToken Creates a new default Quotas client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (*QuotasClient) ConfigurationProvider Uses

func (client *QuotasClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (QuotasClient) CreateQuota Uses

func (client QuotasClient) CreateQuota(ctx context.Context, request CreateQuotaRequest) (response CreateQuotaResponse, err error)

CreateQuota Creates a new quota with the details supplied.

func (QuotasClient) DeleteQuota Uses

func (client QuotasClient) DeleteQuota(ctx context.Context, request DeleteQuotaRequest) (response DeleteQuotaResponse, err error)

DeleteQuota Deletes the quota corresponding to the given OCID.

func (QuotasClient) GetQuota Uses

func (client QuotasClient) GetQuota(ctx context.Context, request GetQuotaRequest) (response GetQuotaResponse, err error)

GetQuota Gets the quota for the OCID specified.

func (QuotasClient) ListQuotas Uses

func (client QuotasClient) ListQuotas(ctx context.Context, request ListQuotasRequest) (response ListQuotasResponse, err error)

ListQuotas Lists all quotas on resources from the given compartment

func (*QuotasClient) SetRegion Uses

func (client *QuotasClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (QuotasClient) UpdateQuota Uses

func (client QuotasClient) UpdateQuota(ctx context.Context, request UpdateQuotaRequest) (response UpdateQuotaResponse, err error)

UpdateQuota Updates the quota corresponding to given OCID with the details supplied.

type ResourceAvailability Uses

type ResourceAvailability struct {

    // The current usage in the given compartment.
    Used *int64 `mandatory:"false" json:"used"`

    // The count of available resources.
    Available *int64 `mandatory:"false" json:"available"`
}

ResourceAvailability The availability of a given resource limit, based on the usage, tenant service limits and quotas set for the tenancy. Note: We cannot guarantee this data for all the limits. In those cases, these fields will be empty.

func (ResourceAvailability) String Uses

func (m ResourceAvailability) String() string

type ServiceSummary Uses

type ServiceSummary struct {

    // The service name. Use this when calling the other APIs.
    Name *string `mandatory:"false" json:"name"`

    // The friendly service name.
    Description *string `mandatory:"false" json:"description"`
}

ServiceSummary A specific OCI service supported by resource limits.

func (ServiceSummary) String Uses

func (m ServiceSummary) String() string

type UpdateQuotaDetails Uses

type UpdateQuotaDetails struct {

    // The description you assign to the quota.
    Description *string `mandatory:"false" json:"description"`

    // An array of quota statements written in the declarative quota statement language.
    Statements []string `mandatory:"false" json:"statements"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateQuotaDetails Request object for update quota operation.

func (UpdateQuotaDetails) String Uses

func (m UpdateQuotaDetails) String() string

type UpdateQuotaRequest Uses

type UpdateQuotaRequest struct {

    // The OCID of the quota.
    QuotaId *string `mandatory:"true" contributesTo:"path" name:"quotaId"`

    // Request object for updating a quota.
    UpdateQuotaDetails `contributesTo:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
    // parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
    // will be updated or deleted only if the etag you provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

UpdateQuotaRequest wrapper for the UpdateQuota operation

func (UpdateQuotaRequest) HTTPRequest Uses

func (request UpdateQuotaRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateQuotaRequest) RetryPolicy Uses

func (request UpdateQuotaRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateQuotaRequest) String Uses

func (request UpdateQuotaRequest) String() string

type UpdateQuotaResponse Uses

type UpdateQuotaResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Quota instance
    Quota `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

UpdateQuotaResponse wrapper for the UpdateQuota operation

func (UpdateQuotaResponse) HTTPResponse Uses

func (response UpdateQuotaResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateQuotaResponse) String Uses

func (response UpdateQuotaResponse) String() string

Package limits imports 4 packages (graph) and is imported by 2 packages. Updated 2020-04-05. Refresh now. Tools for package owners.