func GetAddLockDetailsTypeEnumStringValues() []string
GetAddLockDetailsTypeEnumStringValues Enumerates the set of values in String for AddLockDetailsTypeEnum
func GetLimitDefinitionSummaryScopeTypeEnumStringValues() []string
GetLimitDefinitionSummaryScopeTypeEnumStringValues Enumerates the set of values in String for LimitDefinitionSummaryScopeTypeEnum
func GetLimitValueSummaryScopeTypeEnumStringValues() []string
GetLimitValueSummaryScopeTypeEnumStringValues Enumerates the set of values in String for LimitValueSummaryScopeTypeEnum
func GetListLimitDefinitionsSortByEnumStringValues() []string
GetListLimitDefinitionsSortByEnumStringValues Enumerates the set of values in String for ListLimitDefinitionsSortByEnum
func GetListLimitDefinitionsSortOrderEnumStringValues() []string
GetListLimitDefinitionsSortOrderEnumStringValues Enumerates the set of values in String for ListLimitDefinitionsSortOrderEnum
func GetListLimitValuesScopeTypeEnumStringValues() []string
GetListLimitValuesScopeTypeEnumStringValues Enumerates the set of values in String for ListLimitValuesScopeTypeEnum
func GetListLimitValuesSortByEnumStringValues() []string
GetListLimitValuesSortByEnumStringValues Enumerates the set of values in String for ListLimitValuesSortByEnum
func GetListLimitValuesSortOrderEnumStringValues() []string
GetListLimitValuesSortOrderEnumStringValues Enumerates the set of values in String for ListLimitValuesSortOrderEnum
func GetListQuotasLifecycleStateEnumStringValues() []string
GetListQuotasLifecycleStateEnumStringValues Enumerates the set of values in String for ListQuotasLifecycleStateEnum
func GetListQuotasSortByEnumStringValues() []string
GetListQuotasSortByEnumStringValues Enumerates the set of values in String for ListQuotasSortByEnum
func GetListQuotasSortOrderEnumStringValues() []string
GetListQuotasSortOrderEnumStringValues Enumerates the set of values in String for ListQuotasSortOrderEnum
func GetListServicesSortByEnumStringValues() []string
GetListServicesSortByEnumStringValues Enumerates the set of values in String for ListServicesSortByEnum
func GetListServicesSortOrderEnumStringValues() []string
GetListServicesSortOrderEnumStringValues Enumerates the set of values in String for ListServicesSortOrderEnum
func GetQuotaLifecycleStateEnumStringValues() []string
GetQuotaLifecycleStateEnumStringValues Enumerates the set of values in String for QuotaLifecycleStateEnum
func GetQuotaSummaryLifecycleStateEnumStringValues() []string
GetQuotaSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for QuotaSummaryLifecycleStateEnum
func GetRemoveLockDetailsTypeEnumStringValues() []string
GetRemoveLockDetailsTypeEnumStringValues Enumerates the set of values in String for RemoveLockDetailsTypeEnum
func GetResourceLockTypeEnumStringValues() []string
GetResourceLockTypeEnumStringValues Enumerates the set of values in String for ResourceLockTypeEnum
AddLockDetails Request payload to add lock to the resource. The FULL lock type allows no modifications (delete, create, update).
The DELETE lock type allows all modifications, but delete is not allowed.
type AddLockDetails struct {
// Lock type.
Type AddLockDetailsTypeEnum `mandatory:"true" json:"type"`
// The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.
RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`
// A message added by the lock creator. The message typically gives an
// indication of why the resource is locked.
Message *string `mandatory:"false" json:"message"`
}
func (m AddLockDetails) String() string
func (m AddLockDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddLockDetailsTypeEnum Enum with underlying type: string
type AddLockDetailsTypeEnum string
Set of constants representing the allowable values for AddLockDetailsTypeEnum
const (
AddLockDetailsTypeFull AddLockDetailsTypeEnum = "FULL"
AddLockDetailsTypeDelete AddLockDetailsTypeEnum = "DELETE"
)
func GetAddLockDetailsTypeEnumValues() []AddLockDetailsTypeEnum
GetAddLockDetailsTypeEnumValues Enumerates the set of values for AddLockDetailsTypeEnum
func GetMappingAddLockDetailsTypeEnum(val string) (AddLockDetailsTypeEnum, bool)
GetMappingAddLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddQuotaLockRequest wrapper for the AddQuotaLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/AddQuotaLock.go.html to see an example of how to use AddQuotaLockRequest.
type AddQuotaLockRequest struct {
// The OCID of the quota.
QuotaId *string `mandatory:"true" contributesTo:"path" name:"quotaId"`
AddLockDetails `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
// is 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 AddQuotaLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddQuotaLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddQuotaLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddQuotaLockRequest) String() string
func (request AddQuotaLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddQuotaLockResponse wrapper for the AddQuotaLock operation
type AddQuotaLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Quota instance
Quota `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 AddQuotaLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddQuotaLockResponse) String() string
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"`
// Locks associated with this resource.
Locks []AddLockDetails `mandatory:"false" json:"locks"`
// 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateQuotaDetails) String() string
func (m CreateQuotaDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateQuotaRequest wrapper for the CreateQuota operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
// can 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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request CreateQuotaRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
// is 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"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request DeleteQuotaRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request GetQuotaRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 returns 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"`
// The OCID of the subscription assigned to tenant
SubscriptionId *string `mandatory:"false" contributesTo:"query" name:"subscriptionId"`
// 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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetResourceAvailabilityRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request GetResourceAvailabilityRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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, whether Global (across all regions), regional, or availability domain-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 whether or not the GetResourceAvailability API is supported for this limit.
// If not, the API returns an empty JSON response.
IsResourceAvailabilitySupported *bool `mandatory:"false" json:"isResourceAvailabilitySupported"`
// Indicates if the limit has been deprecated.
IsDeprecated *bool `mandatory:"false" json:"isDeprecated"`
// Indicates if the customer can request a limit increase for this resource.
IsEligibleForLimitIncrease *bool `mandatory:"false" json:"isEligibleForLimitIncrease"`
// The limit for this resource has a dynamic value that is based on consumption across all OCI services.
IsDynamic *bool `mandatory:"false" json:"isDynamic"`
// An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'.
SupportedSubscriptions []string `mandatory:"false" json:"supportedSubscriptions"`
// Supported quota family names for creation of quota policy.
SupportedQuotaFamilies []string `mandatory:"false" json:"supportedQuotaFamilies"`
}
func (m LimitDefinitionSummary) String() string
func (m LimitDefinitionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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
func GetMappingLimitDefinitionSummaryScopeTypeEnum(val string) (LimitDefinitionSummaryScopeTypeEnum, bool)
GetMappingLimitDefinitionSummaryScopeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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
func (m LimitValueSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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
func GetMappingLimitValueSummaryScopeTypeEnum(val string) (LimitValueSummaryScopeTypeEnum, bool)
GetMappingLimitValueSummaryScopeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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:
If Subscription Id is provided, then usage for resource created in that subscription will be returned Note that not all resource limits support this API. If the value is not available, the API returns a 404 response.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/GetResourceAvailability.go.html to see an example of how to use GetResourceAvailability API. A default retry strategy applies to this operation GetResourceAvailability()
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 subscription Id is provided, then only resource limits supported by subscription will be returned If the 'areQuotasSupported' property is true, you can create quota policies on top of this limit at the compartment level.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/ListLimitDefinitions.go.html to see an example of how to use ListLimitDefinitions API. A default retry strategy applies to this operation ListLimitDefinitions()
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. If subscription Id is provided, limit value for subscription will be returned.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/ListLimitValues.go.html to see an example of how to use ListLimitValues API. A default retry strategy applies to this operation ListLimitValues()
func (client LimitsClient) ListServices(ctx context.Context, request ListServicesRequest) (response ListServicesResponse, err error)
ListServices Returns the list of supported services. If subscription ID is provided then only services supported by subscription will be returned. This includes the programmatic service name, along with the friendly service name.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/ListServices.go.html to see an example of how to use ListServices API. A default retry strategy applies to this operation ListServices()
func (client *LimitsClient) SetRegion(region string)
SetRegion overrides the region of this client.
ListLimitDefinitionsRequest wrapper for the ListLimitDefinitions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 OCID of the subscription assigned to tenant
SubscriptionId *string `mandatory:"false" contributesTo:"query" name:"subscriptionId"`
// 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 is 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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListLimitDefinitionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request ListLimitDefinitionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.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
func GetMappingListLimitDefinitionsSortByEnum(val string) (ListLimitDefinitionsSortByEnum, bool)
GetMappingListLimitDefinitionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListLimitDefinitionsSortOrderEnum(val string) (ListLimitDefinitionsSortOrderEnum, bool)
GetMappingListLimitDefinitionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListLimitValuesRequest wrapper for the ListLimitValues operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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"`
// The OCID of the subscription assigned to tenant
SubscriptionId *string `mandatory:"false" contributesTo:"query" name:"subscriptionId"`
// 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 are 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. The sorting is 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 is 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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListLimitValuesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request ListLimitValuesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.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
func GetMappingListLimitValuesScopeTypeEnum(val string) (ListLimitValuesScopeTypeEnum, bool)
GetMappingListLimitValuesScopeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListLimitValuesSortByEnum(val string) (ListLimitValuesSortByEnum, bool)
GetMappingListLimitValuesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListLimitValuesSortOrderEnum(val string) (ListLimitValuesSortOrderEnum, bool)
GetMappingListLimitValuesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListQuotasLifecycleStateEnum(val string) (ListQuotasLifecycleStateEnum, bool)
GetMappingListQuotasLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListQuotasRequest wrapper for the ListQuotas operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 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 is ascending.
SortOrder ListQuotasSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can 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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListQuotasRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request ListQuotasRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.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
func GetMappingListQuotasSortByEnum(val string) (ListQuotasSortByEnum, bool)
GetMappingListQuotasSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListQuotasSortOrderEnum(val string) (ListQuotasSortOrderEnum, bool)
GetMappingListQuotasSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListServicesRequest wrapper for the ListServices operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 is 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"`
// The OCID of the subscription assigned to tenant
SubscriptionId *string `mandatory:"false" contributesTo:"query" name:"subscriptionId"`
// 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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListServicesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request ListServicesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.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
func GetMappingListServicesSortByEnum(val string) (ListServicesSortByEnum, bool)
GetMappingListServicesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListServicesSortOrderEnum(val string) (ListServicesSortOrderEnum, bool)
GetMappingListServicesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
Quota Quotas are applied on top of the service limits and inherited through the nested compartment hierarchy. Quotas allow compartment admins to limit resource consumption and set boundaries around acceptable resource use. The term "quota" can be interpreted as the following:
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 RFC 3339.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Quota) String() string
func (m Quota) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QuotaLifecycleStateEnum Enum with underlying type: string
type QuotaLifecycleStateEnum string
Set of constants representing the allowable values for QuotaLifecycleStateEnum
const (
QuotaLifecycleStateActive QuotaLifecycleStateEnum = "ACTIVE"
)
func GetMappingQuotaLifecycleStateEnum(val string) (QuotaLifecycleStateEnum, bool)
GetMappingQuotaLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQuotaLifecycleStateEnumValues() []QuotaLifecycleStateEnum
GetQuotaLifecycleStateEnumValues Enumerates the set of values for QuotaLifecycleStateEnum
QuotaSummary Consists of a subset of all the properties of the corresponding quota, and is recommended to be used in cases requiring security of quota details, and for 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 RFC 3339.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m QuotaSummary) String() string
func (m QuotaSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QuotaSummaryLifecycleStateEnum Enum with underlying type: string
type QuotaSummaryLifecycleStateEnum string
Set of constants representing the allowable values for QuotaSummaryLifecycleStateEnum
const (
QuotaSummaryLifecycleStateActive QuotaSummaryLifecycleStateEnum = "ACTIVE"
)
func GetMappingQuotaSummaryLifecycleStateEnum(val string) (QuotaSummaryLifecycleStateEnum, bool)
GetMappingQuotaSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
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) AddQuotaLock(ctx context.Context, request AddQuotaLockRequest) (response AddQuotaLockResponse, err error)
AddQuotaLock Adds a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/AddQuotaLock.go.html to see an example of how to use AddQuotaLock API.
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.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/CreateQuota.go.html to see an example of how to use CreateQuota API. A default retry strategy applies to this operation CreateQuota()
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.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/DeleteQuota.go.html to see an example of how to use DeleteQuota API. A default retry strategy applies to this operation DeleteQuota()
func (client QuotasClient) GetQuota(ctx context.Context, request GetQuotaRequest) (response GetQuotaResponse, err error)
GetQuota Gets the quota for the OCID specified.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/GetQuota.go.html to see an example of how to use GetQuota API. A default retry strategy applies to this operation GetQuota()
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.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/ListQuotas.go.html to see an example of how to use ListQuotas API. A default retry strategy applies to this operation ListQuotas()
func (client QuotasClient) RemoveQuotaLock(ctx context.Context, request RemoveQuotaLockRequest) (response RemoveQuotaLockResponse, err error)
RemoveQuotaLock Remove a lock from a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/RemoveQuotaLock.go.html to see an example of how to use RemoveQuotaLock 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.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/UpdateQuota.go.html to see an example of how to use UpdateQuota API. A default retry strategy applies to this operation UpdateQuota()
RemoveLockDetails Request payload to remove the resource lock.
type RemoveLockDetails struct {
// Lock type.
Type RemoveLockDetailsTypeEnum `mandatory:"true" json:"type"`
}
func (m RemoveLockDetails) String() string
func (m RemoveLockDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveLockDetailsTypeEnum Enum with underlying type: string
type RemoveLockDetailsTypeEnum string
Set of constants representing the allowable values for RemoveLockDetailsTypeEnum
const (
RemoveLockDetailsTypeFull RemoveLockDetailsTypeEnum = "FULL"
RemoveLockDetailsTypeDelete RemoveLockDetailsTypeEnum = "DELETE"
)
func GetMappingRemoveLockDetailsTypeEnum(val string) (RemoveLockDetailsTypeEnum, bool)
GetMappingRemoveLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRemoveLockDetailsTypeEnumValues() []RemoveLockDetailsTypeEnum
GetRemoveLockDetailsTypeEnumValues Enumerates the set of values for RemoveLockDetailsTypeEnum
RemoveQuotaLockRequest wrapper for the RemoveQuotaLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/limits/RemoveQuotaLock.go.html to see an example of how to use RemoveQuotaLockRequest.
type RemoveQuotaLockRequest struct {
// The OCID of the quota.
QuotaId *string `mandatory:"true" contributesTo:"path" name:"quotaId"`
RemoveLockDetails `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
// is 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 RemoveQuotaLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveQuotaLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveQuotaLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveQuotaLockRequest) String() string
func (request RemoveQuotaLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveQuotaLockResponse wrapper for the RemoveQuotaLock operation
type RemoveQuotaLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Quota instance
Quota `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 RemoveQuotaLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveQuotaLockResponse) String() string
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 such cases, these fields will be empty.
type ResourceAvailability struct {
// The current usage in the given compartment. To support resources with fractional counts,
// the field rounds up to the nearest integer.
Used *int64 `mandatory:"false" json:"used"`
// The count of available resources. To support resources with fractional counts,
// the field rounds down to the nearest integer.
Available *int64 `mandatory:"false" json:"available"`
// The current most accurate usage in the given compartment.
FractionalUsage *float32 `mandatory:"false" json:"fractionalUsage"`
// The most accurate count of available resources.
FractionalAvailability *float32 `mandatory:"false" json:"fractionalAvailability"`
// The effective quota value for the given compartment. This field is only present if there is a
// current quota policy affecting the current resource in the target region or availability domain.
EffectiveQuotaValue *float32 `mandatory:"false" json:"effectiveQuotaValue"`
}
func (m ResourceAvailability) String() string
func (m ResourceAvailability) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResourceLock Resource locks prevent certain APIs from being called for the resource. A full lock prevents both updating and deleting the resource. A lock delete prevents deleting the resource.
type ResourceLock struct {
// Lock type.
Type ResourceLockTypeEnum `mandatory:"true" json:"type"`
// The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.
RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`
// A message added by the lock creator. The message typically gives an
// indication of why the resource is locked.
Message *string `mandatory:"false" json:"message"`
// Indicates when the lock was created, in the format defined by RFC 3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m ResourceLock) String() string
func (m ResourceLock) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResourceLockTypeEnum Enum with underlying type: string
type ResourceLockTypeEnum string
Set of constants representing the allowable values for ResourceLockTypeEnum
const (
ResourceLockTypeFull ResourceLockTypeEnum = "FULL"
ResourceLockTypeDelete ResourceLockTypeEnum = "DELETE"
)
func GetMappingResourceLockTypeEnum(val string) (ResourceLockTypeEnum, bool)
GetMappingResourceLockTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResourceLockTypeEnumValues() []ResourceLockTypeEnum
GetResourceLockTypeEnumValues Enumerates the set of values for ResourceLockTypeEnum
ServiceSummary A specific OCI service supported by resource limits.
type ServiceSummary struct {
// The service name. Use this when calling other APIs.
Name *string `mandatory:"false" json:"name"`
// The friendly service name.
Description *string `mandatory:"false" json:"description"`
// An array of subscription types supported by the service. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'.
SupportedSubscriptions []string `mandatory:"false" json:"supportedSubscriptions"`
}
func (m ServiceSummary) String() string
func (m ServiceSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateQuotaDetails) String() string
func (m UpdateQuotaDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateQuotaRequest wrapper for the UpdateQuota operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
// is 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"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request UpdateQuotaRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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