clusterplacementgroups

package
v65.67.0 Latest Latest
Warning

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

Go to latest
Published: Jun 4, 2024 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetClusterPlacementGroupLifecycleStateEnumStringValues

func GetClusterPlacementGroupLifecycleStateEnumStringValues() []string

GetClusterPlacementGroupLifecycleStateEnumStringValues Enumerates the set of values in String for ClusterPlacementGroupLifecycleStateEnum

func GetClusterPlacementGroupTypeEnumStringValues

func GetClusterPlacementGroupTypeEnumStringValues() []string

GetClusterPlacementGroupTypeEnumStringValues Enumerates the set of values in String for ClusterPlacementGroupTypeEnum

func GetListClusterPlacementGroupsSortByEnumStringValues

func GetListClusterPlacementGroupsSortByEnumStringValues() []string

GetListClusterPlacementGroupsSortByEnumStringValues Enumerates the set of values in String for ListClusterPlacementGroupsSortByEnum

func GetListClusterPlacementGroupsSortOrderEnumStringValues

func GetListClusterPlacementGroupsSortOrderEnumStringValues() []string

GetListClusterPlacementGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListClusterPlacementGroupsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetPlacementInstructionDetailsTypeEnumStringValues

func GetPlacementInstructionDetailsTypeEnumStringValues() []string

GetPlacementInstructionDetailsTypeEnumStringValues Enumerates the set of values in String for PlacementInstructionDetailsTypeEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

Types

type ActionTypeEnum

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string

