CreateQuotaDetails Request object for create quota operation.
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"` }
func (m CreateQuotaDetails) String() string
CreateQuotaRequest wrapper for the CreateQuota operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/CreateQuota.go.html to see an example of how to use CreateQuotaRequest.
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 }
func (request CreateQuotaRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateQuotaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateQuotaRequest) String() string
CreateQuotaResponse wrapper for the CreateQuota operation
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"` }
func (response CreateQuotaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateQuotaResponse) String() string
DeleteQuotaRequest wrapper for the DeleteQuota operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/DeleteQuota.go.html to see an example of how to use DeleteQuotaRequest.
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 }
func (request DeleteQuotaRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteQuotaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteQuotaRequest) String() string
DeleteQuotaResponse wrapper for the DeleteQuota operation
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"` }
func (response DeleteQuotaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteQuotaResponse) String() string
GetQuotaRequest wrapper for the GetQuota operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/GetQuota.go.html to see an example of how to use GetQuotaRequest.
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 }
func (request GetQuotaRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetQuotaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetQuotaRequest) String() string
GetQuotaResponse wrapper for the GetQuota operation
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"` }
func (response GetQuotaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetQuotaResponse) String() string
GetResourceAvailabilityRequest wrapper for the GetResourceAvailability operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/GetResourceAvailability.go.html to see an example of how to use GetResourceAvailabilityRequest.
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 }
func (request GetResourceAvailabilityRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetResourceAvailabilityRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetResourceAvailabilityRequest) String() string
GetResourceAvailabilityResponse wrapper for the GetResourceAvailability operation
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"` }
func (response GetResourceAvailabilityResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetResourceAvailabilityResponse) String() string
LimitDefinitionSummary The metadata specific to a resource limit definition.
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"` }
func (m LimitDefinitionSummary) String() string
LimitDefinitionSummaryScopeTypeEnum Enum with underlying type: string
type LimitDefinitionSummaryScopeTypeEnum string
Set of constants representing the allowable values for LimitDefinitionSummaryScopeTypeEnum
const ( LimitDefinitionSummaryScopeTypeGlobal LimitDefinitionSummaryScopeTypeEnum = "GLOBAL" LimitDefinitionSummaryScopeTypeRegion LimitDefinitionSummaryScopeTypeEnum = "REGION" LimitDefinitionSummaryScopeTypeAd LimitDefinitionSummaryScopeTypeEnum = "AD" )
func GetLimitDefinitionSummaryScopeTypeEnumValues() []LimitDefinitionSummaryScopeTypeEnum
GetLimitDefinitionSummaryScopeTypeEnumValues Enumerates the set of values for LimitDefinitionSummaryScopeTypeEnum
LimitValueSummary The value of a specific resource limit.
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"` }
func (m LimitValueSummary) String() string
LimitValueSummaryScopeTypeEnum Enum with underlying type: string
type LimitValueSummaryScopeTypeEnum string
Set of constants representing the allowable values for LimitValueSummaryScopeTypeEnum
const ( LimitValueSummaryScopeTypeGlobal LimitValueSummaryScopeTypeEnum = "GLOBAL" LimitValueSummaryScopeTypeRegion LimitValueSummaryScopeTypeEnum = "REGION" LimitValueSummaryScopeTypeAd LimitValueSummaryScopeTypeEnum = "AD" )
func GetLimitValueSummaryScopeTypeEnumValues() []LimitValueSummaryScopeTypeEnum
GetLimitValueSummaryScopeTypeEnumValues Enumerates the set of values for LimitValueSummaryScopeTypeEnum
LimitsClient a client for Limits
type LimitsClient struct { common.BaseClient // contains filtered or unexported fields }
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(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 (client *LimitsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/GetResourceAvailability.go.html to see an example of how to use GetResourceAvailability API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/ListLimitDefinitions.go.html to see an example of how to use ListLimitDefinitions API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/ListLimitValues.go.html to see an example of how to use ListLimitValues API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/ListServices.go.html to see an example of how to use ListServices API.
func (client *LimitsClient) SetRegion(region string)
SetRegion overrides the region of this client.
ListLimitDefinitionsRequest wrapper for the ListLimitDefinitions operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/ListLimitDefinitions.go.html to see an example of how to use ListLimitDefinitionsRequest.
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 }
func (request ListLimitDefinitionsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListLimitDefinitionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListLimitDefinitionsRequest) String() string
ListLimitDefinitionsResponse wrapper for the ListLimitDefinitions operation
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"` }
func (response ListLimitDefinitionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListLimitDefinitionsResponse) String() string
ListLimitDefinitionsSortByEnum Enum with underlying type: string
type ListLimitDefinitionsSortByEnum string
Set of constants representing the allowable values for ListLimitDefinitionsSortByEnum
const ( ListLimitDefinitionsSortByName ListLimitDefinitionsSortByEnum = "name" ListLimitDefinitionsSortByDescription ListLimitDefinitionsSortByEnum = "description" )
func GetListLimitDefinitionsSortByEnumValues() []ListLimitDefinitionsSortByEnum
GetListLimitDefinitionsSortByEnumValues Enumerates the set of values for ListLimitDefinitionsSortByEnum
ListLimitDefinitionsSortOrderEnum Enum with underlying type: string
type ListLimitDefinitionsSortOrderEnum string
Set of constants representing the allowable values for ListLimitDefinitionsSortOrderEnum
const ( ListLimitDefinitionsSortOrderAsc ListLimitDefinitionsSortOrderEnum = "ASC" ListLimitDefinitionsSortOrderDesc ListLimitDefinitionsSortOrderEnum = "DESC" )
func GetListLimitDefinitionsSortOrderEnumValues() []ListLimitDefinitionsSortOrderEnum
GetListLimitDefinitionsSortOrderEnumValues Enumerates the set of values for ListLimitDefinitionsSortOrderEnum
ListLimitValuesRequest wrapper for the ListLimitValues operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/ListLimitValues.go.html to see an example of how to use ListLimitValuesRequest.
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 }
func (request ListLimitValuesRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListLimitValuesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListLimitValuesRequest) String() string
ListLimitValuesResponse wrapper for the ListLimitValues operation
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"` }
func (response ListLimitValuesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListLimitValuesResponse) String() string
ListLimitValuesScopeTypeEnum Enum with underlying type: string
type ListLimitValuesScopeTypeEnum string
Set of constants representing the allowable values for ListLimitValuesScopeTypeEnum
const ( ListLimitValuesScopeTypeGlobal ListLimitValuesScopeTypeEnum = "GLOBAL" ListLimitValuesScopeTypeRegion ListLimitValuesScopeTypeEnum = "REGION" ListLimitValuesScopeTypeAd ListLimitValuesScopeTypeEnum = "AD" )
func GetListLimitValuesScopeTypeEnumValues() []ListLimitValuesScopeTypeEnum
GetListLimitValuesScopeTypeEnumValues Enumerates the set of values for ListLimitValuesScopeTypeEnum
ListLimitValuesSortByEnum Enum with underlying type: string
type ListLimitValuesSortByEnum string
Set of constants representing the allowable values for ListLimitValuesSortByEnum
const ( ListLimitValuesSortByName ListLimitValuesSortByEnum = "name" )
func GetListLimitValuesSortByEnumValues() []ListLimitValuesSortByEnum
GetListLimitValuesSortByEnumValues Enumerates the set of values for ListLimitValuesSortByEnum
ListLimitValuesSortOrderEnum Enum with underlying type: string
type ListLimitValuesSortOrderEnum string
Set of constants representing the allowable values for ListLimitValuesSortOrderEnum
const ( ListLimitValuesSortOrderAsc ListLimitValuesSortOrderEnum = "ASC" ListLimitValuesSortOrderDesc ListLimitValuesSortOrderEnum = "DESC" )
func GetListLimitValuesSortOrderEnumValues() []ListLimitValuesSortOrderEnum
GetListLimitValuesSortOrderEnumValues Enumerates the set of values for ListLimitValuesSortOrderEnum
ListQuotasLifecycleStateEnum Enum with underlying type: string
type ListQuotasLifecycleStateEnum string
Set of constants representing the allowable values for ListQuotasLifecycleStateEnum
const ( ListQuotasLifecycleStateActive ListQuotasLifecycleStateEnum = "ACTIVE" )
func GetListQuotasLifecycleStateEnumValues() []ListQuotasLifecycleStateEnum
GetListQuotasLifecycleStateEnumValues Enumerates the set of values for ListQuotasLifecycleStateEnum
ListQuotasRequest wrapper for the ListQuotas operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/ListQuotas.go.html to see an example of how to use ListQuotasRequest.
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 }
func (request ListQuotasRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListQuotasRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListQuotasRequest) String() string
ListQuotasResponse wrapper for the ListQuotas operation
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"` }
func (response ListQuotasResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListQuotasResponse) String() string
ListQuotasSortByEnum Enum with underlying type: string
type ListQuotasSortByEnum string
Set of constants representing the allowable values for ListQuotasSortByEnum
const ( ListQuotasSortByName ListQuotasSortByEnum = "NAME" ListQuotasSortByTimecreated ListQuotasSortByEnum = "TIMECREATED" )
func GetListQuotasSortByEnumValues() []ListQuotasSortByEnum
GetListQuotasSortByEnumValues Enumerates the set of values for ListQuotasSortByEnum
ListQuotasSortOrderEnum Enum with underlying type: string
type ListQuotasSortOrderEnum string
Set of constants representing the allowable values for ListQuotasSortOrderEnum
const ( ListQuotasSortOrderAsc ListQuotasSortOrderEnum = "ASC" ListQuotasSortOrderDesc ListQuotasSortOrderEnum = "DESC" )
func GetListQuotasSortOrderEnumValues() []ListQuotasSortOrderEnum
GetListQuotasSortOrderEnumValues Enumerates the set of values for ListQuotasSortOrderEnum
ListServicesRequest wrapper for the ListServices operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/ListServices.go.html to see an example of how to use ListServicesRequest.
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 }
func (request ListServicesRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListServicesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListServicesRequest) String() string
ListServicesResponse wrapper for the ListServices operation
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"` }
func (response ListServicesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListServicesResponse) String() string
ListServicesSortByEnum Enum with underlying type: string
type ListServicesSortByEnum string
Set of constants representing the allowable values for ListServicesSortByEnum
const ( ListServicesSortByName ListServicesSortByEnum = "name" ListServicesSortByDescription ListServicesSortByEnum = "description" )
func GetListServicesSortByEnumValues() []ListServicesSortByEnum
GetListServicesSortByEnumValues Enumerates the set of values for ListServicesSortByEnum
ListServicesSortOrderEnum Enum with underlying type: string
type ListServicesSortOrderEnum string
Set of constants representing the allowable values for ListServicesSortOrderEnum
const ( ListServicesSortOrderAsc ListServicesSortOrderEnum = "ASC" ListServicesSortOrderDesc ListServicesSortOrderEnum = "DESC" )
func GetListServicesSortOrderEnumValues() []ListServicesSortOrderEnum
GetListServicesSortOrderEnumValues Enumerates the set of values for ListServicesSortOrderEnum
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
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"` }
func (m Quota) String() string
QuotaLifecycleStateEnum Enum with underlying type: string
type QuotaLifecycleStateEnum string
Set of constants representing the allowable values for QuotaLifecycleStateEnum
const ( QuotaLifecycleStateActive QuotaLifecycleStateEnum = "ACTIVE" )
func GetQuotaLifecycleStateEnumValues() []QuotaLifecycleStateEnum
GetQuotaLifecycleStateEnumValues Enumerates the set of values for QuotaLifecycleStateEnum
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.
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"` }
func (m QuotaSummary) String() string
QuotaSummaryLifecycleStateEnum Enum with underlying type: string
type QuotaSummaryLifecycleStateEnum string
Set of constants representing the allowable values for QuotaSummaryLifecycleStateEnum
const ( QuotaSummaryLifecycleStateActive QuotaSummaryLifecycleStateEnum = "ACTIVE" )
func GetQuotaSummaryLifecycleStateEnumValues() []QuotaSummaryLifecycleStateEnum
GetQuotaSummaryLifecycleStateEnumValues Enumerates the set of values for QuotaSummaryLifecycleStateEnum
QuotasClient a client for Quotas
type QuotasClient struct { common.BaseClient // contains filtered or unexported fields }
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(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 (client *QuotasClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client QuotasClient) CreateQuota(ctx context.Context, request CreateQuotaRequest) (response CreateQuotaResponse, err error)
CreateQuota Creates a new quota with the details supplied.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/CreateQuota.go.html to see an example of how to use CreateQuota API.
func (client QuotasClient) DeleteQuota(ctx context.Context, request DeleteQuotaRequest) (response DeleteQuotaResponse, err error)
DeleteQuota Deletes the quota corresponding to the given OCID.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/DeleteQuota.go.html to see an example of how to use DeleteQuota API.
func (client QuotasClient) GetQuota(ctx context.Context, request GetQuotaRequest) (response GetQuotaResponse, err error)
GetQuota Gets the quota for the OCID specified.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/GetQuota.go.html to see an example of how to use GetQuota API.
func (client QuotasClient) ListQuotas(ctx context.Context, request ListQuotasRequest) (response ListQuotasResponse, err error)
ListQuotas Lists all quotas on resources from the given compartment
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/ListQuotas.go.html to see an example of how to use ListQuotas API.
func (client *QuotasClient) SetRegion(region string)
SetRegion overrides the region of this client.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/UpdateQuota.go.html to see an example of how to use UpdateQuota API.
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.
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"` }
func (m ResourceAvailability) String() string
ServiceSummary A specific OCI service supported by resource limits.
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"` }
func (m ServiceSummary) String() string
UpdateQuotaDetails Request object for update quota operation.
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"` }
func (m UpdateQuotaDetails) String() string
UpdateQuotaRequest wrapper for the UpdateQuota operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/limits/UpdateQuota.go.html to see an example of how to use UpdateQuotaRequest.
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 }
func (request UpdateQuotaRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateQuotaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateQuotaRequest) String() string
UpdateQuotaResponse wrapper for the UpdateQuota operation
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"` }
func (response UpdateQuotaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateQuotaResponse) String() string