...

Package limits

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

Overview ▾

Index ▾

func GetAddLockDetailsTypeEnumStringValues() []string
func GetLimitDefinitionSummaryScopeTypeEnumStringValues() []string
func GetLimitValueSummaryScopeTypeEnumStringValues() []string
func GetListLimitDefinitionsSortByEnumStringValues() []string
func GetListLimitDefinitionsSortOrderEnumStringValues() []string
func GetListLimitValuesScopeTypeEnumStringValues() []string
func GetListLimitValuesSortByEnumStringValues() []string
func GetListLimitValuesSortOrderEnumStringValues() []string
func GetListQuotasLifecycleStateEnumStringValues() []string
func GetListQuotasSortByEnumStringValues() []string
func GetListQuotasSortOrderEnumStringValues() []string
func GetListServicesSortByEnumStringValues() []string
func GetListServicesSortOrderEnumStringValues() []string
func GetQuotaLifecycleStateEnumStringValues() []string
func GetQuotaSummaryLifecycleStateEnumStringValues() []string
func GetRemoveLockDetailsTypeEnumStringValues() []string
func GetResourceLockTypeEnumStringValues() []string
type AddLockDetails
    func (m AddLockDetails) String() string
    func (m AddLockDetails) ValidateEnumValue() (bool, error)
type AddLockDetailsTypeEnum
    func GetAddLockDetailsTypeEnumValues() []AddLockDetailsTypeEnum
    func GetMappingAddLockDetailsTypeEnum(val string) (AddLockDetailsTypeEnum, bool)
type AddQuotaLockRequest
    func (request AddQuotaLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request AddQuotaLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request AddQuotaLockRequest) RetryPolicy() *common.RetryPolicy
    func (request AddQuotaLockRequest) String() string
    func (request AddQuotaLockRequest) ValidateEnumValue() (bool, error)
type AddQuotaLockResponse
    func (response AddQuotaLockResponse) HTTPResponse() *http.Response
    func (response AddQuotaLockResponse) String() string
type CreateQuotaDetails
    func (m CreateQuotaDetails) String() string
    func (m CreateQuotaDetails) ValidateEnumValue() (bool, error)
type CreateQuotaRequest
    func (request CreateQuotaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request CreateQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request CreateQuotaRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateQuotaRequest) String() string
    func (request CreateQuotaRequest) ValidateEnumValue() (bool, error)
type CreateQuotaResponse
    func (response CreateQuotaResponse) HTTPResponse() *http.Response
    func (response CreateQuotaResponse) String() string
type DeleteQuotaRequest
    func (request DeleteQuotaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request DeleteQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request DeleteQuotaRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteQuotaRequest) String() string
    func (request DeleteQuotaRequest) ValidateEnumValue() (bool, error)
type DeleteQuotaResponse
    func (response DeleteQuotaResponse) HTTPResponse() *http.Response
    func (response DeleteQuotaResponse) String() string
type GetQuotaRequest
    func (request GetQuotaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetQuotaRequest) RetryPolicy() *common.RetryPolicy
    func (request GetQuotaRequest) String() string
    func (request GetQuotaRequest) ValidateEnumValue() (bool, error)
type GetQuotaResponse
    func (response GetQuotaResponse) HTTPResponse() *http.Response
    func (response GetQuotaResponse) String() string
type GetResourceAvailabilityRequest
    func (request GetResourceAvailabilityRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetResourceAvailabilityRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetResourceAvailabilityRequest) RetryPolicy() *common.RetryPolicy
    func (request GetResourceAvailabilityRequest) String() string
    func (request GetResourceAvailabilityRequest) ValidateEnumValue() (bool, error)
type GetResourceAvailabilityResponse
    func (response GetResourceAvailabilityResponse) HTTPResponse() *http.Response
    func (response GetResourceAvailabilityResponse) String() string
type LimitDefinitionSummary
    func (m LimitDefinitionSummary) String() string
    func (m LimitDefinitionSummary) ValidateEnumValue() (bool, error)
type LimitDefinitionSummaryScopeTypeEnum
    func GetLimitDefinitionSummaryScopeTypeEnumValues() []LimitDefinitionSummaryScopeTypeEnum
    func GetMappingLimitDefinitionSummaryScopeTypeEnum(val string) (LimitDefinitionSummaryScopeTypeEnum, bool)
type LimitValueSummary
    func (m LimitValueSummary) String() string
    func (m LimitValueSummary) ValidateEnumValue() (bool, error)
type LimitValueSummaryScopeTypeEnum
    func GetLimitValueSummaryScopeTypeEnumValues() []LimitValueSummaryScopeTypeEnum
    func GetMappingLimitValueSummaryScopeTypeEnum(val string) (LimitValueSummaryScopeTypeEnum, bool)
