limits

package
v65.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 3, 2022 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

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

Types

type CreateQuotaDetails 

type CreateQuotaDetails struct {

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

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

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

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

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

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

CreateQuotaDetails Request object for create quota operation.

func (CreateQuotaDetails) String 

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 

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
}

CreateQuotaRequest wrapper for the CreateQuota operation

See also

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

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 

type CreateQuotaResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateQuotaResponse wrapper for the CreateQuota operation

func (CreateQuotaResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateQuotaResponse) String 

func (response CreateQuotaResponse) String() string

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

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

DeleteQuotaRequest wrapper for the DeleteQuota operation

See also

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

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 

type DeleteQuotaResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteQuotaResponse wrapper for the DeleteQuota operation

func (DeleteQuotaResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteQuotaResponse) String 

func (response DeleteQuotaResponse) String() string

type 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
}

GetQuotaRequest wrapper for the GetQuota operation

See also

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

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 

type GetQuotaResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetQuotaResponse wrapper for the GetQuota operation

func (GetQuotaResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetQuotaResponse) String 

func (response GetQuotaResponse) String() string

type 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
}

GetResourceAvailabilityRequest wrapper for the GetResourceAvailability operation

See also

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

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 

type GetResourceAvailabilityResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

GetResourceAvailabilityResponse wrapper for the GetResourceAvailability operation

func (GetResourceAvailabilityResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetResourceAvailabilityResponse) String 

func (response GetResourceAvailabilityResponse) String() string

type LimitDefinitionSummary 

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

LimitDefinitionSummary The metadata specific to a resource limit definition.

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 

type LimitDefinitionSummaryScopeTypeEnum string

LimitDefinitionSummaryScopeTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for LimitDefinitionSummaryScopeTypeEnum

func GetLimitDefinitionSummaryScopeTypeEnumValues 

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 

type LimitValueSummary struct {

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

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

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

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

LimitValueSummary The value of a specific resource limit.

func (LimitValueSummary) String 

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 

type LimitValueSummaryScopeTypeEnum string

LimitValueSummaryScopeTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for LimitValueSummaryScopeTypeEnum

func GetLimitValueSummaryScopeTypeEnumValues 

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 

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

LimitsClient a client for Limits

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/latest/limits/GetResourceAvailability.go.html to see an example of how to use GetResourceAvailability API.

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/latest/limits/ListLimitDefinitions.go.html to see an example of how to use ListLimitDefinitions API.

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/latest/limits/ListLimitValues.go.html to see an example of how to use ListLimitValues API.

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/latest/limits/ListServices.go.html to see an example of how to use ListServices API.

func (*LimitsClient) SetRegion 

func (client *LimitsClient) SetRegion(region string)

SetRegion overrides the region of this client.

type 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
}

ListLimitDefinitionsRequest wrapper for the ListLimitDefinitions operation

See also

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

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 

type ListLimitDefinitionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListLimitDefinitionsResponse wrapper for the ListLimitDefinitions operation

func (ListLimitDefinitionsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListLimitDefinitionsResponse) String 

func (response ListLimitDefinitionsResponse) String() string

type ListLimitDefinitionsSortByEnum 

type ListLimitDefinitionsSortByEnum string

ListLimitDefinitionsSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListLimitDefinitionsSortByEnum

func GetListLimitDefinitionsSortByEnumValues 

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 

type ListLimitDefinitionsSortOrderEnum string

ListLimitDefinitionsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListLimitDefinitionsSortOrderEnum

func GetListLimitDefinitionsSortOrderEnumValues 

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 

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
}

ListLimitValuesRequest wrapper for the ListLimitValues operation

See also

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

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 

type ListLimitValuesResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListLimitValuesResponse wrapper for the ListLimitValues operation

func (ListLimitValuesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListLimitValuesResponse) String 

func (response ListLimitValuesResponse) String() string

type ListLimitValuesScopeTypeEnum 

type ListLimitValuesScopeTypeEnum string

ListLimitValuesScopeTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListLimitValuesScopeTypeEnum

func GetListLimitValuesScopeTypeEnumValues 

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 

type ListLimitValuesSortByEnum string

ListLimitValuesSortByEnum Enum with underlying type: string 

const (
	ListLimitValuesSortByName ListLimitValuesSortByEnum = "name"
)

Set of constants representing the allowable values for ListLimitValuesSortByEnum

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 

type ListLimitValuesSortOrderEnum string

ListLimitValuesSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListLimitValuesSortOrderEnum

func GetListLimitValuesSortOrderEnumValues 

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 

type ListQuotasLifecycleStateEnum string

ListQuotasLifecycleStateEnum Enum with underlying type: string 

const (
	ListQuotasLifecycleStateActive ListQuotasLifecycleStateEnum = "ACTIVE"
)

Set of constants representing the allowable values for ListQuotasLifecycleStateEnum

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 

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
}

ListQuotasRequest wrapper for the ListQuotas operation

See also

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

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 

type ListQuotasResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListQuotasResponse wrapper for the ListQuotas operation

func (ListQuotasResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListQuotasResponse) String 

func (response ListQuotasResponse) String() string

type ListQuotasSortByEnum 

type ListQuotasSortByEnum string

ListQuotasSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListQuotasSortByEnum

func GetListQuotasSortByEnumValues 

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 

type ListQuotasSortOrderEnum string

ListQuotasSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListQuotasSortOrderEnum

func GetListQuotasSortOrderEnumValues 

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 

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
}

ListServicesRequest wrapper for the ListServices operation

See also

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

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 

type ListServicesResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListServicesResponse wrapper for the ListServices operation

func (ListServicesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListServicesResponse) String 

func (response ListServicesResponse) String() string

type ListServicesSortByEnum 

type ListServicesSortByEnum string

ListServicesSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListServicesSortByEnum

func GetListServicesSortByEnumValues 

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 

type ListServicesSortOrderEnum string

ListServicesSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListServicesSortOrderEnum

func GetListServicesSortOrderEnumValues 

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 

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

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

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

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

Quota Quotas are applied on top of the service limits and inherited through the nested compartment hierarchy. 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.

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 

type QuotaLifecycleStateEnum string

QuotaLifecycleStateEnum Enum with underlying type: string 

const (
	QuotaLifecycleStateActive QuotaLifecycleStateEnum = "ACTIVE"
)

Set of constants representing the allowable values for QuotaLifecycleStateEnum

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 

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

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

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

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

QuotaSummary 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.

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 

type QuotaSummaryLifecycleStateEnum string

QuotaSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	QuotaSummaryLifecycleStateActive QuotaSummaryLifecycleStateEnum = "ACTIVE"
)

Set of constants representing the allowable values for QuotaSummaryLifecycleStateEnum

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 

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

QuotasClient a client for Quotas

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) 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/latest/limits/CreateQuota.go.html to see an example of how to use CreateQuota API.

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/latest/limits/DeleteQuota.go.html to see an example of how to use DeleteQuota API.

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/latest/limits/GetQuota.go.html to see an example of how to use GetQuota API.

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/latest/limits/ListQuotas.go.html to see an example of how to use ListQuotas 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/latest/limits/UpdateQuota.go.html to see an example of how to use UpdateQuota API.

type ResourceAvailability 

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

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.

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 ServiceSummary 

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

ServiceSummary A specific OCI service supported by resource limits.

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 

type UpdateQuotaDetails struct {

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

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

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

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

UpdateQuotaDetails Request object for update quota operation.

func (UpdateQuotaDetails) String 

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 

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

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

UpdateQuotaRequest wrapper for the UpdateQuota operation

See also

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

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 

type UpdateQuotaResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateQuotaResponse wrapper for the UpdateQuota operation

func (UpdateQuotaResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateQuotaResponse) String 

func (response UpdateQuotaResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.