func GetCreateOccCapacityRequestDetailsRequestStateEnumStringValues() []string
GetCreateOccCapacityRequestDetailsRequestStateEnumStringValues Enumerates the set of values in String for CreateOccCapacityRequestDetailsRequestStateEnum
func GetListOccAvailabilitiesSortByEnumStringValues() []string
GetListOccAvailabilitiesSortByEnumStringValues Enumerates the set of values in String for ListOccAvailabilitiesSortByEnum
func GetListOccAvailabilitiesSortOrderEnumStringValues() []string
GetListOccAvailabilitiesSortOrderEnumStringValues Enumerates the set of values in String for ListOccAvailabilitiesSortOrderEnum
func GetListOccAvailabilityCatalogsInternalNamespaceEnumStringValues() []string
GetListOccAvailabilityCatalogsInternalNamespaceEnumStringValues Enumerates the set of values in String for ListOccAvailabilityCatalogsInternalNamespaceEnum
func GetListOccAvailabilityCatalogsInternalSortByEnumStringValues() []string
GetListOccAvailabilityCatalogsInternalSortByEnumStringValues Enumerates the set of values in String for ListOccAvailabilityCatalogsInternalSortByEnum
func GetListOccAvailabilityCatalogsInternalSortOrderEnumStringValues() []string
GetListOccAvailabilityCatalogsInternalSortOrderEnumStringValues Enumerates the set of values in String for ListOccAvailabilityCatalogsInternalSortOrderEnum
func GetListOccAvailabilityCatalogsNamespaceEnumStringValues() []string
GetListOccAvailabilityCatalogsNamespaceEnumStringValues Enumerates the set of values in String for ListOccAvailabilityCatalogsNamespaceEnum
func GetListOccAvailabilityCatalogsSortByEnumStringValues() []string
GetListOccAvailabilityCatalogsSortByEnumStringValues Enumerates the set of values in String for ListOccAvailabilityCatalogsSortByEnum
func GetListOccAvailabilityCatalogsSortOrderEnumStringValues() []string
GetListOccAvailabilityCatalogsSortOrderEnumStringValues Enumerates the set of values in String for ListOccAvailabilityCatalogsSortOrderEnum
func GetListOccCapacityRequestsInternalNamespaceEnumStringValues() []string
GetListOccCapacityRequestsInternalNamespaceEnumStringValues Enumerates the set of values in String for ListOccCapacityRequestsInternalNamespaceEnum
func GetListOccCapacityRequestsInternalSortByEnumStringValues() []string
GetListOccCapacityRequestsInternalSortByEnumStringValues Enumerates the set of values in String for ListOccCapacityRequestsInternalSortByEnum
func GetListOccCapacityRequestsInternalSortOrderEnumStringValues() []string
GetListOccCapacityRequestsInternalSortOrderEnumStringValues Enumerates the set of values in String for ListOccCapacityRequestsInternalSortOrderEnum
func GetListOccCapacityRequestsNamespaceEnumStringValues() []string
GetListOccCapacityRequestsNamespaceEnumStringValues Enumerates the set of values in String for ListOccCapacityRequestsNamespaceEnum
func GetListOccCapacityRequestsSortByEnumStringValues() []string
GetListOccCapacityRequestsSortByEnumStringValues Enumerates the set of values in String for ListOccCapacityRequestsSortByEnum
func GetListOccCapacityRequestsSortOrderEnumStringValues() []string
GetListOccCapacityRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListOccCapacityRequestsSortOrderEnum
func GetListOccCustomerGroupsSortByEnumStringValues() []string
GetListOccCustomerGroupsSortByEnumStringValues Enumerates the set of values in String for ListOccCustomerGroupsSortByEnum
func GetListOccCustomerGroupsSortOrderEnumStringValues() []string
GetListOccCustomerGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListOccCustomerGroupsSortOrderEnum
func GetMetadataDetailsFormatVersionEnumStringValues() []string
GetMetadataDetailsFormatVersionEnumStringValues Enumerates the set of values in String for MetadataDetailsFormatVersionEnum
func GetNamespaceEnumStringValues() []string
GetNamespaceEnumStringValues Enumerates the set of values in String for NamespaceEnum
func GetOccAvailabilityCatalogCatalogStateEnumStringValues() []string
GetOccAvailabilityCatalogCatalogStateEnumStringValues Enumerates the set of values in String for OccAvailabilityCatalogCatalogStateEnum
func GetOccAvailabilityCatalogLifecycleStateEnumStringValues() []string
GetOccAvailabilityCatalogLifecycleStateEnumStringValues Enumerates the set of values in String for OccAvailabilityCatalogLifecycleStateEnum
func GetOccAvailabilitySummaryResourceTypeEnumStringValues() []string
GetOccAvailabilitySummaryResourceTypeEnumStringValues Enumerates the set of values in String for OccAvailabilitySummaryResourceTypeEnum
func GetOccAvailabilitySummaryWorkloadTypeEnumStringValues() []string
GetOccAvailabilitySummaryWorkloadTypeEnumStringValues Enumerates the set of values in String for OccAvailabilitySummaryWorkloadTypeEnum
func GetOccCapacityRequestBaseDetailsResourceTypeEnumStringValues() []string
GetOccCapacityRequestBaseDetailsResourceTypeEnumStringValues Enumerates the set of values in String for OccCapacityRequestBaseDetailsResourceTypeEnum
func GetOccCapacityRequestLifecycleStateEnumStringValues() []string
GetOccCapacityRequestLifecycleStateEnumStringValues Enumerates the set of values in String for OccCapacityRequestLifecycleStateEnum
func GetOccCapacityRequestRequestStateEnumStringValues() []string
GetOccCapacityRequestRequestStateEnumStringValues Enumerates the set of values in String for OccCapacityRequestRequestStateEnum
func GetOccCustomerGroupLifecycleStateEnumStringValues() []string
GetOccCustomerGroupLifecycleStateEnumStringValues Enumerates the set of values in String for OccCustomerGroupLifecycleStateEnum
func GetOccCustomerGroupStatusEnumStringValues() []string
GetOccCustomerGroupStatusEnumStringValues Enumerates the set of values in String for OccCustomerGroupStatusEnum
func GetOccCustomerStatusEnumStringValues() []string
GetOccCustomerStatusEnumStringValues Enumerates the set of values in String for OccCustomerStatusEnum
func GetPatchInsertInstructionPositionEnumStringValues() []string
GetPatchInsertInstructionPositionEnumStringValues Enumerates the set of values in String for PatchInsertInstructionPositionEnum
func GetPatchInsertMultipleInstructionPositionEnumStringValues() []string
GetPatchInsertMultipleInstructionPositionEnumStringValues Enumerates the set of values in String for PatchInsertMultipleInstructionPositionEnum
func GetPatchInstructionOperationEnumStringValues() []string
GetPatchInstructionOperationEnumStringValues Enumerates the set of values in String for PatchInstructionOperationEnum
func GetPatchMoveInstructionPositionEnumStringValues() []string
GetPatchMoveInstructionPositionEnumStringValues Enumerates the set of values in String for PatchMoveInstructionPositionEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetUpdateInternalOccCapacityRequestDetailsRequestStateEnumStringValues() []string
GetUpdateInternalOccCapacityRequestDetailsRequestStateEnumStringValues Enumerates the set of values in String for UpdateInternalOccCapacityRequestDetailsRequestStateEnum
func GetUpdateOccCapacityRequestDetailsRequestStateEnumStringValues() []string
GetUpdateOccCapacityRequestDetailsRequestStateEnumStringValues Enumerates the set of values in String for UpdateOccCapacityRequestDetailsRequestStateEnum
CapacityManagementClient a client for CapacityManagement
type CapacityManagementClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewCapacityManagementClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client CapacityManagementClient, err error)
NewCapacityManagementClientWithConfigurationProvider Creates a new default CapacityManagement client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewCapacityManagementClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client CapacityManagementClient, err error)
NewCapacityManagementClientWithOboToken Creates a new default CapacityManagement client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *CapacityManagementClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client CapacityManagementClient) CreateOccAvailabilityCatalog(ctx context.Context, request CreateOccAvailabilityCatalogRequest) (response CreateOccAvailabilityCatalogResponse, err error)
CreateOccAvailabilityCatalog Create availability catalog
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/CreateOccAvailabilityCatalog.go.html to see an example of how to use CreateOccAvailabilityCatalog API. A default retry strategy applies to this operation CreateOccAvailabilityCatalog()
func (client CapacityManagementClient) CreateOccCapacityRequest(ctx context.Context, request CreateOccCapacityRequestRequest) (response CreateOccCapacityRequestResponse, err error)
CreateOccCapacityRequest Create Capacity Request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/CreateOccCapacityRequest.go.html to see an example of how to use CreateOccCapacityRequest API. A default retry strategy applies to this operation CreateOccCapacityRequest()
func (client CapacityManagementClient) DeleteOccAvailabilityCatalog(ctx context.Context, request DeleteOccAvailabilityCatalogRequest) (response DeleteOccAvailabilityCatalogResponse, err error)
DeleteOccAvailabilityCatalog Deletes the availability catalog resource.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/DeleteOccAvailabilityCatalog.go.html to see an example of how to use DeleteOccAvailabilityCatalog API. A default retry strategy applies to this operation DeleteOccAvailabilityCatalog()
func (client CapacityManagementClient) DeleteOccCapacityRequest(ctx context.Context, request DeleteOccCapacityRequestRequest) (response DeleteOccCapacityRequestResponse, err error)
DeleteOccCapacityRequest Deletes the capacity request resource.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/DeleteOccCapacityRequest.go.html to see an example of how to use DeleteOccCapacityRequest API. A default retry strategy applies to this operation DeleteOccCapacityRequest()
func (client CapacityManagementClient) GetOccAvailabilityCatalog(ctx context.Context, request GetOccAvailabilityCatalogRequest) (response GetOccAvailabilityCatalogResponse, err error)
GetOccAvailabilityCatalog Get details about availability catalog.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/GetOccAvailabilityCatalog.go.html to see an example of how to use GetOccAvailabilityCatalog API. A default retry strategy applies to this operation GetOccAvailabilityCatalog()
func (client CapacityManagementClient) GetOccAvailabilityCatalogContent(ctx context.Context, request GetOccAvailabilityCatalogContentRequest) (response GetOccAvailabilityCatalogContentResponse, err error)
GetOccAvailabilityCatalogContent Returns the binary contents of the availability catalog. Can be saved as a csv file.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/GetOccAvailabilityCatalogContent.go.html to see an example of how to use GetOccAvailabilityCatalogContent API. A default retry strategy applies to this operation GetOccAvailabilityCatalogContent()
func (client CapacityManagementClient) GetOccCapacityRequest(ctx context.Context, request GetOccCapacityRequestRequest) (response GetOccCapacityRequestResponse, err error)
GetOccCapacityRequest Get details about the capacity request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/GetOccCapacityRequest.go.html to see an example of how to use GetOccCapacityRequest API. A default retry strategy applies to this operation GetOccCapacityRequest()
func (client CapacityManagementClient) GetOccCustomerGroup(ctx context.Context, request GetOccCustomerGroupRequest) (response GetOccCustomerGroupResponse, err error)
GetOccCustomerGroup Gets information about the specified customer group.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/GetOccCustomerGroup.go.html to see an example of how to use GetOccCustomerGroup API. A default retry strategy applies to this operation GetOccCustomerGroup()
func (client CapacityManagementClient) ListOccAvailabilities(ctx context.Context, request ListOccAvailabilitiesRequest) (response ListOccAvailabilitiesResponse, err error)
ListOccAvailabilities Lists availabilities for a particular availability catalog.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccAvailabilities.go.html to see an example of how to use ListOccAvailabilities API. A default retry strategy applies to this operation ListOccAvailabilities()
func (client CapacityManagementClient) ListOccAvailabilityCatalogs(ctx context.Context, request ListOccAvailabilityCatalogsRequest) (response ListOccAvailabilityCatalogsResponse, err error)
ListOccAvailabilityCatalogs Lists all availability catalogs.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccAvailabilityCatalogs.go.html to see an example of how to use ListOccAvailabilityCatalogs API. A default retry strategy applies to this operation ListOccAvailabilityCatalogs()
func (client CapacityManagementClient) ListOccAvailabilityCatalogsInternal(ctx context.Context, request ListOccAvailabilityCatalogsInternalRequest) (response ListOccAvailabilityCatalogsInternalResponse, err error)
ListOccAvailabilityCatalogsInternal An internal api to list availability catalogs.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccAvailabilityCatalogsInternal.go.html to see an example of how to use ListOccAvailabilityCatalogsInternal API. A default retry strategy applies to this operation ListOccAvailabilityCatalogsInternal()
func (client CapacityManagementClient) ListOccCapacityRequests(ctx context.Context, request ListOccCapacityRequestsRequest) (response ListOccCapacityRequestsResponse, err error)
ListOccCapacityRequests Lists all capacity requests.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccCapacityRequests.go.html to see an example of how to use ListOccCapacityRequests API. A default retry strategy applies to this operation ListOccCapacityRequests()
func (client CapacityManagementClient) ListOccCapacityRequestsInternal(ctx context.Context, request ListOccCapacityRequestsInternalRequest) (response ListOccCapacityRequestsInternalResponse, err error)
ListOccCapacityRequestsInternal An internal api to list all capacity requests.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccCapacityRequestsInternal.go.html to see an example of how to use ListOccCapacityRequestsInternal API. A default retry strategy applies to this operation ListOccCapacityRequestsInternal()
func (client CapacityManagementClient) ListOccCustomerGroups(ctx context.Context, request ListOccCustomerGroupsRequest) (response ListOccCustomerGroupsResponse, err error)
ListOccCustomerGroups Lists all the customer groups.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccCustomerGroups.go.html to see an example of how to use ListOccCustomerGroups API. A default retry strategy applies to this operation ListOccCustomerGroups()
func (client CapacityManagementClient) PatchOccCapacityRequest(ctx context.Context, request PatchOccCapacityRequestRequest) (response PatchOccCapacityRequestResponse, err error)
PatchOccCapacityRequest Updates the OccCapacityRequest by evaluating a sequence of instructions.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/PatchOccCapacityRequest.go.html to see an example of how to use PatchOccCapacityRequest API. A default retry strategy applies to this operation PatchOccCapacityRequest()
func (client CapacityManagementClient) PublishOccAvailabilityCatalog(ctx context.Context, request PublishOccAvailabilityCatalogRequest) (response PublishOccAvailabilityCatalogResponse, err error)
PublishOccAvailabilityCatalog Publishes the version of availability catalog specified by the operator. This makes that catalog version visible to customers.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/PublishOccAvailabilityCatalog.go.html to see an example of how to use PublishOccAvailabilityCatalog API. A default retry strategy applies to this operation PublishOccAvailabilityCatalog()
func (client *CapacityManagementClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client CapacityManagementClient) UpdateInternalOccCapacityRequest(ctx context.Context, request UpdateInternalOccCapacityRequestRequest) (response UpdateInternalOccCapacityRequestResponse, err error)
UpdateInternalOccCapacityRequest The internal api to update the capacity request. This api will be used by operators for updating the capacity request to either completed, resubmitted or rejected.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/UpdateInternalOccCapacityRequest.go.html to see an example of how to use UpdateInternalOccCapacityRequest API. A default retry strategy applies to this operation UpdateInternalOccCapacityRequest()
func (client CapacityManagementClient) UpdateOccAvailabilityCatalog(ctx context.Context, request UpdateOccAvailabilityCatalogRequest) (response UpdateOccAvailabilityCatalogResponse, err error)
UpdateOccAvailabilityCatalog The request to update the availability catalog. Currently only freeform tags can be updated via this api.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/UpdateOccAvailabilityCatalog.go.html to see an example of how to use UpdateOccAvailabilityCatalog API. A default retry strategy applies to this operation UpdateOccAvailabilityCatalog()
func (client CapacityManagementClient) UpdateOccCapacityRequest(ctx context.Context, request UpdateOccCapacityRequestRequest) (response UpdateOccCapacityRequestResponse, err error)
UpdateOccCapacityRequest The request to update the capacity request. The user can perform actions like closing a partially completed request so that it doesn't go ahead for full completion.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/UpdateOccCapacityRequest.go.html to see an example of how to use UpdateOccCapacityRequest API. A default retry strategy applies to this operation UpdateOccCapacityRequest()
CreateOccAvailabilityCatalogDetails Details about the create request for the availability catalog.
type CreateOccAvailabilityCatalogDetails struct {
// The OCID of the customer group.
OccCustomerGroupId *string `mandatory:"true" json:"occCustomerGroupId"`
// The name of the OCI service in consideration. For example, Compute, Exadata, and so on.
Namespace NamespaceEnum `mandatory:"true" json:"namespace"`
// Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The base 64 encoded string corresponding to the catalog file contents.
Base64EncodedCatalogDetails *string `mandatory:"true" json:"base64EncodedCatalogDetails"`
// The display name of the availability catalog.
DisplayName *string `mandatory:"true" json:"displayName"`
MetadataDetails *MetadataDetails `mandatory:"false" json:"metadataDetails"`
// Additional information about the availability catalog.
Description *string `mandatory:"false" json:"description"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateOccAvailabilityCatalogDetails) String() string
func (m CreateOccAvailabilityCatalogDetails) 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
CreateOccAvailabilityCatalogRequest wrapper for the CreateOccAvailabilityCatalog operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/CreateOccAvailabilityCatalog.go.html to see an example of how to use CreateOccAvailabilityCatalogRequest.
type CreateOccAvailabilityCatalogRequest struct {
// The request details for creating an availability catalog.
CreateOccAvailabilityCatalogDetails `contributesTo:"body"`
// 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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateOccAvailabilityCatalogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOccAvailabilityCatalogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOccAvailabilityCatalogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOccAvailabilityCatalogRequest) String() string
func (request CreateOccAvailabilityCatalogRequest) 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
CreateOccAvailabilityCatalogResponse wrapper for the CreateOccAvailabilityCatalog operation
type CreateOccAvailabilityCatalogResponse struct {
// The underlying http response
RawResponse *http.Response
// The OccAvailabilityCatalog instance
OccAvailabilityCatalog `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response CreateOccAvailabilityCatalogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOccAvailabilityCatalogResponse) String() string
CreateOccCapacityRequestDetails Details about the create request for the capacity request.
type CreateOccCapacityRequestDetails struct {
// Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the availability catalog against which capacity request is made.
OccAvailabilityCatalogId *string `mandatory:"true" json:"occAvailabilityCatalogId"`
// The name of the OCI service in consideration. For example, Compute, Exadata, and so on.
Namespace NamespaceEnum `mandatory:"true" json:"namespace"`
// The name of the region for which the capacity request is made.
Region *string `mandatory:"true" json:"region"`
// An user-friendly name for the capacity request. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The availability domain (AD) for which the capacity request is made. If this is specified then the capacity will be validated and fulfilled within the scope of this AD.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.
DateExpectedCapacityHandover *common.SDKTime `mandatory:"true" json:"dateExpectedCapacityHandover"`
// A list of different resources requested by the user.
Details []OccCapacityRequestBaseDetails `mandatory:"true" json:"details"`
// Meaningful text about the capacity request.
Description *string `mandatory:"false" json:"description"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The subset of request states available for creating the capacity request.
RequestState CreateOccCapacityRequestDetailsRequestStateEnum `mandatory:"false" json:"requestState,omitempty"`
}
func (m CreateOccCapacityRequestDetails) String() string
func (m *CreateOccCapacityRequestDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateOccCapacityRequestDetails) 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
CreateOccCapacityRequestDetailsRequestStateEnum Enum with underlying type: string
type CreateOccCapacityRequestDetailsRequestStateEnum string
Set of constants representing the allowable values for CreateOccCapacityRequestDetailsRequestStateEnum
const (
CreateOccCapacityRequestDetailsRequestStateCreated CreateOccCapacityRequestDetailsRequestStateEnum = "CREATED"
CreateOccCapacityRequestDetailsRequestStateSubmitted CreateOccCapacityRequestDetailsRequestStateEnum = "SUBMITTED"
)
func GetCreateOccCapacityRequestDetailsRequestStateEnumValues() []CreateOccCapacityRequestDetailsRequestStateEnum
GetCreateOccCapacityRequestDetailsRequestStateEnumValues Enumerates the set of values for CreateOccCapacityRequestDetailsRequestStateEnum
func GetMappingCreateOccCapacityRequestDetailsRequestStateEnum(val string) (CreateOccCapacityRequestDetailsRequestStateEnum, bool)
GetMappingCreateOccCapacityRequestDetailsRequestStateEnum performs case Insensitive comparison on enum value and return the desired enum
CreateOccCapacityRequestRequest wrapper for the CreateOccCapacityRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/CreateOccCapacityRequest.go.html to see an example of how to use CreateOccCapacityRequestRequest.
type CreateOccCapacityRequestRequest struct {
// The request details for creating a capacity request.
CreateOccCapacityRequestDetails `contributesTo:"body"`
// 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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateOccCapacityRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOccCapacityRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOccCapacityRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOccCapacityRequestRequest) String() string
func (request CreateOccCapacityRequestRequest) 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
CreateOccCapacityRequestResponse wrapper for the CreateOccCapacityRequest operation
type CreateOccCapacityRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The OccCapacityRequest instance
OccCapacityRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response CreateOccCapacityRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOccCapacityRequestResponse) String() string
DeleteOccAvailabilityCatalogRequest wrapper for the DeleteOccAvailabilityCatalog operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/DeleteOccAvailabilityCatalog.go.html to see an example of how to use DeleteOccAvailabilityCatalogRequest.
type DeleteOccAvailabilityCatalogRequest struct {
// The OCID of the availability catalog.
OccAvailabilityCatalogId *string `mandatory:"true" contributesTo:"path" name:"occAvailabilityCatalogId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteOccAvailabilityCatalogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOccAvailabilityCatalogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOccAvailabilityCatalogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOccAvailabilityCatalogRequest) String() string
func (request DeleteOccAvailabilityCatalogRequest) 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
DeleteOccAvailabilityCatalogResponse wrapper for the DeleteOccAvailabilityCatalog operation
type DeleteOccAvailabilityCatalogResponse 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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response DeleteOccAvailabilityCatalogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOccAvailabilityCatalogResponse) String() string
DeleteOccCapacityRequestRequest wrapper for the DeleteOccCapacityRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/DeleteOccCapacityRequest.go.html to see an example of how to use DeleteOccCapacityRequestRequest.
type DeleteOccCapacityRequestRequest struct {
// The OCID of the capacity request.
OccCapacityRequestId *string `mandatory:"true" contributesTo:"path" name:"occCapacityRequestId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteOccCapacityRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOccCapacityRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOccCapacityRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOccCapacityRequestRequest) String() string
func (request DeleteOccCapacityRequestRequest) 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
DeleteOccCapacityRequestResponse wrapper for the DeleteOccCapacityRequest operation
type DeleteOccCapacityRequestResponse 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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response DeleteOccCapacityRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOccCapacityRequestResponse) String() string
GetOccAvailabilityCatalogContentRequest wrapper for the GetOccAvailabilityCatalogContent operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/GetOccAvailabilityCatalogContent.go.html to see an example of how to use GetOccAvailabilityCatalogContentRequest.
type GetOccAvailabilityCatalogContentRequest struct {
// The OCID of the availability catalog.
OccAvailabilityCatalogId *string `mandatory:"true" contributesTo:"path" name:"occAvailabilityCatalogId"`
// 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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetOccAvailabilityCatalogContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOccAvailabilityCatalogContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOccAvailabilityCatalogContentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOccAvailabilityCatalogContentRequest) String() string
func (request GetOccAvailabilityCatalogContentRequest) 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
GetOccAvailabilityCatalogContentResponse wrapper for the GetOccAvailabilityCatalogContent operation
type GetOccAvailabilityCatalogContentResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetOccAvailabilityCatalogContentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOccAvailabilityCatalogContentResponse) String() string
GetOccAvailabilityCatalogRequest wrapper for the GetOccAvailabilityCatalog operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/GetOccAvailabilityCatalog.go.html to see an example of how to use GetOccAvailabilityCatalogRequest.
type GetOccAvailabilityCatalogRequest struct {
// The OCID of the availability catalog.
OccAvailabilityCatalogId *string `mandatory:"true" contributesTo:"path" name:"occAvailabilityCatalogId"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetOccAvailabilityCatalogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOccAvailabilityCatalogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOccAvailabilityCatalogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOccAvailabilityCatalogRequest) String() string
func (request GetOccAvailabilityCatalogRequest) 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
GetOccAvailabilityCatalogResponse wrapper for the GetOccAvailabilityCatalog operation
type GetOccAvailabilityCatalogResponse struct {
// The underlying http response
RawResponse *http.Response
// The OccAvailabilityCatalog instance
OccAvailabilityCatalog `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetOccAvailabilityCatalogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOccAvailabilityCatalogResponse) String() string
GetOccCapacityRequestRequest wrapper for the GetOccCapacityRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/GetOccCapacityRequest.go.html to see an example of how to use GetOccCapacityRequestRequest.
type GetOccCapacityRequestRequest struct {
// The OCID of the capacity request.
OccCapacityRequestId *string `mandatory:"true" contributesTo:"path" name:"occCapacityRequestId"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetOccCapacityRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOccCapacityRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOccCapacityRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOccCapacityRequestRequest) String() string
func (request GetOccCapacityRequestRequest) 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
GetOccCapacityRequestResponse wrapper for the GetOccCapacityRequest operation
type GetOccCapacityRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The OccCapacityRequest instance
OccCapacityRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetOccCapacityRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOccCapacityRequestResponse) String() string
GetOccCustomerGroupRequest wrapper for the GetOccCustomerGroup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/GetOccCustomerGroup.go.html to see an example of how to use GetOccCustomerGroupRequest.
type GetOccCustomerGroupRequest struct {
// The OCID of the customer group.
OccCustomerGroupId *string `mandatory:"true" contributesTo:"path" name:"occCustomerGroupId"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetOccCustomerGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOccCustomerGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOccCustomerGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOccCustomerGroupRequest) String() string
func (request GetOccCustomerGroupRequest) 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
GetOccCustomerGroupResponse wrapper for the GetOccCustomerGroup operation
type GetOccCustomerGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// The OccCustomerGroup instance
OccCustomerGroup `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetOccCustomerGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOccCustomerGroupResponse) String() string
ListOccAvailabilitiesRequest wrapper for the ListOccAvailabilities operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccAvailabilities.go.html to see an example of how to use ListOccAvailabilitiesRequest.
type ListOccAvailabilitiesRequest struct {
// The OCID of the availability catalog.
OccAvailabilityCatalogId *string `mandatory:"true" contributesTo:"path" name:"occAvailabilityCatalogId"`
// The capacity handover date of the capacity constraint to filter the list of capacity constraints.
DateExpectedCapacityHandover *string `mandatory:"false" contributesTo:"query" name:"dateExpectedCapacityHandover"`
// The name of the resource to filter the list of capacity constraints.
ResourceName *string `mandatory:"false" contributesTo:"query" name:"resourceName"`
// Resource type using which the capacity constraints of an availability catalog can be filtered.
ResourceType OccAvailabilitySummaryResourceTypeEnum `mandatory:"false" contributesTo:"query" name:"resourceType" omitEmpty:"true"`
// Workload type using the resources in an availability catalog can be filtered.
WorkloadType OccAvailabilitySummaryWorkloadTypeEnum `mandatory:"false" contributesTo:"query" name:"workloadType" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListOccAvailabilitiesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. The default order for resource name is ascending. The default order for date of capacity handover is descending.
SortBy ListOccAvailabilitiesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOccAvailabilitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOccAvailabilitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOccAvailabilitiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOccAvailabilitiesRequest) String() string
func (request ListOccAvailabilitiesRequest) 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
ListOccAvailabilitiesResponse wrapper for the ListOccAvailabilities operation
type ListOccAvailabilitiesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OccAvailabilityCollection instances
OccAvailabilityCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListOccAvailabilitiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOccAvailabilitiesResponse) String() string
ListOccAvailabilitiesSortByEnum Enum with underlying type: string
type ListOccAvailabilitiesSortByEnum string
Set of constants representing the allowable values for ListOccAvailabilitiesSortByEnum
const (
ListOccAvailabilitiesSortByDateexpectedcapacityhandover ListOccAvailabilitiesSortByEnum = "dateExpectedCapacityHandover"
ListOccAvailabilitiesSortByResourcename ListOccAvailabilitiesSortByEnum = "resourceName"
)
func GetListOccAvailabilitiesSortByEnumValues() []ListOccAvailabilitiesSortByEnum
GetListOccAvailabilitiesSortByEnumValues Enumerates the set of values for ListOccAvailabilitiesSortByEnum
func GetMappingListOccAvailabilitiesSortByEnum(val string) (ListOccAvailabilitiesSortByEnum, bool)
GetMappingListOccAvailabilitiesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccAvailabilitiesSortOrderEnum Enum with underlying type: string
type ListOccAvailabilitiesSortOrderEnum string
Set of constants representing the allowable values for ListOccAvailabilitiesSortOrderEnum
const (
ListOccAvailabilitiesSortOrderAsc ListOccAvailabilitiesSortOrderEnum = "ASC"
ListOccAvailabilitiesSortOrderDesc ListOccAvailabilitiesSortOrderEnum = "DESC"
)
func GetListOccAvailabilitiesSortOrderEnumValues() []ListOccAvailabilitiesSortOrderEnum
GetListOccAvailabilitiesSortOrderEnumValues Enumerates the set of values for ListOccAvailabilitiesSortOrderEnum
func GetMappingListOccAvailabilitiesSortOrderEnum(val string) (ListOccAvailabilitiesSortOrderEnum, bool)
GetMappingListOccAvailabilitiesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccAvailabilityCatalogsInternalNamespaceEnum Enum with underlying type: string
type ListOccAvailabilityCatalogsInternalNamespaceEnum string
Set of constants representing the allowable values for ListOccAvailabilityCatalogsInternalNamespaceEnum
const (
ListOccAvailabilityCatalogsInternalNamespaceCompute ListOccAvailabilityCatalogsInternalNamespaceEnum = "COMPUTE"
)
func GetListOccAvailabilityCatalogsInternalNamespaceEnumValues() []ListOccAvailabilityCatalogsInternalNamespaceEnum
GetListOccAvailabilityCatalogsInternalNamespaceEnumValues Enumerates the set of values for ListOccAvailabilityCatalogsInternalNamespaceEnum
func GetMappingListOccAvailabilityCatalogsInternalNamespaceEnum(val string) (ListOccAvailabilityCatalogsInternalNamespaceEnum, bool)
GetMappingListOccAvailabilityCatalogsInternalNamespaceEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccAvailabilityCatalogsInternalRequest wrapper for the ListOccAvailabilityCatalogsInternal operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccAvailabilityCatalogsInternal.go.html to see an example of how to use ListOccAvailabilityCatalogsInternalRequest.
type ListOccAvailabilityCatalogsInternalRequest struct {
// The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The namespace by which we would filter the list.
Namespace ListOccAvailabilityCatalogsInternalNamespaceEnum `mandatory:"false" contributesTo:"query" name:"namespace" omitEmpty:"true"`
// The OCID of the availability catalog to filter the list of availability catalogs.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only the resources that match the entire display name. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter the list of availability catalogs based on the catalog state.
CatalogState OccAvailabilityCatalogCatalogStateEnum `mandatory:"false" contributesTo:"query" name:"catalogState" omitEmpty:"true"`
// The customer group ocid by which we would filter the list.
OccCustomerGroupId *string `mandatory:"false" contributesTo:"query" name:"occCustomerGroupId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListOccAvailabilityCatalogsInternalSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. The default order for displayName is ascending. The default order for timeCreated is descending.
SortBy ListOccAvailabilityCatalogsInternalSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOccAvailabilityCatalogsInternalRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOccAvailabilityCatalogsInternalRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOccAvailabilityCatalogsInternalRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOccAvailabilityCatalogsInternalRequest) String() string
func (request ListOccAvailabilityCatalogsInternalRequest) 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
ListOccAvailabilityCatalogsInternalResponse wrapper for the ListOccAvailabilityCatalogsInternal operation
type ListOccAvailabilityCatalogsInternalResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OccAvailabilityCatalogCollection instances
OccAvailabilityCatalogCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListOccAvailabilityCatalogsInternalResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOccAvailabilityCatalogsInternalResponse) String() string
ListOccAvailabilityCatalogsInternalSortByEnum Enum with underlying type: string
type ListOccAvailabilityCatalogsInternalSortByEnum string
Set of constants representing the allowable values for ListOccAvailabilityCatalogsInternalSortByEnum
const (
ListOccAvailabilityCatalogsInternalSortByDisplayname ListOccAvailabilityCatalogsInternalSortByEnum = "displayName"
ListOccAvailabilityCatalogsInternalSortByTimecreated ListOccAvailabilityCatalogsInternalSortByEnum = "timeCreated"
)
func GetListOccAvailabilityCatalogsInternalSortByEnumValues() []ListOccAvailabilityCatalogsInternalSortByEnum
GetListOccAvailabilityCatalogsInternalSortByEnumValues Enumerates the set of values for ListOccAvailabilityCatalogsInternalSortByEnum
func GetMappingListOccAvailabilityCatalogsInternalSortByEnum(val string) (ListOccAvailabilityCatalogsInternalSortByEnum, bool)
GetMappingListOccAvailabilityCatalogsInternalSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccAvailabilityCatalogsInternalSortOrderEnum Enum with underlying type: string
type ListOccAvailabilityCatalogsInternalSortOrderEnum string
Set of constants representing the allowable values for ListOccAvailabilityCatalogsInternalSortOrderEnum
const (
ListOccAvailabilityCatalogsInternalSortOrderAsc ListOccAvailabilityCatalogsInternalSortOrderEnum = "ASC"
ListOccAvailabilityCatalogsInternalSortOrderDesc ListOccAvailabilityCatalogsInternalSortOrderEnum = "DESC"
)
func GetListOccAvailabilityCatalogsInternalSortOrderEnumValues() []ListOccAvailabilityCatalogsInternalSortOrderEnum
GetListOccAvailabilityCatalogsInternalSortOrderEnumValues Enumerates the set of values for ListOccAvailabilityCatalogsInternalSortOrderEnum
func GetMappingListOccAvailabilityCatalogsInternalSortOrderEnum(val string) (ListOccAvailabilityCatalogsInternalSortOrderEnum, bool)
GetMappingListOccAvailabilityCatalogsInternalSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccAvailabilityCatalogsNamespaceEnum Enum with underlying type: string
type ListOccAvailabilityCatalogsNamespaceEnum string
Set of constants representing the allowable values for ListOccAvailabilityCatalogsNamespaceEnum
const (
ListOccAvailabilityCatalogsNamespaceCompute ListOccAvailabilityCatalogsNamespaceEnum = "COMPUTE"
)
func GetListOccAvailabilityCatalogsNamespaceEnumValues() []ListOccAvailabilityCatalogsNamespaceEnum
GetListOccAvailabilityCatalogsNamespaceEnumValues Enumerates the set of values for ListOccAvailabilityCatalogsNamespaceEnum
func GetMappingListOccAvailabilityCatalogsNamespaceEnum(val string) (ListOccAvailabilityCatalogsNamespaceEnum, bool)
GetMappingListOccAvailabilityCatalogsNamespaceEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccAvailabilityCatalogsRequest wrapper for the ListOccAvailabilityCatalogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccAvailabilityCatalogs.go.html to see an example of how to use ListOccAvailabilityCatalogsRequest.
type ListOccAvailabilityCatalogsRequest struct {
// The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The namespace by which we would filter the list.
Namespace ListOccAvailabilityCatalogsNamespaceEnum `mandatory:"false" contributesTo:"query" name:"namespace" omitEmpty:"true"`
// The OCID of the availability catalog to filter the list of availability catalogs.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only the resources that match the entire display name. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter the list of availability catalogs based on the catalog state.
CatalogState OccAvailabilityCatalogCatalogStateEnum `mandatory:"false" contributesTo:"query" name:"catalogState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListOccAvailabilityCatalogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. The default order for displayName is ascending. The default order for timeCreated is descending.
SortBy ListOccAvailabilityCatalogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOccAvailabilityCatalogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOccAvailabilityCatalogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOccAvailabilityCatalogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOccAvailabilityCatalogsRequest) String() string
func (request ListOccAvailabilityCatalogsRequest) 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
ListOccAvailabilityCatalogsResponse wrapper for the ListOccAvailabilityCatalogs operation
type ListOccAvailabilityCatalogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OccAvailabilityCatalogCollection instances
OccAvailabilityCatalogCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListOccAvailabilityCatalogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOccAvailabilityCatalogsResponse) String() string
ListOccAvailabilityCatalogsSortByEnum Enum with underlying type: string
type ListOccAvailabilityCatalogsSortByEnum string
Set of constants representing the allowable values for ListOccAvailabilityCatalogsSortByEnum
const (
ListOccAvailabilityCatalogsSortByDisplayname ListOccAvailabilityCatalogsSortByEnum = "displayName"
ListOccAvailabilityCatalogsSortByTimecreated ListOccAvailabilityCatalogsSortByEnum = "timeCreated"
)
func GetListOccAvailabilityCatalogsSortByEnumValues() []ListOccAvailabilityCatalogsSortByEnum
GetListOccAvailabilityCatalogsSortByEnumValues Enumerates the set of values for ListOccAvailabilityCatalogsSortByEnum
func GetMappingListOccAvailabilityCatalogsSortByEnum(val string) (ListOccAvailabilityCatalogsSortByEnum, bool)
GetMappingListOccAvailabilityCatalogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccAvailabilityCatalogsSortOrderEnum Enum with underlying type: string
type ListOccAvailabilityCatalogsSortOrderEnum string
Set of constants representing the allowable values for ListOccAvailabilityCatalogsSortOrderEnum
const (
ListOccAvailabilityCatalogsSortOrderAsc ListOccAvailabilityCatalogsSortOrderEnum = "ASC"
ListOccAvailabilityCatalogsSortOrderDesc ListOccAvailabilityCatalogsSortOrderEnum = "DESC"
)
func GetListOccAvailabilityCatalogsSortOrderEnumValues() []ListOccAvailabilityCatalogsSortOrderEnum
GetListOccAvailabilityCatalogsSortOrderEnumValues Enumerates the set of values for ListOccAvailabilityCatalogsSortOrderEnum
func GetMappingListOccAvailabilityCatalogsSortOrderEnum(val string) (ListOccAvailabilityCatalogsSortOrderEnum, bool)
GetMappingListOccAvailabilityCatalogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccCapacityRequestsInternalNamespaceEnum Enum with underlying type: string
type ListOccCapacityRequestsInternalNamespaceEnum string
Set of constants representing the allowable values for ListOccCapacityRequestsInternalNamespaceEnum
const (
ListOccCapacityRequestsInternalNamespaceCompute ListOccCapacityRequestsInternalNamespaceEnum = "COMPUTE"
)
func GetListOccCapacityRequestsInternalNamespaceEnumValues() []ListOccCapacityRequestsInternalNamespaceEnum
GetListOccCapacityRequestsInternalNamespaceEnumValues Enumerates the set of values for ListOccCapacityRequestsInternalNamespaceEnum
func GetMappingListOccCapacityRequestsInternalNamespaceEnum(val string) (ListOccCapacityRequestsInternalNamespaceEnum, bool)
GetMappingListOccCapacityRequestsInternalNamespaceEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccCapacityRequestsInternalRequest wrapper for the ListOccCapacityRequestsInternal operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccCapacityRequestsInternal.go.html to see an example of how to use ListOccCapacityRequestsInternalRequest.
type ListOccCapacityRequestsInternalRequest struct {
// The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The customer group ocid by which we would filter the list.
OccCustomerGroupId *string `mandatory:"false" contributesTo:"query" name:"occCustomerGroupId"`
// A filter to return the list of capacity requests based on the OCID of the availability catalog against which they were created.
OccAvailabilityCatalogId *string `mandatory:"false" contributesTo:"query" name:"occAvailabilityCatalogId"`
// The namespace by which we would filter the list.
Namespace ListOccCapacityRequestsInternalNamespaceEnum `mandatory:"false" contributesTo:"query" name:"namespace" omitEmpty:"true"`
// A filter to return only the resources that match the entire display name. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return the list of capacity requests based on the OCID of the capacity request. This is done for the users who have INSPECT permission on the resource but do not have READ permission.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListOccCapacityRequestsInternalSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. The default order for display name is ascending. The default order for time created is reverse chronological order(latest date at the top).
SortBy ListOccCapacityRequestsInternalSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOccCapacityRequestsInternalRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOccCapacityRequestsInternalRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOccCapacityRequestsInternalRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOccCapacityRequestsInternalRequest) String() string
func (request ListOccCapacityRequestsInternalRequest) 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
ListOccCapacityRequestsInternalResponse wrapper for the ListOccCapacityRequestsInternal operation
type ListOccCapacityRequestsInternalResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OccCapacityRequestCollection instances
OccCapacityRequestCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListOccCapacityRequestsInternalResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOccCapacityRequestsInternalResponse) String() string
ListOccCapacityRequestsInternalSortByEnum Enum with underlying type: string
type ListOccCapacityRequestsInternalSortByEnum string
Set of constants representing the allowable values for ListOccCapacityRequestsInternalSortByEnum
const (
ListOccCapacityRequestsInternalSortByDisplayname ListOccCapacityRequestsInternalSortByEnum = "displayName"
ListOccCapacityRequestsInternalSortByTimecreated ListOccCapacityRequestsInternalSortByEnum = "timeCreated"
)
func GetListOccCapacityRequestsInternalSortByEnumValues() []ListOccCapacityRequestsInternalSortByEnum
GetListOccCapacityRequestsInternalSortByEnumValues Enumerates the set of values for ListOccCapacityRequestsInternalSortByEnum
func GetMappingListOccCapacityRequestsInternalSortByEnum(val string) (ListOccCapacityRequestsInternalSortByEnum, bool)
GetMappingListOccCapacityRequestsInternalSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccCapacityRequestsInternalSortOrderEnum Enum with underlying type: string
type ListOccCapacityRequestsInternalSortOrderEnum string
Set of constants representing the allowable values for ListOccCapacityRequestsInternalSortOrderEnum
const (
ListOccCapacityRequestsInternalSortOrderAsc ListOccCapacityRequestsInternalSortOrderEnum = "ASC"
ListOccCapacityRequestsInternalSortOrderDesc ListOccCapacityRequestsInternalSortOrderEnum = "DESC"
)
func GetListOccCapacityRequestsInternalSortOrderEnumValues() []ListOccCapacityRequestsInternalSortOrderEnum
GetListOccCapacityRequestsInternalSortOrderEnumValues Enumerates the set of values for ListOccCapacityRequestsInternalSortOrderEnum
func GetMappingListOccCapacityRequestsInternalSortOrderEnum(val string) (ListOccCapacityRequestsInternalSortOrderEnum, bool)
GetMappingListOccCapacityRequestsInternalSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccCapacityRequestsNamespaceEnum Enum with underlying type: string
type ListOccCapacityRequestsNamespaceEnum string
Set of constants representing the allowable values for ListOccCapacityRequestsNamespaceEnum
const (
ListOccCapacityRequestsNamespaceCompute ListOccCapacityRequestsNamespaceEnum = "COMPUTE"
)
func GetListOccCapacityRequestsNamespaceEnumValues() []ListOccCapacityRequestsNamespaceEnum
GetListOccCapacityRequestsNamespaceEnumValues Enumerates the set of values for ListOccCapacityRequestsNamespaceEnum
func GetMappingListOccCapacityRequestsNamespaceEnum(val string) (ListOccCapacityRequestsNamespaceEnum, bool)
GetMappingListOccCapacityRequestsNamespaceEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccCapacityRequestsRequest wrapper for the ListOccCapacityRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccCapacityRequests.go.html to see an example of how to use ListOccCapacityRequestsRequest.
type ListOccCapacityRequestsRequest struct {
// The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return the list of capacity requests based on the OCID of the availability catalog against which they were created.
OccAvailabilityCatalogId *string `mandatory:"false" contributesTo:"query" name:"occAvailabilityCatalogId"`
// The namespace by which we would filter the list.
Namespace ListOccCapacityRequestsNamespaceEnum `mandatory:"false" contributesTo:"query" name:"namespace" omitEmpty:"true"`
// A filter to return only the resources that match the entire display name. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return the list of capacity requests based on the OCID of the capacity request. This is done for the users who have INSPECT permission on the resource but do not have READ permission.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListOccCapacityRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. The default order for display name is ascending. The default order for time created is reverse chronological order(latest date at the top).
SortBy ListOccCapacityRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOccCapacityRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOccCapacityRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOccCapacityRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOccCapacityRequestsRequest) String() string
func (request ListOccCapacityRequestsRequest) 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
ListOccCapacityRequestsResponse wrapper for the ListOccCapacityRequests operation
type ListOccCapacityRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OccCapacityRequestCollection instances
OccCapacityRequestCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListOccCapacityRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOccCapacityRequestsResponse) String() string
ListOccCapacityRequestsSortByEnum Enum with underlying type: string
type ListOccCapacityRequestsSortByEnum string
Set of constants representing the allowable values for ListOccCapacityRequestsSortByEnum
const (
ListOccCapacityRequestsSortByDisplayname ListOccCapacityRequestsSortByEnum = "displayName"
ListOccCapacityRequestsSortByTimecreated ListOccCapacityRequestsSortByEnum = "timeCreated"
)
func GetListOccCapacityRequestsSortByEnumValues() []ListOccCapacityRequestsSortByEnum
GetListOccCapacityRequestsSortByEnumValues Enumerates the set of values for ListOccCapacityRequestsSortByEnum
func GetMappingListOccCapacityRequestsSortByEnum(val string) (ListOccCapacityRequestsSortByEnum, bool)
GetMappingListOccCapacityRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccCapacityRequestsSortOrderEnum Enum with underlying type: string
type ListOccCapacityRequestsSortOrderEnum string
Set of constants representing the allowable values for ListOccCapacityRequestsSortOrderEnum
const (
ListOccCapacityRequestsSortOrderAsc ListOccCapacityRequestsSortOrderEnum = "ASC"
ListOccCapacityRequestsSortOrderDesc ListOccCapacityRequestsSortOrderEnum = "DESC"
)
func GetListOccCapacityRequestsSortOrderEnumValues() []ListOccCapacityRequestsSortOrderEnum
GetListOccCapacityRequestsSortOrderEnumValues Enumerates the set of values for ListOccCapacityRequestsSortOrderEnum
func GetMappingListOccCapacityRequestsSortOrderEnum(val string) (ListOccCapacityRequestsSortOrderEnum, bool)
GetMappingListOccCapacityRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccCustomerGroupsRequest wrapper for the ListOccCustomerGroups operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/ListOccCustomerGroups.go.html to see an example of how to use ListOccCustomerGroupsRequest.
type ListOccCustomerGroupsRequest struct {
// The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A query filter to return the list result based on status.
Status OccCustomerGroupStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// A filter to return only the resources that match the entire display name. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListOccCustomerGroupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for name and compartment ID is ascending. Default order for time created is descending.
SortBy ListOccCustomerGroupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOccCustomerGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOccCustomerGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOccCustomerGroupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOccCustomerGroupsRequest) String() string
func (request ListOccCustomerGroupsRequest) 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
ListOccCustomerGroupsResponse wrapper for the ListOccCustomerGroups operation
type ListOccCustomerGroupsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OccCustomerGroupCollection instances
OccCustomerGroupCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListOccCustomerGroupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOccCustomerGroupsResponse) String() string
ListOccCustomerGroupsSortByEnum Enum with underlying type: string
type ListOccCustomerGroupsSortByEnum string
Set of constants representing the allowable values for ListOccCustomerGroupsSortByEnum
const (
ListOccCustomerGroupsSortByCompartmentid ListOccCustomerGroupsSortByEnum = "compartmentId"
ListOccCustomerGroupsSortByName ListOccCustomerGroupsSortByEnum = "name"
ListOccCustomerGroupsSortByTimecreated ListOccCustomerGroupsSortByEnum = "timeCreated"
)
func GetListOccCustomerGroupsSortByEnumValues() []ListOccCustomerGroupsSortByEnum
GetListOccCustomerGroupsSortByEnumValues Enumerates the set of values for ListOccCustomerGroupsSortByEnum
func GetMappingListOccCustomerGroupsSortByEnum(val string) (ListOccCustomerGroupsSortByEnum, bool)
GetMappingListOccCustomerGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOccCustomerGroupsSortOrderEnum Enum with underlying type: string
type ListOccCustomerGroupsSortOrderEnum string
Set of constants representing the allowable values for ListOccCustomerGroupsSortOrderEnum
const (
ListOccCustomerGroupsSortOrderAsc ListOccCustomerGroupsSortOrderEnum = "ASC"
ListOccCustomerGroupsSortOrderDesc ListOccCustomerGroupsSortOrderEnum = "DESC"
)
func GetListOccCustomerGroupsSortOrderEnumValues() []ListOccCustomerGroupsSortOrderEnum
GetListOccCustomerGroupsSortOrderEnumValues Enumerates the set of values for ListOccCustomerGroupsSortOrderEnum
func GetMappingListOccCustomerGroupsSortOrderEnum(val string) (ListOccCustomerGroupsSortOrderEnum, bool)
GetMappingListOccCustomerGroupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
MetadataDetails Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
type MetadataDetails struct {
// The version for the format of the catalog file being uploaded.
FormatVersion MetadataDetailsFormatVersionEnum `mandatory:"true" json:"formatVersion"`
}
func (m MetadataDetails) String() string
func (m MetadataDetails) 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
MetadataDetailsFormatVersionEnum Enum with underlying type: string
type MetadataDetailsFormatVersionEnum string
Set of constants representing the allowable values for MetadataDetailsFormatVersionEnum
const (
MetadataDetailsFormatVersionV1 MetadataDetailsFormatVersionEnum = "V1"
)
func GetMappingMetadataDetailsFormatVersionEnum(val string) (MetadataDetailsFormatVersionEnum, bool)
GetMappingMetadataDetailsFormatVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMetadataDetailsFormatVersionEnumValues() []MetadataDetailsFormatVersionEnum
GetMetadataDetailsFormatVersionEnumValues Enumerates the set of values for MetadataDetailsFormatVersionEnum
NamespaceEnum Enum with underlying type: string
type NamespaceEnum string
Set of constants representing the allowable values for NamespaceEnum
const (
NamespaceCompute NamespaceEnum = "COMPUTE"
)
func GetMappingNamespaceEnum(val string) (NamespaceEnum, bool)
GetMappingNamespaceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNamespaceEnumValues() []NamespaceEnum
GetNamespaceEnumValues Enumerates the set of values for NamespaceEnum
OccAvailabilityCatalog Details of the availability catalog resource.
type OccAvailabilityCatalog struct {
// The OCID of the availability catalog.
Id *string `mandatory:"true" json:"id"`
// The name of the OCI service in consideration. For example, Compute, Exadata, and so on.
Namespace NamespaceEnum `mandatory:"true" json:"namespace"`
// The OCID of the tenancy where the availability catalog resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name for the availability catalog.
DisplayName *string `mandatory:"true" json:"displayName"`
// The customer group OCID to which the availability catalog belongs.
OccCustomerGroupId *string `mandatory:"true" json:"occCustomerGroupId"`
// The different states associated with the availability catalog.
CatalogState OccAvailabilityCatalogCatalogStateEnum `mandatory:"true" json:"catalogState"`
MetadataDetails *MetadataDetails `mandatory:"true" json:"metadataDetails"`
// The time when the availability catalog was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when the availability catalog was last updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current lifecycle state of the resource.
LifecycleState OccAvailabilityCatalogLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Text information about the availability catalog.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Details about capacity available for different resources in catalog.
Details []OccAvailabilitySummary `mandatory:"false" json:"details"`
}
func (m OccAvailabilityCatalog) String() string
func (m OccAvailabilityCatalog) 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
OccAvailabilityCatalogCatalogStateEnum Enum with underlying type: string
type OccAvailabilityCatalogCatalogStateEnum string
Set of constants representing the allowable values for OccAvailabilityCatalogCatalogStateEnum
const (
OccAvailabilityCatalogCatalogStateNotUploaded OccAvailabilityCatalogCatalogStateEnum = "NOT_UPLOADED"
OccAvailabilityCatalogCatalogStateUploadFailed OccAvailabilityCatalogCatalogStateEnum = "UPLOAD_FAILED"
OccAvailabilityCatalogCatalogStateStaged OccAvailabilityCatalogCatalogStateEnum = "STAGED"
OccAvailabilityCatalogCatalogStatePublished OccAvailabilityCatalogCatalogStateEnum = "PUBLISHED"
OccAvailabilityCatalogCatalogStateOutdated OccAvailabilityCatalogCatalogStateEnum = "OUTDATED"
OccAvailabilityCatalogCatalogStateDeleted OccAvailabilityCatalogCatalogStateEnum = "DELETED"
)
func GetMappingOccAvailabilityCatalogCatalogStateEnum(val string) (OccAvailabilityCatalogCatalogStateEnum, bool)
GetMappingOccAvailabilityCatalogCatalogStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOccAvailabilityCatalogCatalogStateEnumValues() []OccAvailabilityCatalogCatalogStateEnum
GetOccAvailabilityCatalogCatalogStateEnumValues Enumerates the set of values for OccAvailabilityCatalogCatalogStateEnum
OccAvailabilityCatalogCollection A list of availability catalogs.
type OccAvailabilityCatalogCollection struct {
// An array of availability catalogs.
Items []OccAvailabilityCatalogSummary `mandatory:"true" json:"items"`
}
func (m OccAvailabilityCatalogCollection) String() string
func (m OccAvailabilityCatalogCollection) 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
OccAvailabilityCatalogLifecycleStateEnum Enum with underlying type: string
type OccAvailabilityCatalogLifecycleStateEnum string
Set of constants representing the allowable values for OccAvailabilityCatalogLifecycleStateEnum
const (
OccAvailabilityCatalogLifecycleStateCreating OccAvailabilityCatalogLifecycleStateEnum = "CREATING"
OccAvailabilityCatalogLifecycleStateUpdating OccAvailabilityCatalogLifecycleStateEnum = "UPDATING"
OccAvailabilityCatalogLifecycleStateActive OccAvailabilityCatalogLifecycleStateEnum = "ACTIVE"
OccAvailabilityCatalogLifecycleStateDeleting OccAvailabilityCatalogLifecycleStateEnum = "DELETING"
OccAvailabilityCatalogLifecycleStateDeleted OccAvailabilityCatalogLifecycleStateEnum = "DELETED"
OccAvailabilityCatalogLifecycleStateFailed OccAvailabilityCatalogLifecycleStateEnum = "FAILED"
)
func GetMappingOccAvailabilityCatalogLifecycleStateEnum(val string) (OccAvailabilityCatalogLifecycleStateEnum, bool)
GetMappingOccAvailabilityCatalogLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOccAvailabilityCatalogLifecycleStateEnumValues() []OccAvailabilityCatalogLifecycleStateEnum
GetOccAvailabilityCatalogLifecycleStateEnumValues Enumerates the set of values for OccAvailabilityCatalogLifecycleStateEnum
OccAvailabilityCatalogSummary A catalog containing resource availability details for a customer.
type OccAvailabilityCatalogSummary struct {
// The OCID of the availability catalog.
Id *string `mandatory:"true" json:"id"`
// The name of the OCI service in consideration. For example, Compute, Exadata, and so on.
Namespace NamespaceEnum `mandatory:"true" json:"namespace"`
// The OCID of the tenancy where the availability catalog resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// An user-friendly name for the availability catalog. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The Customer Group OCID to which the availability catalog belongs.
OccCustomerGroupId *string `mandatory:"true" json:"occCustomerGroupId"`
// Represents whether this version of the availability catalog has been made available to the customer. The state is No by default.
CatalogState OccAvailabilityCatalogCatalogStateEnum `mandatory:"true" json:"catalogState"`
MetadataDetails *MetadataDetails `mandatory:"true" json:"metadataDetails"`
// The time when the availability catalog was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when the availability catalog was last updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current lifecycle state of the customer group.
LifecycleState OccAvailabilityCatalogLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Text information about the availability catalog.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m OccAvailabilityCatalogSummary) String() string
func (m OccAvailabilityCatalogSummary) 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
OccAvailabilityCollection A list of capacity constraints.
type OccAvailabilityCollection struct {
// An array of capacity constraints.
Items []OccAvailabilitySummary `mandatory:"true" json:"items"`
}
func (m OccAvailabilityCollection) String() string
func (m OccAvailabilityCollection) 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
OccAvailabilitySummary The details about the available capacity and constraints for different resource types present in the availability catalog.
type OccAvailabilitySummary struct {
// The OCID of the availability catalog.
CatalogId *string `mandatory:"true" json:"catalogId"`
// The name of the OCI service in consideration. For example, Compute, Exadata, and so on.
Namespace NamespaceEnum `mandatory:"true" json:"namespace"`
// The date by which the customer must place the order to have their capacity requirements met by the customer handover date.
DateFinalCustomerOrder *common.SDKTime `mandatory:"true" json:"dateFinalCustomerOrder"`
// The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.
DateExpectedCapacityHandover *common.SDKTime `mandatory:"true" json:"dateExpectedCapacityHandover"`
// The different types of resources against which customers can place capacity requests.
ResourceType OccAvailabilitySummaryResourceTypeEnum `mandatory:"true" json:"resourceType"`
// The type of workload (Generic/ROW).
WorkloadType OccAvailabilitySummaryWorkloadTypeEnum `mandatory:"true" json:"workloadType"`
// The name of the resource that the customer can request.
ResourceName *string `mandatory:"true" json:"resourceName"`
// The quantity of available resource that the customer can request.
AvailableQuantity *int64 `mandatory:"true" json:"availableQuantity"`
// The unit in which the resource available is measured.
Unit *string `mandatory:"true" json:"unit"`
}
func (m OccAvailabilitySummary) String() string
func (m OccAvailabilitySummary) 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
OccAvailabilitySummaryResourceTypeEnum Enum with underlying type: string
type OccAvailabilitySummaryResourceTypeEnum string
Set of constants representing the allowable values for OccAvailabilitySummaryResourceTypeEnum
const (
OccAvailabilitySummaryResourceTypeServerHw OccAvailabilitySummaryResourceTypeEnum = "SERVER_HW"
OccAvailabilitySummaryResourceTypeCapacityConstraint OccAvailabilitySummaryResourceTypeEnum = "CAPACITY_CONSTRAINT"
)
func GetMappingOccAvailabilitySummaryResourceTypeEnum(val string) (OccAvailabilitySummaryResourceTypeEnum, bool)
GetMappingOccAvailabilitySummaryResourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOccAvailabilitySummaryResourceTypeEnumValues() []OccAvailabilitySummaryResourceTypeEnum
GetOccAvailabilitySummaryResourceTypeEnumValues Enumerates the set of values for OccAvailabilitySummaryResourceTypeEnum
OccAvailabilitySummaryWorkloadTypeEnum Enum with underlying type: string
type OccAvailabilitySummaryWorkloadTypeEnum string
Set of constants representing the allowable values for OccAvailabilitySummaryWorkloadTypeEnum
const (
OccAvailabilitySummaryWorkloadTypeGeneric OccAvailabilitySummaryWorkloadTypeEnum = "GENERIC"
OccAvailabilitySummaryWorkloadTypeRow OccAvailabilitySummaryWorkloadTypeEnum = "ROW"
OccAvailabilitySummaryWorkloadTypeUsProd OccAvailabilitySummaryWorkloadTypeEnum = "US_PROD"
)
func GetMappingOccAvailabilitySummaryWorkloadTypeEnum(val string) (OccAvailabilitySummaryWorkloadTypeEnum, bool)
GetMappingOccAvailabilitySummaryWorkloadTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOccAvailabilitySummaryWorkloadTypeEnumValues() []OccAvailabilitySummaryWorkloadTypeEnum
GetOccAvailabilitySummaryWorkloadTypeEnumValues Enumerates the set of values for OccAvailabilitySummaryWorkloadTypeEnum
OccCapacityRequest A single request of some quantity of a specific server type, in a specific location and expected delivery date. The maximum amount possible to request is the smallest number between the number of servers available for purchase and the number of servers allowed by the constraints (For example, power, network, physical space, and so on).
type OccCapacityRequest struct {
// The OCID of the capacity request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy from which the request was made.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the availability catalog against which the capacity request was placed.
OccAvailabilityCatalogId *string `mandatory:"true" json:"occAvailabilityCatalogId"`
// The display name of the capacity request.
DisplayName *string `mandatory:"true" json:"displayName"`
// The name of the OCI service in consideration. For example, Compute, Exadata, and so on.
Namespace NamespaceEnum `mandatory:"true" json:"namespace"`
// The OCID of the customer group to which this customer belongs to.
OccCustomerGroupId *string `mandatory:"true" json:"occCustomerGroupId"`
// The name of the region for which the capacity request was made.
Region *string `mandatory:"true" json:"region"`
// The availability domain (AD) for which the capacity request was made.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.
DateExpectedCapacityHandover *common.SDKTime `mandatory:"true" json:"dateExpectedCapacityHandover"`
// The different states the capacity request goes through.
RequestState OccCapacityRequestRequestStateEnum `mandatory:"true" json:"requestState"`
// The time when the capacity request was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when the capacity request was updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current lifecycle state of the resource.
LifecycleState OccCapacityRequestLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A list of resources requested as part of this request
Details []OccCapacityRequestBaseDetails `mandatory:"true" json:"details"`
// Meaningful text about the capacity request.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m OccCapacityRequest) String() string
func (m *OccCapacityRequest) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m OccCapacityRequest) 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
OccCapacityRequestBaseDetails The details of the create capacity request. This model serves as a base for different namespaces.
type OccCapacityRequestBaseDetails interface {
// The type of the workload (Generic/ROW).
GetWorkloadType() OccAvailabilitySummaryWorkloadTypeEnum
// The incremental quantity of resources supplied as the provisioning is underway.
GetExpectedHandoverQuantity() *int64
// The date on which the latest increment to supplied quantity of resources was delivered.
GetDateExpectedHandover() *common.SDKTime
// The actual handed over quantity of resources at the time of request resolution.
GetActualHandoverQuantity() *int64
// The date on which the actual handover quantity of resources is delivered.
GetDateActualHandover() *common.SDKTime
}
OccCapacityRequestBaseDetailsResourceTypeEnum Enum with underlying type: string
type OccCapacityRequestBaseDetailsResourceTypeEnum string
Set of constants representing the allowable values for OccCapacityRequestBaseDetailsResourceTypeEnum
const (
OccCapacityRequestBaseDetailsResourceTypeServerHw OccCapacityRequestBaseDetailsResourceTypeEnum = "SERVER_HW"
)
func GetMappingOccCapacityRequestBaseDetailsResourceTypeEnum(val string) (OccCapacityRequestBaseDetailsResourceTypeEnum, bool)
GetMappingOccCapacityRequestBaseDetailsResourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOccCapacityRequestBaseDetailsResourceTypeEnumValues() []OccCapacityRequestBaseDetailsResourceTypeEnum
GetOccCapacityRequestBaseDetailsResourceTypeEnumValues Enumerates the set of values for OccCapacityRequestBaseDetailsResourceTypeEnum
OccCapacityRequestCollection A list of capacity requests.
type OccCapacityRequestCollection struct {
// An array of capacity requests.
Items []OccCapacityRequestSummary `mandatory:"true" json:"items"`
}
func (m OccCapacityRequestCollection) String() string
func (m OccCapacityRequestCollection) 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
OccCapacityRequestComputeDetails The details about the compute servers required for creating a capacity request.
type OccCapacityRequestComputeDetails struct {
// The name of the COMPUTE server shape for which the request is made. Do not use CAPACITY_CONSTRAINT as the resource name.
ResourceName *string `mandatory:"true" json:"resourceName"`
// The number of compute server's with name <resourceName> required by the user.
DemandQuantity *int64 `mandatory:"true" json:"demandQuantity"`
// The incremental quantity of resources supplied as the provisioning is underway.
ExpectedHandoverQuantity *int64 `mandatory:"false" json:"expectedHandoverQuantity"`
// The date on which the latest increment to supplied quantity of resources was delivered.
DateExpectedHandover *common.SDKTime `mandatory:"false" json:"dateExpectedHandover"`
// The actual handed over quantity of resources at the time of request resolution.
ActualHandoverQuantity *int64 `mandatory:"false" json:"actualHandoverQuantity"`
// The date on which the actual handover quantity of resources is delivered.
DateActualHandover *common.SDKTime `mandatory:"false" json:"dateActualHandover"`
// The type of the workload (Generic/ROW).
WorkloadType OccAvailabilitySummaryWorkloadTypeEnum `mandatory:"true" json:"workloadType"`
}
func (m OccCapacityRequestComputeDetails) GetActualHandoverQuantity() *int64
GetActualHandoverQuantity returns ActualHandoverQuantity
func (m OccCapacityRequestComputeDetails) GetDateActualHandover() *common.SDKTime
GetDateActualHandover returns DateActualHandover
func (m OccCapacityRequestComputeDetails) GetDateExpectedHandover() *common.SDKTime
GetDateExpectedHandover returns DateExpectedHandover
func (m OccCapacityRequestComputeDetails) GetExpectedHandoverQuantity() *int64
GetExpectedHandoverQuantity returns ExpectedHandoverQuantity
func (m OccCapacityRequestComputeDetails) GetWorkloadType() OccAvailabilitySummaryWorkloadTypeEnum
GetWorkloadType returns WorkloadType
func (m OccCapacityRequestComputeDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OccCapacityRequestComputeDetails) String() string
func (m OccCapacityRequestComputeDetails) 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
OccCapacityRequestLifecycleStateEnum Enum with underlying type: string
type OccCapacityRequestLifecycleStateEnum string
Set of constants representing the allowable values for OccCapacityRequestLifecycleStateEnum
const (
OccCapacityRequestLifecycleStateCreating OccCapacityRequestLifecycleStateEnum = "CREATING"
OccCapacityRequestLifecycleStateUpdating OccCapacityRequestLifecycleStateEnum = "UPDATING"
OccCapacityRequestLifecycleStateActive OccCapacityRequestLifecycleStateEnum = "ACTIVE"
OccCapacityRequestLifecycleStateDeleting OccCapacityRequestLifecycleStateEnum = "DELETING"
OccCapacityRequestLifecycleStateDeleted OccCapacityRequestLifecycleStateEnum = "DELETED"
OccCapacityRequestLifecycleStateFailed OccCapacityRequestLifecycleStateEnum = "FAILED"
)
func GetMappingOccCapacityRequestLifecycleStateEnum(val string) (OccCapacityRequestLifecycleStateEnum, bool)
GetMappingOccCapacityRequestLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOccCapacityRequestLifecycleStateEnumValues() []OccCapacityRequestLifecycleStateEnum
GetOccCapacityRequestLifecycleStateEnumValues Enumerates the set of values for OccCapacityRequestLifecycleStateEnum
OccCapacityRequestRequestStateEnum Enum with underlying type: string
type OccCapacityRequestRequestStateEnum string
Set of constants representing the allowable values for OccCapacityRequestRequestStateEnum
const (
OccCapacityRequestRequestStateCreated OccCapacityRequestRequestStateEnum = "CREATED"
OccCapacityRequestRequestStateSubmitted OccCapacityRequestRequestStateEnum = "SUBMITTED"
OccCapacityRequestRequestStateRejected OccCapacityRequestRequestStateEnum = "REJECTED"
OccCapacityRequestRequestStateInProgress OccCapacityRequestRequestStateEnum = "IN_PROGRESS"
OccCapacityRequestRequestStateCompleted OccCapacityRequestRequestStateEnum = "COMPLETED"
OccCapacityRequestRequestStatePartiallyCompleted OccCapacityRequestRequestStateEnum = "PARTIALLY_COMPLETED"
OccCapacityRequestRequestStateCancelled OccCapacityRequestRequestStateEnum = "CANCELLED"
OccCapacityRequestRequestStateDeleted OccCapacityRequestRequestStateEnum = "DELETED"
)
func GetMappingOccCapacityRequestRequestStateEnum(val string) (OccCapacityRequestRequestStateEnum, bool)
GetMappingOccCapacityRequestRequestStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOccCapacityRequestRequestStateEnumValues() []OccCapacityRequestRequestStateEnum
GetOccCapacityRequestRequestStateEnumValues Enumerates the set of values for OccCapacityRequestRequestStateEnum
OccCapacityRequestSummary A summary model for the capacity request model.
type OccCapacityRequestSummary struct {
// The OCID of the capacity request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy from which the request was made.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the availability catalog against which the capacity request was placed.
OccAvailabilityCatalogId *string `mandatory:"true" json:"occAvailabilityCatalogId"`
// The display name of the capacity request.
DisplayName *string `mandatory:"true" json:"displayName"`
// The name of the OCI service in consideration. For example, Compute, Exadata, and so on.
Namespace NamespaceEnum `mandatory:"true" json:"namespace"`
// The OCID of the customer group to which this customer belongs to.
OccCustomerGroupId *string `mandatory:"true" json:"occCustomerGroupId"`
// The name of the region for which the capacity request was made.
Region *string `mandatory:"true" json:"region"`
// The availability domain (AD) for which the capacity request was made.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.
DateExpectedCapacityHandover *common.SDKTime `mandatory:"true" json:"dateExpectedCapacityHandover"`
// A list of states through which the capacity request goes by.
RequestState OccCapacityRequestRequestStateEnum `mandatory:"true" json:"requestState"`
// The time when the capacity request was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when the capacity request was updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current lifecycle state of the customer group.
LifecycleState OccCapacityRequestLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Meaningful text about the capacity request.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m OccCapacityRequestSummary) String() string
func (m OccCapacityRequestSummary) 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
OccCustomer The details about the customer.
type OccCustomer struct {
// The OCID of the customer group.
OccCustomerGroupId *string `mandatory:"true" json:"occCustomerGroupId"`
// The OCID of the tenancy belonging to the customer.
TenancyId *string `mandatory:"true" json:"tenancyId"`
// The display name for the customer
DisplayName *string `mandatory:"true" json:"displayName"`
// To determine whether the customer is enabled/disabled.`
Status OccCustomerStatusEnum `mandatory:"true" json:"status"`
// The description about the customer group.
Description *string `mandatory:"false" json:"description"`
}
func (m OccCustomer) String() string
func (m OccCustomer) 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
OccCustomerGroup Details of the customer group resource.
type OccCustomerGroup struct {
// The OCID of the customer group.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy containing the customer group.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The display name of the customer group.
DisplayName *string `mandatory:"true" json:"displayName"`
// To determine whether the customer group is enabled/disabled.
Status OccCustomerGroupStatusEnum `mandatory:"true" json:"status"`
// The current lifecycle state of the resource.
LifecycleState OccCustomerGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A list containing all the customers that belong to this customer group
CustomersList []OccCustomer `mandatory:"true" json:"customersList"`
// The description about the customer group.
Description *string `mandatory:"false" json:"description"`
// The time when the customer group was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time when the customer group was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m OccCustomerGroup) String() string
func (m OccCustomerGroup) 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
OccCustomerGroupCollection A list of customer groups.
type OccCustomerGroupCollection struct {
// An array of customer groups.
Items []OccCustomerGroupSummary `mandatory:"true" json:"items"`
}
func (m OccCustomerGroupCollection) String() string
func (m OccCustomerGroupCollection) 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
OccCustomerGroupLifecycleStateEnum Enum with underlying type: string
type OccCustomerGroupLifecycleStateEnum string
Set of constants representing the allowable values for OccCustomerGroupLifecycleStateEnum
const (
OccCustomerGroupLifecycleStateCreating OccCustomerGroupLifecycleStateEnum = "CREATING"
OccCustomerGroupLifecycleStateUpdating OccCustomerGroupLifecycleStateEnum = "UPDATING"
OccCustomerGroupLifecycleStateActive OccCustomerGroupLifecycleStateEnum = "ACTIVE"
OccCustomerGroupLifecycleStateDeleting OccCustomerGroupLifecycleStateEnum = "DELETING"
OccCustomerGroupLifecycleStateDeleted OccCustomerGroupLifecycleStateEnum = "DELETED"
OccCustomerGroupLifecycleStateFailed OccCustomerGroupLifecycleStateEnum = "FAILED"
)
func GetMappingOccCustomerGroupLifecycleStateEnum(val string) (OccCustomerGroupLifecycleStateEnum, bool)
GetMappingOccCustomerGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOccCustomerGroupLifecycleStateEnumValues() []OccCustomerGroupLifecycleStateEnum
GetOccCustomerGroupLifecycleStateEnumValues Enumerates the set of values for OccCustomerGroupLifecycleStateEnum
OccCustomerGroupStatusEnum Enum with underlying type: string
type OccCustomerGroupStatusEnum string
Set of constants representing the allowable values for OccCustomerGroupStatusEnum
const (
OccCustomerGroupStatusEnabled OccCustomerGroupStatusEnum = "ENABLED"
OccCustomerGroupStatusDisabled OccCustomerGroupStatusEnum = "DISABLED"
)
func GetMappingOccCustomerGroupStatusEnum(val string) (OccCustomerGroupStatusEnum, bool)
GetMappingOccCustomerGroupStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOccCustomerGroupStatusEnumValues() []OccCustomerGroupStatusEnum
GetOccCustomerGroupStatusEnumValues Enumerates the set of values for OccCustomerGroupStatusEnum
OccCustomerGroupSummary A customer group is a resource that represents the portion of the capacity reserved for a customer or a group of customers to facilitate their capacity bookings.
type OccCustomerGroupSummary struct {
// The OCID of the customer group.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy containing the customer group.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The display name of the customer group.
DisplayName *string `mandatory:"true" json:"displayName"`
// The status (enabled/disabled) of the customer group.
Status OccCustomerGroupStatusEnum `mandatory:"true" json:"status"`
// The current lifecycle state of the customer group.
LifecycleState OccCustomerGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The description about the customer group.
Description *string `mandatory:"false" json:"description"`
// The time when the customer group was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time when the customer group was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m OccCustomerGroupSummary) String() string
func (m OccCustomerGroupSummary) 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
OccCustomerStatusEnum Enum with underlying type: string
type OccCustomerStatusEnum string
Set of constants representing the allowable values for OccCustomerStatusEnum
const (
OccCustomerStatusEnabled OccCustomerStatusEnum = "ENABLED"
OccCustomerStatusDisabled OccCustomerStatusEnum = "DISABLED"
)
func GetMappingOccCustomerStatusEnum(val string) (OccCustomerStatusEnum, bool)
GetMappingOccCustomerStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOccCustomerStatusEnumValues() []OccCustomerStatusEnum
GetOccCustomerStatusEnumValues Enumerates the set of values for OccCustomerStatusEnum
PatchInsertInstruction An operation that inserts a value into an array, shifting array items as necessary and handling NOT_FOUND exceptions by creating the implied containing structure.
type PatchInsertInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be inserted into the target.
Value *interface{} `mandatory:"true" json:"value"`
// A selection to be evaluated against the array for identifying a particular reference item within it, with the same format and semantics as `selection`.
SelectedItem *string `mandatory:"false" json:"selectedItem"`
// Where to insert the value, relative to the first item matched by `selectedItem`.
// If `selectedItem` is unspecified, then "BEFORE" specifies insertion at the first position in an array and "AFTER" specifies insertion at the last position.
// If `selectedItem` is specified but results in an empty selection, then both values specify insertion at the last position.
Position PatchInsertInstructionPositionEnum `mandatory:"false" json:"position,omitempty"`
}
func (m PatchInsertInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchInsertInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchInsertInstruction) String() string
func (m PatchInsertInstruction) 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
PatchInsertInstructionPositionEnum Enum with underlying type: string
type PatchInsertInstructionPositionEnum string
Set of constants representing the allowable values for PatchInsertInstructionPositionEnum
const (
PatchInsertInstructionPositionBefore PatchInsertInstructionPositionEnum = "BEFORE"
PatchInsertInstructionPositionAfter PatchInsertInstructionPositionEnum = "AFTER"
)
func GetMappingPatchInsertInstructionPositionEnum(val string) (PatchInsertInstructionPositionEnum, bool)
GetMappingPatchInsertInstructionPositionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchInsertInstructionPositionEnumValues() []PatchInsertInstructionPositionEnum
GetPatchInsertInstructionPositionEnumValues Enumerates the set of values for PatchInsertInstructionPositionEnum
PatchInsertMultipleInstruction An operation that inserts multiple consecutive values into an array, shifting array items as necessary and handling NOT_FOUND exceptions by creating the implied containing structure.
type PatchInsertMultipleInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A list of consecutive values to be inserted into the target.
Values []interface{} `mandatory:"true" json:"values"`
// A selection to be evaluated against the array for identifying a particular reference item within it, with the same format and semantics as `selection`.
SelectedItem *string `mandatory:"false" json:"selectedItem"`
// Where to insert the values, relative to the first item matched by `selectedItem`.
// If `selectedItem` is unspecified, then "BEFORE" specifies insertion at the first position in an array and "AFTER" specifies insertion at the last position.
// If `selectedItem` is specified but results in an empty selection, then both values specify insertion at the last position.
Position PatchInsertMultipleInstructionPositionEnum `mandatory:"false" json:"position,omitempty"`
}
func (m PatchInsertMultipleInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchInsertMultipleInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchInsertMultipleInstruction) String() string
func (m PatchInsertMultipleInstruction) 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
PatchInsertMultipleInstructionPositionEnum Enum with underlying type: string
type PatchInsertMultipleInstructionPositionEnum string
Set of constants representing the allowable values for PatchInsertMultipleInstructionPositionEnum
const (
PatchInsertMultipleInstructionPositionBefore PatchInsertMultipleInstructionPositionEnum = "BEFORE"
PatchInsertMultipleInstructionPositionAfter PatchInsertMultipleInstructionPositionEnum = "AFTER"
)
func GetMappingPatchInsertMultipleInstructionPositionEnum(val string) (PatchInsertMultipleInstructionPositionEnum, bool)
GetMappingPatchInsertMultipleInstructionPositionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchInsertMultipleInstructionPositionEnumValues() []PatchInsertMultipleInstructionPositionEnum
GetPatchInsertMultipleInstructionPositionEnumValues Enumerates the set of values for PatchInsertMultipleInstructionPositionEnum
PatchInstruction A single instruction to be included as part of Patch request content.
type PatchInstruction interface {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
GetSelection() *string
}
PatchInstructionOperationEnum Enum with underlying type: string
type PatchInstructionOperationEnum string
Set of constants representing the allowable values for PatchInstructionOperationEnum
const (
PatchInstructionOperationRequire PatchInstructionOperationEnum = "REQUIRE"
PatchInstructionOperationProhibit PatchInstructionOperationEnum = "PROHIBIT"
PatchInstructionOperationReplace PatchInstructionOperationEnum = "REPLACE"
PatchInstructionOperationInsert PatchInstructionOperationEnum = "INSERT"
PatchInstructionOperationRemove PatchInstructionOperationEnum = "REMOVE"
PatchInstructionOperationMove PatchInstructionOperationEnum = "MOVE"
PatchInstructionOperationMerge PatchInstructionOperationEnum = "MERGE"
)
func GetMappingPatchInstructionOperationEnum(val string) (PatchInstructionOperationEnum, bool)
GetMappingPatchInstructionOperationEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchInstructionOperationEnumValues() []PatchInstructionOperationEnum
GetPatchInstructionOperationEnumValues Enumerates the set of values for PatchInstructionOperationEnum
PatchMergeInstruction An operation that recursively updates items of the selection, or adding the value if the selection is empty. If the value is not an object, it is used directly, otherwise each key-value member is used to create or update a member of the same name in the target and the same process is applied recursively for each object-typed value (similar to RFC 7396 (https://tools.ietf.org/html/rfc7396#section-2) JSON Merge Patch, except that null values are copied rather than transformed into deletions). NOT_FOUND exceptions are handled by creating the implied containing structure. To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.
type PatchMergeInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be merged into the target.
Value *interface{} `mandatory:"false" json:"value"`
}
func (m PatchMergeInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchMergeInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchMergeInstruction) String() string
func (m PatchMergeInstruction) 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
PatchMoveInstruction An operation that "puts" values from elsewhere in the target, functionally equivalent to a single add and then a remove. The first item of the selection is replaced, or created if the selection is empty. NOT_FOUND exceptions in the selection are handled by creating the implied containing structure. This operation fails if the `from` selection yields any exceptions, or if an item is moved to any of its descendants.
type PatchMoveInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// The selection that is to be moved, with the same format and semantics as `selection`.
From *string `mandatory:"true" json:"from"`
// Where to insert the value in an array, relative to the first item in the selection.
// If there is no such item, then "BEFORE" specifies insertion at the first position in an array and "AFTER" specifies insertion at the last position.
// If the first item in the selection is not the child of an array, then this field has no effect.
Position PatchMoveInstructionPositionEnum `mandatory:"false" json:"position,omitempty"`
}
func (m PatchMoveInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchMoveInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchMoveInstruction) String() string
func (m PatchMoveInstruction) 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
PatchMoveInstructionPositionEnum Enum with underlying type: string
type PatchMoveInstructionPositionEnum string
Set of constants representing the allowable values for PatchMoveInstructionPositionEnum
const (
PatchMoveInstructionPositionAt PatchMoveInstructionPositionEnum = "AT"
PatchMoveInstructionPositionBefore PatchMoveInstructionPositionEnum = "BEFORE"
PatchMoveInstructionPositionAfter PatchMoveInstructionPositionEnum = "AFTER"
)
func GetMappingPatchMoveInstructionPositionEnum(val string) (PatchMoveInstructionPositionEnum, bool)
GetMappingPatchMoveInstructionPositionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchMoveInstructionPositionEnumValues() []PatchMoveInstructionPositionEnum
GetPatchMoveInstructionPositionEnumValues Enumerates the set of values for PatchMoveInstructionPositionEnum
PatchOccCapacityRequestDetails CapacityRequest details to patch.
type PatchOccCapacityRequestDetails struct {
// List of patch instructions.
Items []PatchInstruction `mandatory:"false" json:"items"`
}
func (m PatchOccCapacityRequestDetails) String() string
func (m *PatchOccCapacityRequestDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PatchOccCapacityRequestDetails) 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
PatchOccCapacityRequestRequest wrapper for the PatchOccCapacityRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/PatchOccCapacityRequest.go.html to see an example of how to use PatchOccCapacityRequestRequest.
type PatchOccCapacityRequestRequest struct {
// Request to update the properties of the capacity request.
PatchOccCapacityRequestDetails `contributesTo:"body"`
// The OCID of the capacity request.
OccCapacityRequestId *string `mandatory:"true" contributesTo:"path" name:"occCapacityRequestId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request PatchOccCapacityRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PatchOccCapacityRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PatchOccCapacityRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PatchOccCapacityRequestRequest) String() string
func (request PatchOccCapacityRequestRequest) 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
PatchOccCapacityRequestResponse wrapper for the PatchOccCapacityRequest operation
type PatchOccCapacityRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The OccCapacityRequest instance
OccCapacityRequest `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response PatchOccCapacityRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PatchOccCapacityRequestResponse) String() string
PatchProhibitInstruction A precondition operation that requires a selection to be empty, or optionally to be non-empty but include no item with a specified value (useful for asserting that a value does not exist before attempting to create it, avoiding accidental update). It fails if value is provided and the selection includes an item matching it, or if value is not provided and the selection is not empty, but ignores NOT_FOUND exceptions.
type PatchProhibitInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be compared against each item of the selection.
// If this value is an object, then it matches any item that would be unaffected by applying this value as a merge operation.
// Otherwise, it matches any item to which it is equal according to the rules of JSON Schema (https://tools.ietf.org/html/draft-handrews-json-schema-00#section-4.2.3).
Value *interface{} `mandatory:"false" json:"value"`
}
func (m PatchProhibitInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchProhibitInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchProhibitInstruction) String() string
func (m PatchProhibitInstruction) 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
PatchRemoveInstruction An operation that deletes items, ignoring NOT_FOUND exceptions. To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.
type PatchRemoveInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
}
func (m PatchRemoveInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchRemoveInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchRemoveInstruction) String() string
func (m PatchRemoveInstruction) 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
PatchReplaceInstruction An operation that "puts" a value, replacing every item of the selection with it, or creating it if the selection is empty. NOT_FOUND exceptions are handled by creating the implied containing structure (but note that this may put the target in an invalid state, which can be prevented by use of precondition operations). To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.
type PatchReplaceInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be added into the target.
Value *interface{} `mandatory:"true" json:"value"`
}
func (m PatchReplaceInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchReplaceInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchReplaceInstruction) String() string
func (m PatchReplaceInstruction) 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
PatchRequireInstruction A precondition operation that requires a selection to be non-empty, and optionally to include an item with a specified value (useful for asserting that a value exists before attempting to update it, avoiding accidental creation). It fails if the selection is empty, or if value is provided and no item of the selection matches it.
type PatchRequireInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be compared against each item of the selection.
// If this value is an object, then it matches any item that would be unaffected by applying this value as a merge operation.
// Otherwise, it matches any item to which it is equal according to the rules of JSON Schema (https://tools.ietf.org/html/draft-handrews-json-schema-00#section-4.2.3).
Value *interface{} `mandatory:"false" json:"value"`
}
func (m PatchRequireInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchRequireInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchRequireInstruction) String() string
func (m PatchRequireInstruction) 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
PublishOccAvailabilityCatalogRequest wrapper for the PublishOccAvailabilityCatalog operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/PublishOccAvailabilityCatalog.go.html to see an example of how to use PublishOccAvailabilityCatalogRequest.
type PublishOccAvailabilityCatalogRequest struct {
// The OCID of the availability catalog.
OccAvailabilityCatalogId *string `mandatory:"true" contributesTo:"path" name:"occAvailabilityCatalogId"`
// 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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request PublishOccAvailabilityCatalogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PublishOccAvailabilityCatalogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PublishOccAvailabilityCatalogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PublishOccAvailabilityCatalogRequest) String() string
func (request PublishOccAvailabilityCatalogRequest) 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
PublishOccAvailabilityCatalogResponse wrapper for the PublishOccAvailabilityCatalog operation
type PublishOccAvailabilityCatalogResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response PublishOccAvailabilityCatalogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PublishOccAvailabilityCatalogResponse) String() string
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
UpdateInternalOccCapacityRequestDetails The details required for making an internal API update call for the capacity requests.
type UpdateInternalOccCapacityRequestDetails struct {
// The subset of request states available internally for updating the capacity request.
RequestState UpdateInternalOccCapacityRequestDetailsRequestStateEnum `mandatory:"false" json:"requestState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m UpdateInternalOccCapacityRequestDetails) String() string
func (m UpdateInternalOccCapacityRequestDetails) 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
UpdateInternalOccCapacityRequestDetailsRequestStateEnum Enum with underlying type: string
type UpdateInternalOccCapacityRequestDetailsRequestStateEnum string
Set of constants representing the allowable values for UpdateInternalOccCapacityRequestDetailsRequestStateEnum
const (
UpdateInternalOccCapacityRequestDetailsRequestStateResolved UpdateInternalOccCapacityRequestDetailsRequestStateEnum = "RESOLVED"
UpdateInternalOccCapacityRequestDetailsRequestStateRejected UpdateInternalOccCapacityRequestDetailsRequestStateEnum = "REJECTED"
UpdateInternalOccCapacityRequestDetailsRequestStateInProgress UpdateInternalOccCapacityRequestDetailsRequestStateEnum = "IN_PROGRESS"
)
func GetMappingUpdateInternalOccCapacityRequestDetailsRequestStateEnum(val string) (UpdateInternalOccCapacityRequestDetailsRequestStateEnum, bool)
GetMappingUpdateInternalOccCapacityRequestDetailsRequestStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateInternalOccCapacityRequestDetailsRequestStateEnumValues() []UpdateInternalOccCapacityRequestDetailsRequestStateEnum
GetUpdateInternalOccCapacityRequestDetailsRequestStateEnumValues Enumerates the set of values for UpdateInternalOccCapacityRequestDetailsRequestStateEnum
UpdateInternalOccCapacityRequestRequest wrapper for the UpdateInternalOccCapacityRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/UpdateInternalOccCapacityRequest.go.html to see an example of how to use UpdateInternalOccCapacityRequestRequest.
type UpdateInternalOccCapacityRequestRequest struct {
// Request to update the properties of the capacity request.
UpdateInternalOccCapacityRequestDetails `contributesTo:"body"`
// The OCID of the capacity request.
OccCapacityRequestId *string `mandatory:"true" contributesTo:"path" name:"occCapacityRequestId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateInternalOccCapacityRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateInternalOccCapacityRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateInternalOccCapacityRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateInternalOccCapacityRequestRequest) String() string
func (request UpdateInternalOccCapacityRequestRequest) 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
UpdateInternalOccCapacityRequestResponse wrapper for the UpdateInternalOccCapacityRequest operation
type UpdateInternalOccCapacityRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The OccCapacityRequest instance
OccCapacityRequest `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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response UpdateInternalOccCapacityRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateInternalOccCapacityRequestResponse) String() string
UpdateOccAvailabilityCatalogDetails Details about the update request for updating the availability catalogs.
type UpdateOccAvailabilityCatalogDetails struct {
// The display name of the availability catalog.
DisplayName *string `mandatory:"false" json:"displayName"`
// Additional information about the availability catalog.
Description *string `mandatory:"false" json:"description"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateOccAvailabilityCatalogDetails) String() string
func (m UpdateOccAvailabilityCatalogDetails) 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
UpdateOccAvailabilityCatalogRequest wrapper for the UpdateOccAvailabilityCatalog operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/UpdateOccAvailabilityCatalog.go.html to see an example of how to use UpdateOccAvailabilityCatalogRequest.
type UpdateOccAvailabilityCatalogRequest struct {
// Request to update the properties of the availability catalog.
UpdateOccAvailabilityCatalogDetails `contributesTo:"body"`
// The OCID of the availability catalog.
OccAvailabilityCatalogId *string `mandatory:"true" contributesTo:"path" name:"occAvailabilityCatalogId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateOccAvailabilityCatalogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOccAvailabilityCatalogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOccAvailabilityCatalogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOccAvailabilityCatalogRequest) String() string
func (request UpdateOccAvailabilityCatalogRequest) 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
UpdateOccAvailabilityCatalogResponse wrapper for the UpdateOccAvailabilityCatalog operation
type UpdateOccAvailabilityCatalogResponse struct {
// The underlying http response
RawResponse *http.Response
// The OccAvailabilityCatalog instance
OccAvailabilityCatalog `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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response UpdateOccAvailabilityCatalogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOccAvailabilityCatalogResponse) String() string
UpdateOccCapacityRequestDetails The details required for making an update call for capacity requests.
type UpdateOccCapacityRequestDetails struct {
// The display name of the capacity request.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The subset of request states available for updating the capacity request.
RequestState UpdateOccCapacityRequestDetailsRequestStateEnum `mandatory:"false" json:"requestState,omitempty"`
}
func (m UpdateOccCapacityRequestDetails) String() string
func (m UpdateOccCapacityRequestDetails) 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
UpdateOccCapacityRequestDetailsRequestStateEnum Enum with underlying type: string
type UpdateOccCapacityRequestDetailsRequestStateEnum string
Set of constants representing the allowable values for UpdateOccCapacityRequestDetailsRequestStateEnum
const (
UpdateOccCapacityRequestDetailsRequestStateSubmitted UpdateOccCapacityRequestDetailsRequestStateEnum = "SUBMITTED"
UpdateOccCapacityRequestDetailsRequestStateCancelled UpdateOccCapacityRequestDetailsRequestStateEnum = "CANCELLED"
)
func GetMappingUpdateOccCapacityRequestDetailsRequestStateEnum(val string) (UpdateOccCapacityRequestDetailsRequestStateEnum, bool)
GetMappingUpdateOccCapacityRequestDetailsRequestStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateOccCapacityRequestDetailsRequestStateEnumValues() []UpdateOccCapacityRequestDetailsRequestStateEnum
GetUpdateOccCapacityRequestDetailsRequestStateEnumValues Enumerates the set of values for UpdateOccCapacityRequestDetailsRequestStateEnum
UpdateOccCapacityRequestRequest wrapper for the UpdateOccCapacityRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/capacitymanagement/UpdateOccCapacityRequest.go.html to see an example of how to use UpdateOccCapacityRequestRequest.
type UpdateOccCapacityRequestRequest struct {
// Request to update the properties of the capacity request.
UpdateOccCapacityRequestDetails `contributesTo:"body"`
// The OCID of the capacity request.
OccCapacityRequestId *string `mandatory:"true" contributesTo:"path" name:"occCapacityRequestId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing. The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateOccCapacityRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOccCapacityRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOccCapacityRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOccCapacityRequestRequest) String() string
func (request UpdateOccCapacityRequestRequest) 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
UpdateOccCapacityRequestResponse wrapper for the UpdateOccCapacityRequest operation
type UpdateOccCapacityRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The OccCapacityRequest instance
OccCapacityRequest `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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response UpdateOccCapacityRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOccCapacityRequestResponse) String() string