type LimitsClient
    func NewLimitsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client LimitsClient, err error)
    func NewLimitsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client LimitsClient, err error)
    func (client *LimitsClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client LimitsClient) GetResourceAvailability(ctx context.Context, request GetResourceAvailabilityRequest) (response GetResourceAvailabilityResponse, err error)
    func (client LimitsClient) ListLimitDefinitions(ctx context.Context, request ListLimitDefinitionsRequest) (response ListLimitDefinitionsResponse, err error)
    func (client LimitsClient) ListLimitValues(ctx context.Context, request ListLimitValuesRequest) (response ListLimitValuesResponse, err error)
    func (client LimitsClient) ListServices(ctx context.Context, request ListServicesRequest) (response ListServicesResponse, err error)
    func (client *LimitsClient) SetRegion(region string)
type ListLimitDefinitionsRequest
    func (request ListLimitDefinitionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListLimitDefinitionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListLimitDefinitionsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListLimitDefinitionsRequest) String() string
    func (request ListLimitDefinitionsRequest) ValidateEnumValue() (bool, error)
type ListLimitDefinitionsResponse
    func (response ListLimitDefinitionsResponse) HTTPResponse() *http.Response
    func (response ListLimitDefinitionsResponse) String() string
type ListLimitDefinitionsSortByEnum
    func GetListLimitDefinitionsSortByEnumValues() []ListLimitDefinitionsSortByEnum
    func GetMappingListLimitDefinitionsSortByEnum(val string) (ListLimitDefinitionsSortByEnum, bool)
type ListLimitDefinitionsSortOrderEnum
    func GetListLimitDefinitionsSortOrderEnumValues() []ListLimitDefinitionsSortOrderEnum
    func GetMappingListLimitDefinitionsSortOrderEnum(val string) (ListLimitDefinitionsSortOrderEnum, bool)
type ListLimitValuesRequest
    func (request ListLimitValuesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListLimitValuesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListLimitValuesRequest) RetryPolicy() *common.RetryPolicy
    func (request ListLimitValuesRequest) String() string
    func (request ListLimitValuesRequest) ValidateEnumValue() (bool, error)
type ListLimitValuesResponse
    func (response ListLimitValuesResponse) HTTPResponse() *http.Response
    func (response ListLimitValuesResponse) String() string
type ListLimitValuesScopeTypeEnum
    func GetListLimitValuesScopeTypeEnumValues() []ListLimitValuesScopeTypeEnum
    func GetMappingListLimitValuesScopeTypeEnum(val string) (ListLimitValuesScopeTypeEnum, bool)
type ListLimitValuesSortByEnum
    func GetListLimitValuesSortByEnumValues() []ListLimitValuesSortByEnum
    func GetMappingListLimitValuesSortByEnum(val string) (ListLimitValuesSortByEnum, bool)
type ListLimitValuesSortOrderEnum
    func GetListLimitValuesSortOrderEnumValues() []ListLimitValuesSortOrderEnum
    func GetMappingListLimitValuesSortOrderEnum(val string) (ListLimitValuesSortOrderEnum, bool)
type ListQuotasLifecycleStateEnum
    func GetListQuotasLifecycleStateEnumValues() []ListQuotasLifecycleStateEnum
    func GetMappingListQuotasLifecycleStateEnum(val string) (ListQuotasLifecycleStateEnum, bool)
type ListQuotasRequest
    func (request ListQuotasRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListQuotasRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListQuotasRequest) RetryPolicy() *common.RetryPolicy
    func (request ListQuotasRequest) String() string
    func (request ListQuotasRequest) ValidateEnumValue() (bool, error)
type ListQuotasResponse
    func (response ListQuotasResponse) HTTPResponse() *http.Response
    func (response ListQuotasResponse) String() string
type ListQuotasSortByEnum
    func GetListQuotasSortByEnumValues() []ListQuotasSortByEnum
    func GetMappingListQuotasSortByEnum(val string) (ListQuotasSortByEnum, bool)
type ListQuotasSortOrderEnum
    func GetListQuotasSortOrderEnumValues() []ListQuotasSortOrderEnum
    func GetMappingListQuotasSortOrderEnum(val string) (ListQuotasSortOrderEnum, bool)
type ListServicesRequest
    func (request ListServicesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListServicesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListServicesRequest) RetryPolicy() *common.RetryPolicy
    func (request ListServicesRequest) String() string
    func (request ListServicesRequest) ValidateEnumValue() (bool, error)
type ListServicesResponse
    func (response ListServicesResponse) HTTPResponse() *http.Response
    func (response ListServicesResponse) String() string
type ListServicesSortByEnum
    func GetListServicesSortByEnumValues() []ListServicesSortByEnum
    func GetMappingListServicesSortByEnum(val string) (ListServicesSortByEnum, bool)
type ListServicesSortOrderEnum
    func GetListServicesSortOrderEnumValues() []ListServicesSortOrderEnum
    func GetMappingListServicesSortOrderEnum(val string) (ListServicesSortOrderEnum, bool)
type Quota
    func (m Quota) String() string
    func (m Quota) ValidateEnumValue() (bool, error)
type QuotaLifecycleStateEnum
    func GetMappingQuotaLifecycleStateEnum(val string) (QuotaLifecycleStateEnum, bool)
    func GetQuotaLifecycleStateEnumValues() []QuotaLifecycleStateEnum
type QuotaSummary
    func (m QuotaSummary) String() string
    func (m QuotaSummary) ValidateEnumValue() (bool, error)
type QuotaSummaryLifecycleStateEnum
    func GetMappingQuotaSummaryLifecycleStateEnum(val string) (QuotaSummaryLifecycleStateEnum, bool)
    func GetQuotaSummaryLifecycleStateEnumValues() []QuotaSummaryLifecycleStateEnum
type QuotasClient
    func NewQuotasClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client QuotasClient, err error)
    func NewQuotasClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client QuotasClient, err error)
    func (client QuotasClient) AddQuotaLock(ctx context.Context, request AddQuotaLockRequest) (response AddQuotaLockResponse, err error)
    func (client *QuotasClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client QuotasClient) CreateQuota(ctx context.Context, request CreateQuotaRequest) (response CreateQuotaResponse, err error)
    func (client QuotasClient) DeleteQuota(ctx context.Context, request DeleteQuotaRequest) (response DeleteQuotaResponse, err error)
    func (client QuotasClient) GetQuota(ctx context.Context, request GetQuotaRequest) (response GetQuotaResponse, err error)
    func (client QuotasClient) ListQuotas(ctx context.Context, request ListQuotasRequest) (response ListQuotasResponse, err error)
    func (client QuotasClient) RemoveQuotaLock(ctx context.Context, request RemoveQuotaLockRequest) (response RemoveQuotaLockResponse, err error)
    func (client *QuotasClient) SetRegion(region string)
    func (client QuotasClient) UpdateQuota(ctx context.Context, request UpdateQuotaRequest) (response UpdateQuotaResponse, err error)
type RemoveLockDetails
    func (m RemoveLockDetails) String() string
    func (m RemoveLockDetails) ValidateEnumValue() (bool, error)
type RemoveLockDetailsTypeEnum
    func GetMappingRemoveLockDetailsTypeEnum(val string) (RemoveLockDetailsTypeEnum, bool)
    func GetRemoveLockDetailsTypeEnumValues() []RemoveLockDetailsTypeEnum
type RemoveQuotaLockRequest
    func (request RemoveQuotaLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request RemoveQuotaLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request RemoveQuotaLockRequest) RetryPolicy() *common.RetryPolicy
    func (request RemoveQuotaLockRequest) String() string
    func (request RemoveQuotaLockRequest) ValidateEnumValue() (bool, error)
type RemoveQuotaLockResponse
    func (response RemoveQuotaLockResponse) HTTPResponse() *http.Response
    func (response RemoveQuotaLockResponse) String() string
type ResourceAvailability
    func (m ResourceAvailability) String() string
    func (m ResourceAvailability) ValidateEnumValue() (bool, error)
type ResourceLock
    func (m ResourceLock) String() string
    func (m ResourceLock) ValidateEnumValue() (bool, error)
type ResourceLockTypeEnum
    func GetMappingResourceLockTypeEnum(val string) (ResourceLockTypeEnum, bool)
    func GetResourceLockTypeEnumValues() []ResourceLockTypeEnum
type ServiceSummary
    func (m ServiceSummary) String() string
    func (m ServiceSummary) ValidateEnumValue() (bool, error)
type UpdateQuotaDetails
    func (m UpdateQuotaDetails) String() string
    func (m UpdateQuotaDetails) ValidateEnumValue() (bool, error)
type UpdateQuotaRequest
    func (request UpdateQuotaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request UpdateQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request UpdateQuotaRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateQuotaRequest) String() string
    func (request UpdateQuotaRequest) ValidateEnumValue() (bool, error)
type UpdateQuotaResponse
    func (response UpdateQuotaResponse) HTTPResponse() *http.Response
    func (response UpdateQuotaResponse) String() string

Package files

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

func GetAddLockDetailsTypeEnumStringValues

func GetAddLockDetailsTypeEnumStringValues() []string

GetAddLockDetailsTypeEnumStringValues Enumerates the set of values in String for AddLockDetailsTypeEnum

func GetLimitDefinitionSummaryScopeTypeEnumStringValues

func GetLimitDefinitionSummaryScopeTypeEnumStringValues() []string

GetLimitDefinitionSummaryScopeTypeEnumStringValues Enumerates the set of values in String for LimitDefinitionSummaryScopeTypeEnum

func GetLimitValueSummaryScopeTypeEnumStringValues

func GetLimitValueSummaryScopeTypeEnumStringValues() []string

GetLimitValueSummaryScopeTypeEnumStringValues Enumerates the set of values in String for LimitValueSummaryScopeTypeEnum

func GetListLimitDefinitionsSortByEnumStringValues

func GetListLimitDefinitionsSortByEnumStringValues() []string

GetListLimitDefinitionsSortByEnumStringValues Enumerates the set of values in String for ListLimitDefinitionsSortByEnum

func GetListLimitDefinitionsSortOrderEnumStringValues

func GetListLimitDefinitionsSortOrderEnumStringValues() []string

GetListLimitDefinitionsSortOrderEnumStringValues Enumerates the set of values in String for ListLimitDefinitionsSortOrderEnum

func GetListLimitValuesScopeTypeEnumStringValues

func GetListLimitValuesScopeTypeEnumStringValues() []string

GetListLimitValuesScopeTypeEnumStringValues Enumerates the set of values in String for ListLimitValuesScopeTypeEnum

func GetListLimitValuesSortByEnumStringValues

func GetListLimitValuesSortByEnumStringValues() []string

GetListLimitValuesSortByEnumStringValues Enumerates the set of values in String for ListLimitValuesSortByEnum

func GetListLimitValuesSortOrderEnumStringValues

func GetListLimitValuesSortOrderEnumStringValues() []string

GetListLimitValuesSortOrderEnumStringValues Enumerates the set of values in String for ListLimitValuesSortOrderEnum

func GetListQuotasLifecycleStateEnumStringValues

func GetListQuotasLifecycleStateEnumStringValues() []string

GetListQuotasLifecycleStateEnumStringValues Enumerates the set of values in String for ListQuotasLifecycleStateEnum

func GetListQuotasSortByEnumStringValues

func GetListQuotasSortByEnumStringValues() []string

GetListQuotasSortByEnumStringValues Enumerates the set of values in String for ListQuotasSortByEnum

func GetListQuotasSortOrderEnumStringValues

func GetListQuotasSortOrderEnumStringValues() []string

GetListQuotasSortOrderEnumStringValues Enumerates the set of values in String for ListQuotasSortOrderEnum

func GetListServicesSortByEnumStringValues

func GetListServicesSortByEnumStringValues() []string

GetListServicesSortByEnumStringValues Enumerates the set of values in String for ListServicesSortByEnum

func GetListServicesSortOrderEnumStringValues

func GetListServicesSortOrderEnumStringValues() []string

GetListServicesSortOrderEnumStringValues Enumerates the set of values in String for ListServicesSortOrderEnum

func GetQuotaLifecycleStateEnumStringValues

func GetQuotaLifecycleStateEnumStringValues() []string

GetQuotaLifecycleStateEnumStringValues Enumerates the set of values in String for QuotaLifecycleStateEnum

func GetQuotaSummaryLifecycleStateEnumStringValues

func GetQuotaSummaryLifecycleStateEnumStringValues() []string

GetQuotaSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for QuotaSummaryLifecycleStateEnum

func GetRemoveLockDetailsTypeEnumStringValues

func GetRemoveLockDetailsTypeEnumStringValues() []string

GetRemoveLockDetailsTypeEnumStringValues Enumerates the set of values in String for RemoveLockDetailsTypeEnum

func GetResourceLockTypeEnumStringValues

func GetResourceLockTypeEnumStringValues() []string

GetResourceLockTypeEnumStringValues Enumerates the set of values in String for ResourceLockTypeEnum

type AddLockDetails

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 (AddLockDetails) String

func (m AddLockDetails) String() string

func (AddLockDetails) ValidateEnumValue

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

type AddLockDetailsTypeEnum

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

func GetAddLockDetailsTypeEnumValues() []AddLockDetailsTypeEnum

GetAddLockDetailsTypeEnumValues Enumerates the set of values for AddLockDetailsTypeEnum

func GetMappingAddLockDetailsTypeEnum

func GetMappingAddLockDetailsTypeEnum(val string) (AddLockDetailsTypeEnum, bool)

GetMappingAddLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type AddQuotaLockRequest

AddQuotaLockRequest wrapper for the AddQuotaLock operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (AddQuotaLockRequest) BinaryRequestBody

func (request AddQuotaLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (AddQuotaLockRequest) HTTPRequest

func (request AddQuotaLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AddQuotaLockRequest) RetryPolicy

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

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

func (AddQuotaLockRequest) String

func (request AddQuotaLockRequest) String() string

func (AddQuotaLockRequest) ValidateEnumValue

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

type AddQuotaLockResponse

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 (AddQuotaLockResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (AddQuotaLockResponse) String

func (response AddQuotaLockResponse) String() string

type CreateQuotaDetails

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.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 (CreateQuotaDetails) String

func (m CreateQuotaDetails) String() string

func (CreateQuotaDetails) ValidateEnumValue

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

type CreateQuotaRequest

CreateQuotaRequest wrapper for the CreateQuota operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.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
    // 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 (CreateQuotaRequest) BinaryRequestBody

func (request CreateQuotaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateQuotaRequest) HTTPRequest

func (request CreateQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateQuotaRequest) RetryPolicy

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

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

func (CreateQuotaRequest) String

func (request CreateQuotaRequest) String() string

func (CreateQuotaRequest) ValidateEnumValue

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

type CreateQuotaResponse

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 (CreateQuotaResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateQuotaResponse) String

func (response CreateQuotaResponse) String() string

type DeleteQuotaRequest

DeleteQuotaRequest wrapper for the DeleteQuota operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.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
    // 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 (DeleteQuotaRequest) BinaryRequestBody

func (request DeleteQuotaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteQuotaRequest) HTTPRequest

func (request DeleteQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteQuotaRequest) RetryPolicy

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

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

func (DeleteQuotaRequest) String

func (request DeleteQuotaRequest) String() string

func (DeleteQuotaRequest) ValidateEnumValue

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

type DeleteQuotaResponse

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 (DeleteQuotaResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteQuotaResponse) String

func (response DeleteQuotaResponse) String() string

type GetQuotaRequest

GetQuotaRequest wrapper for the GetQuota operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.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 (GetQuotaRequest) BinaryRequestBody

func (request GetQuotaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetQuotaRequest) HTTPRequest

func (request GetQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetQuotaRequest) RetryPolicy

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

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

func (GetQuotaRequest) String

func (request GetQuotaRequest) String() string

func (GetQuotaRequest) ValidateEnumValue

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

type GetQuotaResponse

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 (GetQuotaResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetQuotaResponse) String

func (response GetQuotaResponse) String() string

type GetResourceAvailabilityRequest

GetResourceAvailabilityRequest wrapper for the GetResourceAvailability operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.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 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"`

    // 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 (GetResourceAvailabilityRequest) BinaryRequestBody

func (request GetResourceAvailabilityRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetResourceAvailabilityRequest) HTTPRequest

func (request GetResourceAvailabilityRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetResourceAvailabilityRequest) RetryPolicy

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

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

func (GetResourceAvailabilityRequest) String

func (request GetResourceAvailabilityRequest) String() string

func (GetResourceAvailabilityRequest) ValidateEnumValue

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

type GetResourceAvailabilityResponse

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 (GetResourceAvailabilityResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetResourceAvailabilityResponse) String

func (response GetResourceAvailabilityResponse) String() string

type LimitDefinitionSummary

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"`
}

func (LimitDefinitionSummary) String

func (m LimitDefinitionSummary) String() string

func (LimitDefinitionSummary) ValidateEnumValue

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

type LimitDefinitionSummaryScopeTypeEnum

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

func GetLimitDefinitionSummaryScopeTypeEnumValues() []LimitDefinitionSummaryScopeTypeEnum

GetLimitDefinitionSummaryScopeTypeEnumValues Enumerates the set of values for LimitDefinitionSummaryScopeTypeEnum

func GetMappingLimitDefinitionSummaryScopeTypeEnum

func GetMappingLimitDefinitionSummaryScopeTypeEnum(val string) (LimitDefinitionSummaryScopeTypeEnum, bool)

GetMappingLimitDefinitionSummaryScopeTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type LimitValueSummary

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 (LimitValueSummary) String

func (m LimitValueSummary) String() string

func (LimitValueSummary) ValidateEnumValue

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

type LimitValueSummaryScopeTypeEnum

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

func GetLimitValueSummaryScopeTypeEnumValues() []LimitValueSummaryScopeTypeEnum

GetLimitValueSummaryScopeTypeEnumValues Enumerates the set of values for LimitValueSummaryScopeTypeEnum

func GetMappingLimitValueSummaryScopeTypeEnum

func GetMappingLimitValueSummaryScopeTypeEnum(val string) (LimitValueSummaryScopeTypeEnum, bool)

GetMappingLimitValueSummaryScopeTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type LimitsClient

LimitsClient a client for Limits

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

func NewLimitsClientWithConfigurationProvider

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

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

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

as well as reading the region

func (*LimitsClient) ConfigurationProvider

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

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

func (LimitsClient) GetResourceAvailability

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 that not all resource limits support this API. If the value is not available, the API returns a 404 response.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/GetResourceAvailability.go.html to see an example of how to use GetResourceAvailability API. A default retry strategy applies to this operation GetResourceAvailability()

func (LimitsClient) ListLimitDefinitions

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.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/ListLimitDefinitions.go.html to see an example of how to use ListLimitDefinitions API. A default retry strategy applies to this operation ListLimitDefinitions()

func (LimitsClient) ListLimitValues

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.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/ListLimitValues.go.html to see an example of how to use ListLimitValues API. A default retry strategy applies to this operation ListLimitValues()

func (LimitsClient) ListServices

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

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

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/ListServices.go.html to see an example of how to use ListServices API. A default retry strategy applies to this operation ListServices()

func (*LimitsClient) SetRegion

func (client *LimitsClient) SetRegion(region string)

SetRegion overrides the region of this client.

type ListLimitDefinitionsRequest

ListLimitDefinitionsRequest wrapper for the ListLimitDefinitions operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.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 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 (ListLimitDefinitionsRequest) BinaryRequestBody

func (request ListLimitDefinitionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListLimitDefinitionsRequest) HTTPRequest

func (request ListLimitDefinitionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListLimitDefinitionsRequest) RetryPolicy

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

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

func (ListLimitDefinitionsRequest) String

func (request ListLimitDefinitionsRequest) String() string

func (ListLimitDefinitionsRequest) ValidateEnumValue

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

type ListLimitDefinitionsResponse

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 (ListLimitDefinitionsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListLimitDefinitionsResponse) String

func (response ListLimitDefinitionsResponse) String() string

type ListLimitDefinitionsSortByEnum

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

func GetListLimitDefinitionsSortByEnumValues() []ListLimitDefinitionsSortByEnum

GetListLimitDefinitionsSortByEnumValues Enumerates the set of values for ListLimitDefinitionsSortByEnum

func GetMappingListLimitDefinitionsSortByEnum

func GetMappingListLimitDefinitionsSortByEnum(val string) (ListLimitDefinitionsSortByEnum, bool)

GetMappingListLimitDefinitionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListLimitDefinitionsSortOrderEnum

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

func GetListLimitDefinitionsSortOrderEnumValues() []ListLimitDefinitionsSortOrderEnum

GetListLimitDefinitionsSortOrderEnumValues Enumerates the set of values for ListLimitDefinitionsSortOrderEnum

func GetMappingListLimitDefinitionsSortOrderEnum

func GetMappingListLimitDefinitionsSortOrderEnum(val string) (ListLimitDefinitionsSortOrderEnum, bool)

GetMappingListLimitDefinitionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListLimitValuesRequest

ListLimitValuesRequest wrapper for the ListLimitValues operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.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 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 (ListLimitValuesRequest) BinaryRequestBody

func (request ListLimitValuesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListLimitValuesRequest) HTTPRequest

func (request ListLimitValuesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListLimitValuesRequest) RetryPolicy

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

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

func (ListLimitValuesRequest) String

func (request ListLimitValuesRequest) String() string

func (ListLimitValuesRequest) ValidateEnumValue

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

type ListLimitValuesResponse

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 (ListLimitValuesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListLimitValuesResponse) String

func (response ListLimitValuesResponse) String() string

type ListLimitValuesScopeTypeEnum

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

func GetListLimitValuesScopeTypeEnumValues() []ListLimitValuesScopeTypeEnum

GetListLimitValuesScopeTypeEnumValues Enumerates the set of values for ListLimitValuesScopeTypeEnum

func GetMappingListLimitValuesScopeTypeEnum

func GetMappingListLimitValuesScopeTypeEnum(val string) (ListLimitValuesScopeTypeEnum, bool)

GetMappingListLimitValuesScopeTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ListLimitValuesSortByEnum

ListLimitValuesSortByEnum Enum with underlying type: string

type ListLimitValuesSortByEnum string

Set of constants representing the allowable values for ListLimitValuesSortByEnum

const (
    ListLimitValuesSortByName ListLimitValuesSortByEnum = "name"
)

func GetListLimitValuesSortByEnumValues

func GetListLimitValuesSortByEnumValues() []ListLimitValuesSortByEnum

GetListLimitValuesSortByEnumValues Enumerates the set of values for ListLimitValuesSortByEnum

func GetMappingListLimitValuesSortByEnum

func GetMappingListLimitValuesSortByEnum(val string) (ListLimitValuesSortByEnum, bool)

GetMappingListLimitValuesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListLimitValuesSortOrderEnum

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

func GetListLimitValuesSortOrderEnumValues() []ListLimitValuesSortOrderEnum

GetListLimitValuesSortOrderEnumValues Enumerates the set of values for ListLimitValuesSortOrderEnum

func GetMappingListLimitValuesSortOrderEnum

func GetMappingListLimitValuesSortOrderEnum(val string) (ListLimitValuesSortOrderEnum, bool)

GetMappingListLimitValuesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListQuotasLifecycleStateEnum

ListQuotasLifecycleStateEnum Enum with underlying type: string

type ListQuotasLifecycleStateEnum string

Set of constants representing the allowable values for ListQuotasLifecycleStateEnum

const (
    ListQuotasLifecycleStateActive ListQuotasLifecycleStateEnum = "ACTIVE"
)

func GetListQuotasLifecycleStateEnumValues

func GetListQuotasLifecycleStateEnumValues() []ListQuotasLifecycleStateEnum

GetListQuotasLifecycleStateEnumValues Enumerates the set of values for ListQuotasLifecycleStateEnum

func GetMappingListQuotasLifecycleStateEnum

func GetMappingListQuotasLifecycleStateEnum(val string) (ListQuotasLifecycleStateEnum, bool)

GetMappingListQuotasLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListQuotasRequest

ListQuotasRequest wrapper for the ListQuotas operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.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 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 (ListQuotasRequest) BinaryRequestBody

func (request ListQuotasRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListQuotasRequest) HTTPRequest

func (request ListQuotasRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListQuotasRequest) RetryPolicy

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

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

func (ListQuotasRequest) String

func (request ListQuotasRequest) String() string

func (ListQuotasRequest) ValidateEnumValue

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

type ListQuotasResponse

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 (ListQuotasResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListQuotasResponse) String

func (response ListQuotasResponse) String() string

type ListQuotasSortByEnum

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

func GetListQuotasSortByEnumValues() []ListQuotasSortByEnum

GetListQuotasSortByEnumValues Enumerates the set of values for ListQuotasSortByEnum

func GetMappingListQuotasSortByEnum

func GetMappingListQuotasSortByEnum(val string) (ListQuotasSortByEnum, bool)

GetMappingListQuotasSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListQuotasSortOrderEnum

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

func GetListQuotasSortOrderEnumValues() []ListQuotasSortOrderEnum

GetListQuotasSortOrderEnumValues Enumerates the set of values for ListQuotasSortOrderEnum

func GetMappingListQuotasSortOrderEnum

func GetMappingListQuotasSortOrderEnum(val string) (ListQuotasSortOrderEnum, bool)

GetMappingListQuotasSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListServicesRequest

ListServicesRequest wrapper for the ListServices operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.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 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"`

    // 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 (ListServicesRequest) BinaryRequestBody

func (request ListServicesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListServicesRequest) HTTPRequest

func (request ListServicesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListServicesRequest) RetryPolicy

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

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

func (ListServicesRequest) String

func (request ListServicesRequest) String() string

func (ListServicesRequest) ValidateEnumValue

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

type ListServicesResponse

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 (ListServicesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListServicesResponse) String

func (response ListServicesResponse) String() string

type ListServicesSortByEnum

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

func GetListServicesSortByEnumValues() []ListServicesSortByEnum

GetListServicesSortByEnumValues Enumerates the set of values for ListServicesSortByEnum

func GetMappingListServicesSortByEnum

func GetMappingListServicesSortByEnum(val string) (ListServicesSortByEnum, bool)

GetMappingListServicesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListServicesSortOrderEnum

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

func GetListServicesSortOrderEnumValues() []ListServicesSortOrderEnum

GetListServicesSortOrderEnumValues Enumerates the set of values for ListServicesSortOrderEnum

func GetMappingListServicesSortOrderEnum

func GetMappingListServicesSortOrderEnum(val string) (ListServicesSortOrderEnum, bool)

GetMappingListServicesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type Quota

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:

- 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 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.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 (Quota) String

func (m Quota) String() string

func (Quota) ValidateEnumValue

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

type QuotaLifecycleStateEnum

QuotaLifecycleStateEnum Enum with underlying type: string

type QuotaLifecycleStateEnum string

Set of constants representing the allowable values for QuotaLifecycleStateEnum

const (
    QuotaLifecycleStateActive QuotaLifecycleStateEnum = "ACTIVE"
)

func GetMappingQuotaLifecycleStateEnum

func GetMappingQuotaLifecycleStateEnum(val string) (QuotaLifecycleStateEnum, bool)

GetMappingQuotaLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetQuotaLifecycleStateEnumValues

func GetQuotaLifecycleStateEnumValues() []QuotaLifecycleStateEnum

GetQuotaLifecycleStateEnumValues Enumerates the set of values for QuotaLifecycleStateEnum

type QuotaSummary

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.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 (QuotaSummary) String

func (m QuotaSummary) String() string

func (QuotaSummary) ValidateEnumValue

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

type QuotaSummaryLifecycleStateEnum

QuotaSummaryLifecycleStateEnum Enum with underlying type: string

type QuotaSummaryLifecycleStateEnum string

Set of constants representing the allowable values for QuotaSummaryLifecycleStateEnum

const (
    QuotaSummaryLifecycleStateActive QuotaSummaryLifecycleStateEnum = "ACTIVE"
)

func GetMappingQuotaSummaryLifecycleStateEnum

func GetMappingQuotaSummaryLifecycleStateEnum(val string) (QuotaSummaryLifecycleStateEnum, bool)

GetMappingQuotaSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetQuotaSummaryLifecycleStateEnumValues

func GetQuotaSummaryLifecycleStateEnumValues() []QuotaSummaryLifecycleStateEnum

GetQuotaSummaryLifecycleStateEnumValues Enumerates the set of values for QuotaSummaryLifecycleStateEnum

type QuotasClient

QuotasClient a client for Quotas

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

func NewQuotasClientWithConfigurationProvider

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

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

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

as well as reading the region

func (QuotasClient) AddQuotaLock

func (client QuotasClient) AddQuotaLock(ctx context.Context, request AddQuotaLockRequest) (response AddQuotaLockResponse, err error)

AddQuotaLock Adds a lock to a resource.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/AddQuotaLock.go.html to see an example of how to use AddQuotaLock API.

func (*QuotasClient) ConfigurationProvider

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

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

func (QuotasClient) CreateQuota

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

CreateQuota Creates a new quota with the details supplied.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/CreateQuota.go.html to see an example of how to use CreateQuota API. A default retry strategy applies to this operation CreateQuota()

func (QuotasClient) DeleteQuota

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

DeleteQuota Deletes the quota corresponding to the given OCID.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/DeleteQuota.go.html to see an example of how to use DeleteQuota API. A default retry strategy applies to this operation DeleteQuota()

func (QuotasClient) GetQuota

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

GetQuota Gets the quota for the OCID specified.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/GetQuota.go.html to see an example of how to use GetQuota API. A default retry strategy applies to this operation GetQuota()

func (QuotasClient) ListQuotas

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

ListQuotas Lists all quotas on resources from the given compartment.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/ListQuotas.go.html to see an example of how to use ListQuotas API. A default retry strategy applies to this operation ListQuotas()

func (QuotasClient) RemoveQuotaLock

func (client QuotasClient) RemoveQuotaLock(ctx context.Context, request RemoveQuotaLockRequest) (response RemoveQuotaLockResponse, err error)

RemoveQuotaLock Remove a lock from a resource.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/RemoveQuotaLock.go.html to see an example of how to use RemoveQuotaLock API.

func (*QuotasClient) SetRegion

func (client *QuotasClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (QuotasClient) UpdateQuota

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.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/limits/UpdateQuota.go.html to see an example of how to use UpdateQuota API. A default retry strategy applies to this operation UpdateQuota()

type RemoveLockDetails

RemoveLockDetails Request payload to remove the resource lock.

type RemoveLockDetails struct {

    // Lock type.
    Type RemoveLockDetailsTypeEnum `mandatory:"true" json:"type"`
}

func (RemoveLockDetails) String

func (m RemoveLockDetails) String() string

func (RemoveLockDetails) ValidateEnumValue

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

type RemoveLockDetailsTypeEnum

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

func GetMappingRemoveLockDetailsTypeEnum(val string) (RemoveLockDetailsTypeEnum, bool)

GetMappingRemoveLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetRemoveLockDetailsTypeEnumValues

func GetRemoveLockDetailsTypeEnumValues() []RemoveLockDetailsTypeEnum

GetRemoveLockDetailsTypeEnumValues Enumerates the set of values for RemoveLockDetailsTypeEnum

type RemoveQuotaLockRequest

RemoveQuotaLockRequest wrapper for the RemoveQuotaLock operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (RemoveQuotaLockRequest) BinaryRequestBody

func (request RemoveQuotaLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RemoveQuotaLockRequest) HTTPRequest

func (request RemoveQuotaLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RemoveQuotaLockRequest) RetryPolicy

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

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

func (RemoveQuotaLockRequest) String

func (request RemoveQuotaLockRequest) String() string

func (RemoveQuotaLockRequest) ValidateEnumValue

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

type RemoveQuotaLockResponse

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 (RemoveQuotaLockResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (RemoveQuotaLockResponse) String

func (response RemoveQuotaLockResponse) String() string

type ResourceAvailability

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 (ResourceAvailability) String

func (m ResourceAvailability) String() string

func (ResourceAvailability) ValidateEnumValue

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

type ResourceLock

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 (ResourceLock) String

func (m ResourceLock) String() string

func (ResourceLock) ValidateEnumValue

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

type ResourceLockTypeEnum

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

func GetMappingResourceLockTypeEnum(val string) (ResourceLockTypeEnum, bool)

GetMappingResourceLockTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetResourceLockTypeEnumValues

func GetResourceLockTypeEnumValues() []ResourceLockTypeEnum

GetResourceLockTypeEnumValues Enumerates the set of values for ResourceLockTypeEnum

type ServiceSummary

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"`
}

func (ServiceSummary) String

func (m ServiceSummary) String() string

func (ServiceSummary) ValidateEnumValue

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

type UpdateQuotaDetails

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 (UpdateQuotaDetails) String

func (m UpdateQuotaDetails) String() string

func (UpdateQuotaDetails) ValidateEnumValue

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

type UpdateQuotaRequest

UpdateQuotaRequest wrapper for the UpdateQuota operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.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
    // 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 (UpdateQuotaRequest) BinaryRequestBody

func (request UpdateQuotaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateQuotaRequest) HTTPRequest

func (request UpdateQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateQuotaRequest) RetryPolicy

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

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

func (UpdateQuotaRequest) String

func (request UpdateQuotaRequest) String() string

func (UpdateQuotaRequest) ValidateEnumValue

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

type UpdateQuotaResponse

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 (UpdateQuotaResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateQuotaResponse) String

func (response UpdateQuotaResponse) String() string