const (
	ActionTypeCreated    ActionTypeEnum = "CREATED"
	ActionTypeUpdated    ActionTypeEnum = "UPDATED"
	ActionTypeDeleted    ActionTypeEnum = "DELETED"
	ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
	ActionTypeRelated    ActionTypeEnum = "RELATED"
	ActionTypeFailed     ActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type ActivateClusterPlacementGroupRequest

type ActivateClusterPlacementGroupRequest struct {

	// A unique cluster placement group identifier.
	ClusterPlacementGroupId *string `mandatory:"true" contributesTo:"path" name:"clusterPlacementGroupId"`

	// 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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. 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"`

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

ActivateClusterPlacementGroupRequest wrapper for the ActivateClusterPlacementGroup operation

See also

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

func (ActivateClusterPlacementGroupRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ActivateClusterPlacementGroupRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ActivateClusterPlacementGroupRequest) RetryPolicy

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

func (ActivateClusterPlacementGroupRequest) String

func (ActivateClusterPlacementGroupRequest) ValidateEnumValue

func (request ActivateClusterPlacementGroupRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ActivateClusterPlacementGroupResponse

type ActivateClusterPlacementGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ClusterPlacementGroup instance
	ClusterPlacementGroup `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"`
}

ActivateClusterPlacementGroupResponse wrapper for the ActivateClusterPlacementGroup operation

func (ActivateClusterPlacementGroupResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ActivateClusterPlacementGroupResponse) String

type CancelWorkRequestRequest

type CancelWorkRequestRequest struct {

	// The ID of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// 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.
	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
}

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

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

func (CancelWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy

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

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

func (CancelWorkRequestRequest) String

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue

func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CancelWorkRequestResponse

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

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String

func (response CancelWorkRequestResponse) String() string

type CapabilitiesCollection

type CapabilitiesCollection struct {

	// The supported resources.
	Items []CapabilityDetails `mandatory:"true" json:"items"`
}

CapabilitiesCollection A list of resources that you can create in a cluster placement group.

func (CapabilitiesCollection) String

func (m CapabilitiesCollection) String() string

func (CapabilitiesCollection) ValidateEnumValue

func (m CapabilitiesCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CapabilityDetails

type CapabilityDetails struct {

	// The service that the resource is part of.
	Service *string `mandatory:"true" json:"service"`

	// The type of resource.
	Name *string `mandatory:"true" json:"name"`
}

CapabilityDetails Details about the supported type of resource.

func (CapabilityDetails) String

func (m CapabilityDetails) String() string

func (CapabilityDetails) ValidateEnumValue

func (m CapabilityDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeClusterPlacementGroupCompartmentDetails

type ChangeClusterPlacementGroupCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
	// into which the resource should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeClusterPlacementGroupCompartmentDetails The information to update.

func (ChangeClusterPlacementGroupCompartmentDetails) String

func (ChangeClusterPlacementGroupCompartmentDetails) ValidateEnumValue

func (m ChangeClusterPlacementGroupCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeClusterPlacementGroupCompartmentRequest

type ChangeClusterPlacementGroupCompartmentRequest struct {

	// A unique cluster placement group identifier.
	ClusterPlacementGroupId *string `mandatory:"true" contributesTo:"path" name:"clusterPlacementGroupId"`

	// The details of the updated compartment.
	ChangeClusterPlacementGroupCompartmentDetails `contributesTo:"body"`

	// 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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. 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"`

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

ChangeClusterPlacementGroupCompartmentRequest wrapper for the ChangeClusterPlacementGroupCompartment operation

See also

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

func (ChangeClusterPlacementGroupCompartmentRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ChangeClusterPlacementGroupCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeClusterPlacementGroupCompartmentRequest) RetryPolicy

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

func (ChangeClusterPlacementGroupCompartmentRequest) String

func (ChangeClusterPlacementGroupCompartmentRequest) ValidateEnumValue

func (request ChangeClusterPlacementGroupCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeClusterPlacementGroupCompartmentResponse

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

ChangeClusterPlacementGroupCompartmentResponse wrapper for the ChangeClusterPlacementGroupCompartment operation

func (ChangeClusterPlacementGroupCompartmentResponse) HTTPResponse

HTTPResponse implements the OCIResponse interface

func (ChangeClusterPlacementGroupCompartmentResponse) String

type ClusterPlacementGroup

type ClusterPlacementGroup struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group.
	Id *string `mandatory:"true" json:"id"`

	// The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.
	Name *string `mandatory:"true" json:"name"`

	// A description of the cluster placement group.
	Description *string `mandatory:"true" json:"description"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the cluster placement group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The availability domain of the cluster placement group.
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The type of cluster placement group.
	ClusterPlacementGroupType ClusterPlacementGroupTypeEnum `mandatory:"true" json:"clusterPlacementGroupType"`

	// The time the cluster placement group was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the ClusterPlacementGroup.
	LifecycleState ClusterPlacementGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// 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:"true" 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:"true" json:"definedTags"`

	// The time the cluster placement group was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	PlacementInstruction *PlacementInstructionDetails `mandatory:"false" json:"placementInstruction"`

	Capabilities *CapabilitiesCollection `mandatory:"false" json:"capabilities"`

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

ClusterPlacementGroup A cluster placement group, which is a logical grouping of resources that offer low latency within an availability domain by being placed in close physical proximity.

func (ClusterPlacementGroup) String

func (m ClusterPlacementGroup) String() string

func (ClusterPlacementGroup) ValidateEnumValue

func (m ClusterPlacementGroup) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ClusterPlacementGroupCollection

type ClusterPlacementGroupCollection struct {

	// A list of cluster placement groups.
	Items []ClusterPlacementGroupSummary `mandatory:"true" json:"items"`
}

ClusterPlacementGroupCollection The results of a cluster placement group search, including cluster placement group summary objects and other information, such as metadata.

func (ClusterPlacementGroupCollection) String

func (ClusterPlacementGroupCollection) ValidateEnumValue

func (m ClusterPlacementGroupCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ClusterPlacementGroupLifecycleStateEnum

type ClusterPlacementGroupLifecycleStateEnum string

ClusterPlacementGroupLifecycleStateEnum Enum with underlying type: string

const (
	ClusterPlacementGroupLifecycleStateCreating ClusterPlacementGroupLifecycleStateEnum = "CREATING"
	ClusterPlacementGroupLifecycleStateUpdating ClusterPlacementGroupLifecycleStateEnum = "UPDATING"
	ClusterPlacementGroupLifecycleStateActive   ClusterPlacementGroupLifecycleStateEnum = "ACTIVE"
	ClusterPlacementGroupLifecycleStateInactive ClusterPlacementGroupLifecycleStateEnum = "INACTIVE"
	ClusterPlacementGroupLifecycleStateDeleting ClusterPlacementGroupLifecycleStateEnum = "DELETING"
	ClusterPlacementGroupLifecycleStateDeleted  ClusterPlacementGroupLifecycleStateEnum = "DELETED"
	ClusterPlacementGroupLifecycleStateFailed   ClusterPlacementGroupLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ClusterPlacementGroupLifecycleStateEnum

func GetClusterPlacementGroupLifecycleStateEnumValues

func GetClusterPlacementGroupLifecycleStateEnumValues() []ClusterPlacementGroupLifecycleStateEnum

GetClusterPlacementGroupLifecycleStateEnumValues Enumerates the set of values for ClusterPlacementGroupLifecycleStateEnum

func GetMappingClusterPlacementGroupLifecycleStateEnum

func GetMappingClusterPlacementGroupLifecycleStateEnum(val string) (ClusterPlacementGroupLifecycleStateEnum, bool)

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

type ClusterPlacementGroupSummary

type ClusterPlacementGroupSummary struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group.
	Id *string `mandatory:"true" json:"id"`

	// The friendly name of the cluster placement group.
	Name *string `mandatory:"true" json:"name"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the cluster placement group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The availability domain of the cluster placement group.
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The type of cluster placement group.
	ClusterPlacementGroupType ClusterPlacementGroupTypeEnum `mandatory:"true" json:"clusterPlacementGroupType"`

	// The time the cluster placement group was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the cluster placement group.
	LifecycleState ClusterPlacementGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// 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:"true" 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:"true" json:"definedTags"`

	// The time the cluster placement group was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

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

ClusterPlacementGroupSummary A summary object that provides the metadata details of the cluster placement group.

func (ClusterPlacementGroupSummary) String

func (ClusterPlacementGroupSummary) ValidateEnumValue

func (m ClusterPlacementGroupSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ClusterPlacementGroupTypeEnum

type ClusterPlacementGroupTypeEnum string

ClusterPlacementGroupTypeEnum Enum with underlying type: string

const (
	ClusterPlacementGroupTypeStandard ClusterPlacementGroupTypeEnum = "STANDARD"
)

Set of constants representing the allowable values for ClusterPlacementGroupTypeEnum

func GetClusterPlacementGroupTypeEnumValues

func GetClusterPlacementGroupTypeEnumValues() []ClusterPlacementGroupTypeEnum

GetClusterPlacementGroupTypeEnumValues Enumerates the set of values for ClusterPlacementGroupTypeEnum

func GetMappingClusterPlacementGroupTypeEnum

func GetMappingClusterPlacementGroupTypeEnum(val string) (ClusterPlacementGroupTypeEnum, bool)

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

type ClusterPlacementGroupsCPClient

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

ClusterPlacementGroupsCPClient a client for ClusterPlacementGroupsCP

func NewClusterPlacementGroupsCPClientWithConfigurationProvider

func NewClusterPlacementGroupsCPClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ClusterPlacementGroupsCPClient, err error)

NewClusterPlacementGroupsCPClientWithConfigurationProvider Creates a new default ClusterPlacementGroupsCP client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewClusterPlacementGroupsCPClientWithOboToken

func NewClusterPlacementGroupsCPClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ClusterPlacementGroupsCPClient, err error)

NewClusterPlacementGroupsCPClientWithOboToken Creates a new default ClusterPlacementGroupsCP 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 (ClusterPlacementGroupsCPClient) ActivateClusterPlacementGroup

ActivateClusterPlacementGroup Activates the specified, previously deactivated cluster placement group to let resources be created in it.

See also

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

func (ClusterPlacementGroupsCPClient) CancelWorkRequest

func (client ClusterPlacementGroupsCPClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)

CancelWorkRequest Cancels the work request with the specified ID.

See also

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

func (ClusterPlacementGroupsCPClient) ChangeClusterPlacementGroupCompartment

ChangeClusterPlacementGroupCompartment Moves a cluster placement group resource from one compartment to another in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). When provided, If-Match is checked against ETag values of the resource.

See also

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

func (*ClusterPlacementGroupsCPClient) ConfigurationProvider

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

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

func (ClusterPlacementGroupsCPClient) CreateClusterPlacementGroup

func (client ClusterPlacementGroupsCPClient) CreateClusterPlacementGroup(ctx context.Context, request CreateClusterPlacementGroupRequest) (response CreateClusterPlacementGroupResponse, err error)

CreateClusterPlacementGroup Creates a new cluster placement group in the specified compartment.

See also

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

func (ClusterPlacementGroupsCPClient) DeactivateClusterPlacementGroup

DeactivateClusterPlacementGroup Deactivates the specified cluster placement group to prevent new resources from being created in it.

See also

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

func (ClusterPlacementGroupsCPClient) DeleteClusterPlacementGroup

func (client ClusterPlacementGroupsCPClient) DeleteClusterPlacementGroup(ctx context.Context, request DeleteClusterPlacementGroupRequest) (response DeleteClusterPlacementGroupResponse, err error)

DeleteClusterPlacementGroup Deletes the specified cluster placement group.

See also

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

func (ClusterPlacementGroupsCPClient) GetClusterPlacementGroup

func (client ClusterPlacementGroupsCPClient) GetClusterPlacementGroup(ctx context.Context, request GetClusterPlacementGroupRequest) (response GetClusterPlacementGroupResponse, err error)

GetClusterPlacementGroup Gets the specified cluster placement group.

See also

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

func (ClusterPlacementGroupsCPClient) GetWorkRequest

func (client ClusterPlacementGroupsCPClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Gets details of the work request with the specified ID.

See also

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

func (ClusterPlacementGroupsCPClient) ListClusterPlacementGroups

func (client ClusterPlacementGroupsCPClient) ListClusterPlacementGroups(ctx context.Context, request ListClusterPlacementGroupsRequest) (response ListClusterPlacementGroupsResponse, err error)

ListClusterPlacementGroups Gets a list of all cluster placement groups in the specified compartment.

See also

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

func (ClusterPlacementGroupsCPClient) ListWorkRequestErrors

func (client ClusterPlacementGroupsCPClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Returns a (paginated) list of errors for the work request with the specified ID.

See also

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

func (ClusterPlacementGroupsCPClient) ListWorkRequestLogs

func (client ClusterPlacementGroupsCPClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Returns a (paginated) list of logs for the work request with the specified ID.

See also

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

func (ClusterPlacementGroupsCPClient) ListWorkRequests

func (client ClusterPlacementGroupsCPClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists all work requests in the specified compartment.

See also

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

func (*ClusterPlacementGroupsCPClient) SetRegion

func (client *ClusterPlacementGroupsCPClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (ClusterPlacementGroupsCPClient) UpdateClusterPlacementGroup

func (client ClusterPlacementGroupsCPClient) UpdateClusterPlacementGroup(ctx context.Context, request UpdateClusterPlacementGroupRequest) (response UpdateClusterPlacementGroupResponse, err error)

UpdateClusterPlacementGroup Updates the specified cluster placement group.

See also

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

type CreateClusterPlacementGroupDetails

type CreateClusterPlacementGroupDetails struct {

	// The friendly name of the cluster placement group.
	Name *string `mandatory:"true" json:"name"`

	// ClusterPlacementGroup Identifier.
	ClusterPlacementGroupType ClusterPlacementGroupTypeEnum `mandatory:"true" json:"clusterPlacementGroupType"`

	// A description of the cluster placement group.
	Description *string `mandatory:"true" json:"description"`

	// The availability domain where you want to create the cluster placement group.
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the cluster placement group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	PlacementInstruction *PlacementInstructionDetails `mandatory:"false" json:"placementInstruction"`

	Capabilities *CapabilitiesCollection `mandatory:"false" json:"capabilities"`

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

CreateClusterPlacementGroupDetails Detailed information about the new cluster placement group.

func (CreateClusterPlacementGroupDetails) String

func (CreateClusterPlacementGroupDetails) ValidateEnumValue

func (m CreateClusterPlacementGroupDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateClusterPlacementGroupRequest

type CreateClusterPlacementGroupRequest struct {

	// The details for creating the new cluster placement group.
	CreateClusterPlacementGroupDetails `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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// When set to `true`, the request performs validation on the submitted data without modifying configuration item details.
	OpcDryRun *bool `mandatory:"false" contributesTo:"header" name:"opc-dry-run"`

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

CreateClusterPlacementGroupRequest wrapper for the CreateClusterPlacementGroup operation

See also

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

func (CreateClusterPlacementGroupRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateClusterPlacementGroupRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateClusterPlacementGroupRequest) RetryPolicy

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

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

func (CreateClusterPlacementGroupRequest) String

func (request CreateClusterPlacementGroupRequest) String() string

func (CreateClusterPlacementGroupRequest) ValidateEnumValue

func (request CreateClusterPlacementGroupRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateClusterPlacementGroupResponse

type CreateClusterPlacementGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The URL for the created cluster placement group. The cluster placement group ID is generated after this request is sent.
	Location *string `presentIn:"header" name:"location"`

	// Same as location.
	ContentLocation *string `presentIn:"header" name:"content-location"`

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

	// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

CreateClusterPlacementGroupResponse wrapper for the CreateClusterPlacementGroup operation

func (CreateClusterPlacementGroupResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateClusterPlacementGroupResponse) String

func (response CreateClusterPlacementGroupResponse) String() string

type DeactivateClusterPlacementGroupRequest

type DeactivateClusterPlacementGroupRequest struct {

	// A unique cluster placement group identifier.
	ClusterPlacementGroupId *string `mandatory:"true" contributesTo:"path" name:"clusterPlacementGroupId"`

	// 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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. 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"`

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

DeactivateClusterPlacementGroupRequest wrapper for the DeactivateClusterPlacementGroup operation

See also

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

func (DeactivateClusterPlacementGroupRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeactivateClusterPlacementGroupRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeactivateClusterPlacementGroupRequest) RetryPolicy

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

func (DeactivateClusterPlacementGroupRequest) String

func (DeactivateClusterPlacementGroupRequest) ValidateEnumValue

func (request DeactivateClusterPlacementGroupRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeactivateClusterPlacementGroupResponse

type DeactivateClusterPlacementGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ClusterPlacementGroup instance
	ClusterPlacementGroup `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"`
}

DeactivateClusterPlacementGroupResponse wrapper for the DeactivateClusterPlacementGroup operation

func (DeactivateClusterPlacementGroupResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeactivateClusterPlacementGroupResponse) String

type DeleteClusterPlacementGroupRequest

type DeleteClusterPlacementGroupRequest struct {

	// A unique cluster placement group identifier.
	ClusterPlacementGroupId *string `mandatory:"true" contributesTo:"path" name:"clusterPlacementGroupId"`

	// 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.
	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
}

DeleteClusterPlacementGroupRequest wrapper for the DeleteClusterPlacementGroup operation

See also

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

func (DeleteClusterPlacementGroupRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteClusterPlacementGroupRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteClusterPlacementGroupRequest) RetryPolicy

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

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

func (DeleteClusterPlacementGroupRequest) String

func (request DeleteClusterPlacementGroupRequest) String() string

func (DeleteClusterPlacementGroupRequest) ValidateEnumValue

func (request DeleteClusterPlacementGroupRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteClusterPlacementGroupResponse

type DeleteClusterPlacementGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

DeleteClusterPlacementGroupResponse wrapper for the DeleteClusterPlacementGroup operation

func (DeleteClusterPlacementGroupResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteClusterPlacementGroupResponse) String

func (response DeleteClusterPlacementGroupResponse) String() string

type GetClusterPlacementGroupRequest

type GetClusterPlacementGroupRequest struct {

	// A unique cluster placement group identifier.
	ClusterPlacementGroupId *string `mandatory:"true" contributesTo:"path" name:"clusterPlacementGroupId"`

	// The client request ID for tracing.
	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
}

GetClusterPlacementGroupRequest wrapper for the GetClusterPlacementGroup operation

See also

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

func (GetClusterPlacementGroupRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetClusterPlacementGroupRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetClusterPlacementGroupRequest) RetryPolicy

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

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

func (GetClusterPlacementGroupRequest) String

func (request GetClusterPlacementGroupRequest) String() string

func (GetClusterPlacementGroupRequest) ValidateEnumValue

func (request GetClusterPlacementGroupRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetClusterPlacementGroupResponse

type GetClusterPlacementGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ClusterPlacementGroup instance
	ClusterPlacementGroup `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"`
}

GetClusterPlacementGroupResponse wrapper for the GetClusterPlacementGroup operation

func (GetClusterPlacementGroupResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetClusterPlacementGroupResponse) String

func (response GetClusterPlacementGroupResponse) String() string

type GetWorkRequestRequest

type GetWorkRequestRequest struct {

	// The ID of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// The client request ID for tracing.
	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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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

func (GetWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetWorkRequestResponse

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The WorkRequest instance
	WorkRequest `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"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type ListClusterPlacementGroupsRequest

type ListClusterPlacementGroupsRequest struct {

	// A filter to return only the resources that match the specified compartment OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only the resources that match the specified lifecycle state.
	LifecycleState ClusterPlacementGroupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return only the resources that match the entire display name specified.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// A filter to return only the resources that match the specified availability domain.
	Ad *string `mandatory:"false" contributesTo:"query" name:"ad"`

	// A filter to return only the resources that match the specified unique cluster placement group identifier.
	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 the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListClusterPlacementGroupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can specify only one sort order. The default order for `timeCreated` is descending. The default order for `name` is ascending.
	SortBy ListClusterPlacementGroupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// When set to `true`, cluster placement groups in all compartments under the specified compartment are returned. The default is set to `false`.
	CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`

	// The client request ID for tracing.
	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
}

ListClusterPlacementGroupsRequest wrapper for the ListClusterPlacementGroups operation

See also

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

func (ListClusterPlacementGroupsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListClusterPlacementGroupsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListClusterPlacementGroupsRequest) RetryPolicy

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

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

func (ListClusterPlacementGroupsRequest) String

func (request ListClusterPlacementGroupsRequest) String() string

func (ListClusterPlacementGroupsRequest) ValidateEnumValue

func (request ListClusterPlacementGroupsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListClusterPlacementGroupsResponse

type ListClusterPlacementGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ClusterPlacementGroupCollection instances
	ClusterPlacementGroupCollection `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 there are additional items to get. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items. For information about pagination, see List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListClusterPlacementGroupsResponse wrapper for the ListClusterPlacementGroups operation

func (ListClusterPlacementGroupsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListClusterPlacementGroupsResponse) String

func (response ListClusterPlacementGroupsResponse) String() string

type ListClusterPlacementGroupsSortByEnum

type ListClusterPlacementGroupsSortByEnum string

ListClusterPlacementGroupsSortByEnum Enum with underlying type: string

const (
	ListClusterPlacementGroupsSortByTimecreated ListClusterPlacementGroupsSortByEnum = "timeCreated"
	ListClusterPlacementGroupsSortByName        ListClusterPlacementGroupsSortByEnum = "name"
	ListClusterPlacementGroupsSortById          ListClusterPlacementGroupsSortByEnum = "id"
)

Set of constants representing the allowable values for ListClusterPlacementGroupsSortByEnum

func GetListClusterPlacementGroupsSortByEnumValues

func GetListClusterPlacementGroupsSortByEnumValues() []ListClusterPlacementGroupsSortByEnum

GetListClusterPlacementGroupsSortByEnumValues Enumerates the set of values for ListClusterPlacementGroupsSortByEnum

func GetMappingListClusterPlacementGroupsSortByEnum

func GetMappingListClusterPlacementGroupsSortByEnum(val string) (ListClusterPlacementGroupsSortByEnum, bool)

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

type ListClusterPlacementGroupsSortOrderEnum

type ListClusterPlacementGroupsSortOrderEnum string

ListClusterPlacementGroupsSortOrderEnum Enum with underlying type: string

const (
	ListClusterPlacementGroupsSortOrderAsc  ListClusterPlacementGroupsSortOrderEnum = "ASC"
	ListClusterPlacementGroupsSortOrderDesc ListClusterPlacementGroupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListClusterPlacementGroupsSortOrderEnum

func GetListClusterPlacementGroupsSortOrderEnumValues

func GetListClusterPlacementGroupsSortOrderEnumValues() []ListClusterPlacementGroupsSortOrderEnum

GetListClusterPlacementGroupsSortOrderEnumValues Enumerates the set of values for ListClusterPlacementGroupsSortOrderEnum

func GetMappingListClusterPlacementGroupsSortOrderEnum

func GetMappingListClusterPlacementGroupsSortOrderEnum(val string) (ListClusterPlacementGroupsSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest

type ListWorkRequestErrorsRequest struct {

	// The ID of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. You can specify only one sort order. The default order for `timestamp` is descending.
	SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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

func (ListWorkRequestErrorsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestErrorsResponse

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestErrorCollection instances
	WorkRequestErrorCollection `presentIn:"body"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then there are additional items to get. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items. For information about pagination, see List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest

type ListWorkRequestLogsRequest struct {

	// The ID of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. You can specify only one sort order. The default order for `timestamp` is descending.
	SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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

func (ListWorkRequestLogsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestLogsResponse

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestLogEntryCollection instances
	WorkRequestLogEntryCollection `presentIn:"body"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then there are additional items to get. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items. For information about pagination, see List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest

type ListWorkRequestsRequest struct {

	// A filter to return only the resources that match the specified compartment OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The ID of the asynchronous work request.
	WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`

	// A filter to return only resources with a lifecycle state that matches the specified operation status.
	Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`

	// The ID of the resource affected by the work request.
	ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can specify only one sort order. The default order for `timeAccepted` is descending.
	SortBy ListWorkRequestsSortByEnum `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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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

func (ListWorkRequestsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestsResponse

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestSummaryCollection instances
	WorkRequestSummaryCollection `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 there are additional items to get. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items. For information about pagination, see List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type ListWorkRequestsStatusEnum

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string

const (
	ListWorkRequestsStatusAccepted       ListWorkRequestsStatusEnum = "ACCEPTED"
	ListWorkRequestsStatusInProgress     ListWorkRequestsStatusEnum = "IN_PROGRESS"
	ListWorkRequestsStatusWaiting        ListWorkRequestsStatusEnum = "WAITING"
	ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
	ListWorkRequestsStatusFailed         ListWorkRequestsStatusEnum = "FAILED"
	ListWorkRequestsStatusSucceeded      ListWorkRequestsStatusEnum = "SUCCEEDED"
	ListWorkRequestsStatusCanceling      ListWorkRequestsStatusEnum = "CANCELING"
	ListWorkRequestsStatusCanceled       ListWorkRequestsStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

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

type OperationStatusEnum

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string

const (
	OperationStatusAccepted       OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress     OperationStatusEnum = "IN_PROGRESS"
	OperationStatusWaiting        OperationStatusEnum = "WAITING"
	OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
	OperationStatusFailed         OperationStatusEnum = "FAILED"
	OperationStatusSucceeded      OperationStatusEnum = "SUCCEEDED"
	OperationStatusCanceling      OperationStatusEnum = "CANCELING"
	OperationStatusCanceled       OperationStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string

const (
	OperationTypeCreateClusterPlacementGroup OperationTypeEnum = "CREATE_CLUSTER_PLACEMENT_GROUP"
	OperationTypeUpdateClusterPlacementGroup OperationTypeEnum = "UPDATE_CLUSTER_PLACEMENT_GROUP"
	OperationTypeDeleteClusterPlacementGroup OperationTypeEnum = "DELETE_CLUSTER_PLACEMENT_GROUP"
	OperationTypeMoveClusterPlacementGroup   OperationTypeEnum = "MOVE_CLUSTER_PLACEMENT_GROUP"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type PlacementInstructionDetails

type PlacementInstructionDetails struct {

	// The type of placement instruction.
	Type PlacementInstructionDetailsTypeEnum `mandatory:"true" json:"type"`

	// The value of the token designated for placement of the cluster placement group upon creation.
	Value *string `mandatory:"true" json:"value"`
}

PlacementInstructionDetails Details that inform cluster placement group provisioning.

func (PlacementInstructionDetails) String

func (PlacementInstructionDetails) ValidateEnumValue

func (m PlacementInstructionDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type PlacementInstructionDetailsTypeEnum

type PlacementInstructionDetailsTypeEnum string

PlacementInstructionDetailsTypeEnum Enum with underlying type: string

const (
	PlacementInstructionDetailsTypeToken PlacementInstructionDetailsTypeEnum = "TOKEN"
)

Set of constants representing the allowable values for PlacementInstructionDetailsTypeEnum

func GetMappingPlacementInstructionDetailsTypeEnum

func GetMappingPlacementInstructionDetailsTypeEnum(val string) (PlacementInstructionDetailsTypeEnum, bool)

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

func GetPlacementInstructionDetailsTypeEnumValues

func GetPlacementInstructionDetailsTypeEnumValues() []PlacementInstructionDetailsTypeEnum

GetPlacementInstructionDetailsTypeEnumValues Enumerates the set of values for PlacementInstructionDetailsTypeEnum

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type UpdateClusterPlacementGroupDetails

type UpdateClusterPlacementGroupDetails struct {

	// The description of the cluster placement group.
	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"`
}

UpdateClusterPlacementGroupDetails The information to update.

func (UpdateClusterPlacementGroupDetails) String

func (UpdateClusterPlacementGroupDetails) ValidateEnumValue

func (m UpdateClusterPlacementGroupDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateClusterPlacementGroupRequest

type UpdateClusterPlacementGroupRequest struct {

	// A unique cluster placement group identifier.
	ClusterPlacementGroupId *string `mandatory:"true" contributesTo:"path" name:"clusterPlacementGroupId"`

	// The details of the cluster placement group to update.
	UpdateClusterPlacementGroupDetails `contributesTo:"body"`

	// 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.
	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
}

UpdateClusterPlacementGroupRequest wrapper for the UpdateClusterPlacementGroup operation

See also

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

func (UpdateClusterPlacementGroupRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateClusterPlacementGroupRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateClusterPlacementGroupRequest) RetryPolicy

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

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

func (UpdateClusterPlacementGroupRequest) String

func (request UpdateClusterPlacementGroupRequest) String() string

func (UpdateClusterPlacementGroupRequest) ValidateEnumValue

func (request UpdateClusterPlacementGroupRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateClusterPlacementGroupResponse

type UpdateClusterPlacementGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

UpdateClusterPlacementGroupResponse wrapper for the UpdateClusterPlacementGroup operation

func (UpdateClusterPlacementGroupResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateClusterPlacementGroupResponse) String

func (response UpdateClusterPlacementGroupResponse) String() string

type WorkRequest

type WorkRequest struct {

	// The type of work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the work request.
	Status OperationStatusEnum `mandatory:"true" json:"status"`

	// The ID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests are scoped to
	// the same compartment as the resource that the work request affects. If the work request affects multiple resources
	// and those resources are not in the same compartment, the OCID of the resource designated as the primary
	// resource is used.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources affected by this work request.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// The percentage of the work request that is complete.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the request was created, as described in
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
	// section 14.29.
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// The date and time the object was updated, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

WorkRequest The status of a work request.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

func (m WorkRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestError

type WorkRequestError struct {

	// A machine-usable code for the error that occured. Error codes are listed on
	// (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm).
	Code *string `mandatory:"true" json:"code"`

	// A human-readable description of the issue encountered.
	Message *string `mandatory:"true" json:"message"`

	// The time the error occured, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

func (m WorkRequestError) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestErrorCollection

type WorkRequestErrorCollection struct {

	// A list of work request error objects.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection The results of a work request error search. Results contain both work request error items and other information, such as metadata.

func (WorkRequestErrorCollection) String

func (WorkRequestErrorCollection) ValidateEnumValue

func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestLogEntry

type WorkRequestLogEntry struct {

	// Human-readable log message.
	Message *string `mandatory:"true" json:"message"`

	// The time the log message was written, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestLogEntry A log message from the execution of a work request.

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestLogEntryCollection

type WorkRequestLogEntryCollection struct {

	// A list of work request log entries.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection The results of a work request log search. Results contain both work request log items and other information, such as metadata.

func (WorkRequestLogEntryCollection) String

func (WorkRequestLogEntryCollection) ValidateEnumValue

func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestResource

type WorkRequestResource struct {

	// The resource type that the work request affects.
	EntityType *string `mandatory:"true" json:"entityType"`

	// The way in which the resource is affected by the work tracked in the work request.
	// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
	// work is complete for that resource, at which point the state transitions to CREATED, UPDATED,
	// or DELETED, respectively.
	ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`

	// The identifier of the resource that the work request affects.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The URI path to which a client can send a GET to access the resource metadata.
	EntityUri *string `mandatory:"false" json:"entityUri"`

	// Additional information that helps to explain the resource.
	Metadata map[string]string `mandatory:"false" json:"metadata"`
}

WorkRequestResource The resource created or operated on by a work request.

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

func (m WorkRequestResource) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestResourceMetadataKeyEnum

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string

const (
	WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

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

func GetWorkRequestResourceMetadataKeyEnumValues

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary

type WorkRequestSummary struct {

	// The type of work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the work request.
	Status OperationStatusEnum `mandatory:"true" json:"status"`

	// The ID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests are scoped to
	// the same compartment as the resource that the work request affects. If the work request affects multiple resources
	// and those resources are not in the same compartment, the OCID of the resource designated as the primary
	// resource is used.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources affected by this work request.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// The percentage of the work request that is complete.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the request was created, as described in
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
	// section 14.29.
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// The date and time the object was updated, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

WorkRequestSummary A summary object that provides the metadata details of a work request.

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

func (m WorkRequestSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestSummaryCollection

type WorkRequestSummaryCollection struct {

	// A list of work request summary objects.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection The results of a work request search. Results contain both work request items and other information, such as metadata.

func (WorkRequestSummaryCollection) String

func (WorkRequestSummaryCollection) ValidateEnumValue

func (m WorkRequestSummaryCollection) 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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL