func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetBackupStateEnumStringValues() []string
GetBackupStateEnumStringValues Enumerates the set of values in String for BackupStateEnum
func GetDataNodeHostTypeEnumStringValues() []string
GetDataNodeHostTypeEnumStringValues Enumerates the set of values in String for DataNodeHostTypeEnum
func GetListOpensearchClusterBackupsSortByEnumStringValues() []string
GetListOpensearchClusterBackupsSortByEnumStringValues Enumerates the set of values in String for ListOpensearchClusterBackupsSortByEnum
func GetListOpensearchClusterBackupsSortOrderEnumStringValues() []string
GetListOpensearchClusterBackupsSortOrderEnumStringValues Enumerates the set of values in String for ListOpensearchClusterBackupsSortOrderEnum
func GetListOpensearchClustersSortByEnumStringValues() []string
GetListOpensearchClustersSortByEnumStringValues Enumerates the set of values in String for ListOpensearchClustersSortByEnum
func GetListOpensearchClustersSortOrderEnumStringValues() []string
GetListOpensearchClustersSortOrderEnumStringValues Enumerates the set of values in String for ListOpensearchClustersSortOrderEnum
func GetMasterNodeHostTypeEnumStringValues() []string
GetMasterNodeHostTypeEnumStringValues Enumerates the set of values in String for MasterNodeHostTypeEnum
func GetOpensearchClusterBackupBackupTypeEnumStringValues() []string
GetOpensearchClusterBackupBackupTypeEnumStringValues Enumerates the set of values in String for OpensearchClusterBackupBackupTypeEnum
func GetOpensearchClusterBackupLifecycleStateEnumStringValues() []string
GetOpensearchClusterBackupLifecycleStateEnumStringValues Enumerates the set of values in String for OpensearchClusterBackupLifecycleStateEnum
func GetOpensearchClusterLifecycleStateEnumStringValues() []string
GetOpensearchClusterLifecycleStateEnumStringValues Enumerates the set of values in String for OpensearchClusterLifecycleStateEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetSecurityModeEnumStringValues() []string
GetSecurityModeEnumStringValues Enumerates the set of values in String for SecurityModeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BackupEventDetails Details about a cluster backup event.
type BackupEventDetails struct {
// The OCID of the OpenSearch cluster for the cluster backup.
ClusterId *string `mandatory:"true" json:"clusterId"`
// The result of the cluster backup operation.
BackupState BackupStateEnum `mandatory:"true" json:"backupState"`
// The date and time the cluster backup event started. Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"true" json:"timeStarted"`
// The date and time the cluster backup event started. Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeEnded *common.SDKTime `mandatory:"true" json:"timeEnded"`
// The name of the cluster backup.
SnapshotName *string `mandatory:"false" json:"snapshotName"`
// The cluster backup size in GB.
BackupSize *float64 `mandatory:"false" json:"backupSize"`
}
func (m BackupEventDetails) String() string
func (m BackupEventDetails) 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
BackupOpensearchClusterDetails Information about an OpenSearch cluster backup.
type BackupOpensearchClusterDetails struct {
// The OCID of the compartment where the cluster backup is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the cluster backup. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
}
func (m BackupOpensearchClusterDetails) String() string
func (m BackupOpensearchClusterDetails) 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
BackupOpensearchClusterRequest wrapper for the BackupOpensearchCluster operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/BackupOpensearchCluster.go.html to see an example of how to use BackupOpensearchClusterRequest.
type BackupOpensearchClusterRequest struct {
// unique OpensearchCluster identifier
OpensearchClusterId *string `mandatory:"true" contributesTo:"path" name:"opensearchClusterId"`
// Backup the opensearch cluster details.
BackupOpensearchClusterDetails `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"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BackupOpensearchClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BackupOpensearchClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BackupOpensearchClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BackupOpensearchClusterRequest) String() string
func (request BackupOpensearchClusterRequest) 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
BackupOpensearchClusterResponse wrapper for the BackupOpensearchCluster operation
type BackupOpensearchClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
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"`
}
func (response BackupOpensearchClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BackupOpensearchClusterResponse) String() string
BackupStateEnum Enum with underlying type: string
type BackupStateEnum string
Set of constants representing the allowable values for BackupStateEnum
const (
BackupStateDeleted BackupStateEnum = "DELETED"
BackupStateSuccess BackupStateEnum = "SUCCESS"
BackupStateFailed BackupStateEnum = "FAILED"
)
func GetBackupStateEnumValues() []BackupStateEnum
GetBackupStateEnumValues Enumerates the set of values for BackupStateEnum
func GetMappingBackupStateEnum(val string) (BackupStateEnum, bool)
GetMappingBackupStateEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeOpensearchClusterBackupCompartmentDetails Details about the compartment that the cluster backup should move to.
type ChangeOpensearchClusterBackupCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
// into which the cluster backup should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeOpensearchClusterBackupCompartmentDetails) String() string
func (m ChangeOpensearchClusterBackupCompartmentDetails) 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
ChangeOpensearchClusterCompartmentDetails Details about the compartment that the OpenSearch cluster should move to.
type ChangeOpensearchClusterCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
// into which the cluster should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeOpensearchClusterCompartmentDetails) String() string
func (m ChangeOpensearchClusterCompartmentDetails) 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
CreateOpensearchClusterDetails The configuration details for a new OpenSearch cluster.
type CreateOpensearchClusterDetails struct {
// The name of the cluster. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment to create the cluster in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The version of the software the cluster is running.
SoftwareVersion *string `mandatory:"true" json:"softwareVersion"`
// The number of master nodes to configure for the cluster.
MasterNodeCount *int `mandatory:"true" json:"masterNodeCount"`
// The instance type for the cluster's master nodes.
MasterNodeHostType MasterNodeHostTypeEnum `mandatory:"true" json:"masterNodeHostType"`
// The number of OCPUs to configure for the cluser's master nodes.
MasterNodeHostOcpuCount *int `mandatory:"true" json:"masterNodeHostOcpuCount"`
// The amount of memory in GB, to configure per node for the cluster's master nodes.
MasterNodeHostMemoryGB *int `mandatory:"true" json:"masterNodeHostMemoryGB"`
// The number of data nodes to configure for the cluster.
DataNodeCount *int `mandatory:"true" json:"dataNodeCount"`
// TThe instance type for the cluster's data nodes.
DataNodeHostType DataNodeHostTypeEnum `mandatory:"true" json:"dataNodeHostType"`
// The number of OCPUs to configure for the cluster's data nodes.
DataNodeHostOcpuCount *int `mandatory:"true" json:"dataNodeHostOcpuCount"`
// The amount of memory in GB, to configure per node for the cluster's data nodes.
DataNodeHostMemoryGB *int `mandatory:"true" json:"dataNodeHostMemoryGB"`
// The amount of storage in GB, to configure per node for the cluster's data nodes.
DataNodeStorageGB *int `mandatory:"true" json:"dataNodeStorageGB"`
// The number of OpenSearch Dashboard nodes to configure for the cluster.
OpendashboardNodeCount *int `mandatory:"true" json:"opendashboardNodeCount"`
// The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.
OpendashboardNodeHostOcpuCount *int `mandatory:"true" json:"opendashboardNodeHostOcpuCount"`
// The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
OpendashboardNodeHostMemoryGB *int `mandatory:"true" json:"opendashboardNodeHostMemoryGB"`
// The OCID of the cluster's VCN.
VcnId *string `mandatory:"true" json:"vcnId"`
// The OCID of the cluster's subnet.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The OCID for the compartment where the cluster's VCN is located.
VcnCompartmentId *string `mandatory:"true" json:"vcnCompartmentId"`
// The OCID for the compartment where the cluster's subnet is located.
SubnetCompartmentId *string `mandatory:"true" json:"subnetCompartmentId"`
// The bare metal shape for the cluster's master nodes.
MasterNodeHostBareMetalShape *string `mandatory:"false" json:"masterNodeHostBareMetalShape"`
// The bare metal shape for the cluster's data nodes.
DataNodeHostBareMetalShape *string `mandatory:"false" json:"dataNodeHostBareMetalShape"`
// The security mode of the cluster.
SecurityMode SecurityModeEnum `mandatory:"false" json:"securityMode,omitempty"`
// The name of the master user that are used to manage security config
SecurityMasterUserName *string `mandatory:"false" json:"securityMasterUserName"`
// The password hash of the master user that are used to manage security config
SecurityMasterUserPasswordHash *string `mandatory:"false" json:"securityMasterUserPasswordHash"`
// 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"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m CreateOpensearchClusterDetails) String() string
func (m CreateOpensearchClusterDetails) 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
CreateOpensearchClusterRequest wrapper for the CreateOpensearchCluster operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/CreateOpensearchCluster.go.html to see an example of how to use CreateOpensearchClusterRequest.
type CreateOpensearchClusterRequest struct {
// Details for the new OpensearchCluster.
CreateOpensearchClusterDetails `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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateOpensearchClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOpensearchClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOpensearchClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOpensearchClusterRequest) String() string
func (request CreateOpensearchClusterRequest) 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
CreateOpensearchClusterResponse wrapper for the CreateOpensearchCluster operation
type CreateOpensearchClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
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"`
}
func (response CreateOpensearchClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOpensearchClusterResponse) String() string
DataNodeHostTypeEnum Enum with underlying type: string
type DataNodeHostTypeEnum string
Set of constants representing the allowable values for DataNodeHostTypeEnum
const (
DataNodeHostTypeFlex DataNodeHostTypeEnum = "FLEX"
DataNodeHostTypeBm DataNodeHostTypeEnum = "BM"
)
func GetDataNodeHostTypeEnumValues() []DataNodeHostTypeEnum
GetDataNodeHostTypeEnumValues Enumerates the set of values for DataNodeHostTypeEnum
func GetMappingDataNodeHostTypeEnum(val string) (DataNodeHostTypeEnum, bool)
GetMappingDataNodeHostTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteOpensearchClusterBackupRequest wrapper for the DeleteOpensearchClusterBackup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/DeleteOpensearchClusterBackup.go.html to see an example of how to use DeleteOpensearchClusterBackupRequest.
type DeleteOpensearchClusterBackupRequest struct {
// unique OpensearchClusterBackup identifier
OpensearchClusterBackupId *string `mandatory:"true" contributesTo:"path" name:"opensearchClusterBackupId"`
// 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
}
func (request DeleteOpensearchClusterBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOpensearchClusterBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOpensearchClusterBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOpensearchClusterBackupRequest) String() string
func (request DeleteOpensearchClusterBackupRequest) 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
DeleteOpensearchClusterBackupResponse wrapper for the DeleteOpensearchClusterBackup operation
type DeleteOpensearchClusterBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
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"`
}
func (response DeleteOpensearchClusterBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOpensearchClusterBackupResponse) String() string
DeleteOpensearchClusterRequest wrapper for the DeleteOpensearchCluster operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/DeleteOpensearchCluster.go.html to see an example of how to use DeleteOpensearchClusterRequest.
type DeleteOpensearchClusterRequest struct {
// unique OpensearchCluster identifier
OpensearchClusterId *string `mandatory:"true" contributesTo:"path" name:"opensearchClusterId"`
// 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
}
func (request DeleteOpensearchClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOpensearchClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOpensearchClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOpensearchClusterRequest) String() string
func (request DeleteOpensearchClusterRequest) 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
DeleteOpensearchClusterResponse wrapper for the DeleteOpensearchCluster operation
type DeleteOpensearchClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
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"`
}
func (response DeleteOpensearchClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOpensearchClusterResponse) String() string
ExportOpensearchClusterBackupDetails Information about the cluster backup to export.
type ExportOpensearchClusterBackupDetails struct {
// The Object Storage namespace for the cluster backup export operation.
ObjectStorageNamespace *string `mandatory:"true" json:"objectStorageNamespace"`
// The name of the Object Storage bucket for the cluster backup export operation.
ObjectStorageBucketName *string `mandatory:"true" json:"objectStorageBucketName"`
// The name of the snapshot for the cluster backup export operation.
SnapshotName *string `mandatory:"true" json:"snapshotName"`
// The name of the repository containing the snapshots for the cluster backup export operation.
RepositoryName *string `mandatory:"true" json:"repositoryName"`
// The prefix within object storage bucket for the cluster backup export operation.
Prefix *string `mandatory:"true" json:"prefix"`
// The OCID of the compartment where the Object Storage resources for the cluster backup are located.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The prefix within the Object Storage bucket for the cluster backup export operation.
ObjectStoragePrefix *string `mandatory:"false" json:"objectStoragePrefix"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ExportOpensearchClusterBackupDetails) String() string
func (m ExportOpensearchClusterBackupDetails) 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
GetManifestResponse The response returned for the get manifest call.
type GetManifestResponse struct {
// The serialized manifest response.
SerializedManifest *string `mandatory:"false" json:"serializedManifest"`
}
func (m GetManifestResponse) String() string
func (m GetManifestResponse) 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
GetOpensearchClusterBackupRequest wrapper for the GetOpensearchClusterBackup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/GetOpensearchClusterBackup.go.html to see an example of how to use GetOpensearchClusterBackupRequest.
type GetOpensearchClusterBackupRequest struct {
// unique OpensearchClusterBackup identifier
OpensearchClusterBackupId *string `mandatory:"true" contributesTo:"path" name:"opensearchClusterBackupId"`
// 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
}
func (request GetOpensearchClusterBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOpensearchClusterBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOpensearchClusterBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOpensearchClusterBackupRequest) String() string
func (request GetOpensearchClusterBackupRequest) 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
GetOpensearchClusterBackupResponse wrapper for the GetOpensearchClusterBackup operation
type GetOpensearchClusterBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// The OpensearchClusterBackup instance
OpensearchClusterBackup `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetOpensearchClusterBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOpensearchClusterBackupResponse) String() string
GetOpensearchClusterRequest wrapper for the GetOpensearchCluster operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/GetOpensearchCluster.go.html to see an example of how to use GetOpensearchClusterRequest.
type GetOpensearchClusterRequest struct {
// unique OpensearchCluster identifier
OpensearchClusterId *string `mandatory:"true" contributesTo:"path" name:"opensearchClusterId"`
// 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
}
func (request GetOpensearchClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOpensearchClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOpensearchClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOpensearchClusterRequest) String() string
func (request GetOpensearchClusterRequest) 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
GetOpensearchClusterResponse wrapper for the GetOpensearchCluster operation
type GetOpensearchClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The OpensearchCluster instance
OpensearchCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetOpensearchClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOpensearchClusterResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous 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
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
ListOpensearchClusterBackupsRequest wrapper for the ListOpensearchClusterBackups operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListOpensearchClusterBackups.go.html to see an example of how to use ListOpensearchClusterBackupsRequest.
type ListOpensearchClusterBackupsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState OpensearchClusterBackupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the entire source cluster id given.
SourceOpensearchClusterId *string `mandatory:"false" contributesTo:"query" name:"sourceOpensearchClusterId"`
// unique OpensearchClusterBackup identifier
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListOpensearchClusterBackupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListOpensearchClusterBackupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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
}
func (request ListOpensearchClusterBackupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOpensearchClusterBackupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOpensearchClusterBackupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOpensearchClusterBackupsRequest) String() string
func (request ListOpensearchClusterBackupsRequest) 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
ListOpensearchClusterBackupsResponse wrapper for the ListOpensearchClusterBackups operation
type ListOpensearchClusterBackupsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OpensearchClusterBackupCollection instances
OpensearchClusterBackupCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListOpensearchClusterBackupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOpensearchClusterBackupsResponse) String() string
ListOpensearchClusterBackupsSortByEnum Enum with underlying type: string
type ListOpensearchClusterBackupsSortByEnum string
Set of constants representing the allowable values for ListOpensearchClusterBackupsSortByEnum
const (
ListOpensearchClusterBackupsSortByTimecreated ListOpensearchClusterBackupsSortByEnum = "timeCreated"
ListOpensearchClusterBackupsSortByDisplayname ListOpensearchClusterBackupsSortByEnum = "displayName"
)
func GetListOpensearchClusterBackupsSortByEnumValues() []ListOpensearchClusterBackupsSortByEnum
GetListOpensearchClusterBackupsSortByEnumValues Enumerates the set of values for ListOpensearchClusterBackupsSortByEnum
func GetMappingListOpensearchClusterBackupsSortByEnum(val string) (ListOpensearchClusterBackupsSortByEnum, bool)
GetMappingListOpensearchClusterBackupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOpensearchClusterBackupsSortOrderEnum Enum with underlying type: string
type ListOpensearchClusterBackupsSortOrderEnum string
Set of constants representing the allowable values for ListOpensearchClusterBackupsSortOrderEnum
const (
ListOpensearchClusterBackupsSortOrderAsc ListOpensearchClusterBackupsSortOrderEnum = "ASC"
ListOpensearchClusterBackupsSortOrderDesc ListOpensearchClusterBackupsSortOrderEnum = "DESC"
)
func GetListOpensearchClusterBackupsSortOrderEnumValues() []ListOpensearchClusterBackupsSortOrderEnum
GetListOpensearchClusterBackupsSortOrderEnumValues Enumerates the set of values for ListOpensearchClusterBackupsSortOrderEnum
func GetMappingListOpensearchClusterBackupsSortOrderEnum(val string) (ListOpensearchClusterBackupsSortOrderEnum, bool)
GetMappingListOpensearchClusterBackupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOpensearchClustersRequest wrapper for the ListOpensearchClusters operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListOpensearchClusters.go.html to see an example of how to use ListOpensearchClustersRequest.
type ListOpensearchClustersRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
LifecycleState OpensearchClusterLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// unique OpensearchCluster identifier
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListOpensearchClustersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListOpensearchClustersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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
}
func (request ListOpensearchClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOpensearchClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOpensearchClustersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOpensearchClustersRequest) String() string
func (request ListOpensearchClustersRequest) 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
ListOpensearchClustersResponse wrapper for the ListOpensearchClusters operation
type ListOpensearchClustersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OpensearchClusterCollection instances
OpensearchClusterCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListOpensearchClustersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOpensearchClustersResponse) String() string
ListOpensearchClustersSortByEnum Enum with underlying type: string
type ListOpensearchClustersSortByEnum string
Set of constants representing the allowable values for ListOpensearchClustersSortByEnum
const (
ListOpensearchClustersSortByTimecreated ListOpensearchClustersSortByEnum = "timeCreated"
ListOpensearchClustersSortByDisplayname ListOpensearchClustersSortByEnum = "displayName"
)
func GetListOpensearchClustersSortByEnumValues() []ListOpensearchClustersSortByEnum
GetListOpensearchClustersSortByEnumValues Enumerates the set of values for ListOpensearchClustersSortByEnum
func GetMappingListOpensearchClustersSortByEnum(val string) (ListOpensearchClustersSortByEnum, bool)
GetMappingListOpensearchClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOpensearchClustersSortOrderEnum Enum with underlying type: string
type ListOpensearchClustersSortOrderEnum string
Set of constants representing the allowable values for ListOpensearchClustersSortOrderEnum
const (
ListOpensearchClustersSortOrderAsc ListOpensearchClustersSortOrderEnum = "ASC"
ListOpensearchClustersSortOrderDesc ListOpensearchClustersSortOrderEnum = "DESC"
)
func GetListOpensearchClustersSortOrderEnumValues() []ListOpensearchClustersSortOrderEnum
GetListOpensearchClustersSortOrderEnumValues Enumerates the set of values for ListOpensearchClustersSortOrderEnum
func GetMappingListOpensearchClustersSortOrderEnum(val string) (ListOpensearchClustersSortOrderEnum, bool)
GetMappingListOpensearchClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOpensearchVersionsRequest wrapper for the ListOpensearchVersions operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListOpensearchVersions.go.html to see an example of how to use ListOpensearchVersionsRequest.
type ListOpensearchVersionsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOpensearchVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOpensearchVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOpensearchVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOpensearchVersionsRequest) String() string
func (request ListOpensearchVersionsRequest) 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
ListOpensearchVersionsResponse wrapper for the ListOpensearchVersions operation
type ListOpensearchVersionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OpensearchVersionsCollection instances
OpensearchVersionsCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListOpensearchVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOpensearchVersionsResponse) String() string
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous 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"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
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 a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous 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"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
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 a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// The ID of the source resource to list work requests.
SourceResourceId *string `mandatory:"false" contributesTo:"query" name:"sourceResourceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestCollection instances
WorkRequestCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
MasterNodeHostTypeEnum Enum with underlying type: string
type MasterNodeHostTypeEnum string
Set of constants representing the allowable values for MasterNodeHostTypeEnum
const (
MasterNodeHostTypeFlex MasterNodeHostTypeEnum = "FLEX"
MasterNodeHostTypeBm MasterNodeHostTypeEnum = "BM"
)
func GetMappingMasterNodeHostTypeEnum(val string) (MasterNodeHostTypeEnum, bool)
GetMappingMasterNodeHostTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMasterNodeHostTypeEnumValues() []MasterNodeHostTypeEnum
GetMasterNodeHostTypeEnumValues Enumerates the set of values for MasterNodeHostTypeEnum
OpensearchCluster An OpenSearch cluster resource. An OpenSearch cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see About Search Service with OpenSearch (https://docs.cloud.oracle.com/iaas/Content/search-opensearch/Concepts/ociopensearch.htm).
type OpensearchCluster struct {
// The OCID of the cluster.
Id *string `mandatory:"true" json:"id"`
// The name of the cluster. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment where the cluster is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The current state of the cluster.
LifecycleState OpensearchClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The amount of time in milliseconds since the cluster was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The software version the cluster is running.
SoftwareVersion *string `mandatory:"true" json:"softwareVersion"`
// The size in GB of the cluster's total storage.
TotalStorageGB *int `mandatory:"true" json:"totalStorageGB"`
// The fully qualified domain name (FQDN) for the cluster's API endpoint.
OpensearchFqdn *string `mandatory:"true" json:"opensearchFqdn"`
// The cluster's private IP address.
OpensearchPrivateIp *string `mandatory:"true" json:"opensearchPrivateIp"`
// The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.
OpendashboardFqdn *string `mandatory:"true" json:"opendashboardFqdn"`
// The private IP address for the cluster's OpenSearch Dashboard.
OpendashboardPrivateIp *string `mandatory:"true" json:"opendashboardPrivateIp"`
// The number of master nodes configured for the cluster.
MasterNodeCount *int `mandatory:"true" json:"masterNodeCount"`
// The instance type for the cluster's master nodes.
MasterNodeHostType MasterNodeHostTypeEnum `mandatory:"true" json:"masterNodeHostType"`
// The number of OCPUs configured for cluster's master nodes.
MasterNodeHostOcpuCount *int `mandatory:"true" json:"masterNodeHostOcpuCount"`
// The amount of memory in GB, for the cluster's master nodes.
MasterNodeHostMemoryGB *int `mandatory:"true" json:"masterNodeHostMemoryGB"`
// The number of data nodes configured for the cluster.
DataNodeCount *int `mandatory:"true" json:"dataNodeCount"`
// The instance type for the cluster's data nodes.
DataNodeHostType DataNodeHostTypeEnum `mandatory:"true" json:"dataNodeHostType"`
// The number of OCPUs configured for the cluster's data nodes.
DataNodeHostOcpuCount *int `mandatory:"true" json:"dataNodeHostOcpuCount"`
// The amount of memory in GB, for the cluster's data nodes.
DataNodeHostMemoryGB *int `mandatory:"true" json:"dataNodeHostMemoryGB"`
// The amount of storage in GB, to configure per node for the cluster's data nodes.
DataNodeStorageGB *int `mandatory:"true" json:"dataNodeStorageGB"`
// The number of OpenSearch Dashboard nodes configured for the cluster.
OpendashboardNodeCount *int `mandatory:"true" json:"opendashboardNodeCount"`
// The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
OpendashboardNodeHostOcpuCount *int `mandatory:"true" json:"opendashboardNodeHostOcpuCount"`
// The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
OpendashboardNodeHostMemoryGB *int `mandatory:"true" json:"opendashboardNodeHostMemoryGB"`
// The OCID of the cluster's VCN.
VcnId *string `mandatory:"true" json:"vcnId"`
// The OCID of the cluster's subnet.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The OCID for the compartment where the cluster's VCN is located.
VcnCompartmentId *string `mandatory:"true" json:"vcnCompartmentId"`
// The OCID for the compartment where the cluster's subnet is located.
SubnetCompartmentId *string `mandatory:"true" json:"subnetCompartmentId"`
// The availability domains to distribute the cluser nodes across.
AvailabilityDomains []string `mandatory:"true" json:"availabilityDomains"`
// The amount of time in milliseconds since the cluster was updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The amount of time in milliseconds since the cluster was updated.
TimeDeleted *common.SDKTime `mandatory:"false" json:"timeDeleted"`
// Additional information about the current lifecycle state of the cluster.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The bare metal shape for the cluster's master nodes.
MasterNodeHostBareMetalShape *string `mandatory:"false" json:"masterNodeHostBareMetalShape"`
// The bare metal shape for the cluster's data nodes.
DataNodeHostBareMetalShape *string `mandatory:"false" json:"dataNodeHostBareMetalShape"`
// The fully qualified domain name (FQDN) for the cluster's API endpoint.
Fqdn *string `mandatory:"false" json:"fqdn"`
// The security mode of the cluster.
SecurityMode SecurityModeEnum `mandatory:"false" json:"securityMode,omitempty"`
// The name of the master user that are used to manage security config
SecurityMasterUserName *string `mandatory:"false" json:"securityMasterUserName"`
// The password hash of the master user that are used to manage security config
SecurityMasterUserPasswordHash *string `mandatory:"false" json:"securityMasterUserPasswordHash"`
}
func (m OpensearchCluster) String() string
func (m OpensearchCluster) 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
OpensearchClusterBackup An OpenSearch cluster backup resource. An cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see Cluster Backups (https://docs.cloud.oracle.com/iaas/Content/search-opensearch/Concepts/ociopensearchbackups.htm).
type OpensearchClusterBackup struct {
// The OCID of the cluster backup.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment where the cluster backup is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.
BackupType OpensearchClusterBackupBackupTypeEnum `mandatory:"true" json:"backupType"`
// The current state of the cluster backup.
LifecycleState OpensearchClusterBackupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the source OpenSearch cluster for the cluster backup.
SourceClusterId *string `mandatory:"true" json:"sourceClusterId"`
// The name of the cluster backup. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time the cluster backup was created. Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the cluster backup was updated. Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Additional information about the current lifecycle state of the cluster backup.
LifecyleDetails *string `mandatory:"false" json:"lifecyleDetails"`
// The Object Storage namespace for the cluster backup.
Namespace *string `mandatory:"false" json:"namespace"`
// The name of the Object Storage bucket for the cluster backup.
BucketName *string `mandatory:"false" json:"bucketName"`
// The prefix within the Object Storage bucket for the cluster backup.
Prefix *string `mandatory:"false" json:"prefix"`
// The date and time the cluster backup expires. Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeExpired *common.SDKTime `mandatory:"false" json:"timeExpired"`
// The size in GB of the cluster backup.
BackupSize *float64 `mandatory:"false" json:"backupSize"`
// The name of the source OpenSearch cluster for the cluster backup.
SourceClusterDisplayName *string `mandatory:"false" json:"sourceClusterDisplayName"`
// 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"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m OpensearchClusterBackup) String() string
func (m OpensearchClusterBackup) 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
OpensearchClusterBackupBackupTypeEnum Enum with underlying type: string
type OpensearchClusterBackupBackupTypeEnum string
Set of constants representing the allowable values for OpensearchClusterBackupBackupTypeEnum
const (
OpensearchClusterBackupBackupTypeScheduled OpensearchClusterBackupBackupTypeEnum = "SCHEDULED"
OpensearchClusterBackupBackupTypeManual OpensearchClusterBackupBackupTypeEnum = "MANUAL"
)
func GetMappingOpensearchClusterBackupBackupTypeEnum(val string) (OpensearchClusterBackupBackupTypeEnum, bool)
GetMappingOpensearchClusterBackupBackupTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOpensearchClusterBackupBackupTypeEnumValues() []OpensearchClusterBackupBackupTypeEnum
GetOpensearchClusterBackupBackupTypeEnumValues Enumerates the set of values for OpensearchClusterBackupBackupTypeEnum
OpensearchClusterBackupClient a client for OpensearchClusterBackup
type OpensearchClusterBackupClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewOpensearchClusterBackupClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OpensearchClusterBackupClient, err error)
NewOpensearchClusterBackupClientWithConfigurationProvider Creates a new default OpensearchClusterBackup client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOpensearchClusterBackupClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OpensearchClusterBackupClient, err error)
NewOpensearchClusterBackupClientWithOboToken Creates a new default OpensearchClusterBackup client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *OpensearchClusterBackupClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OpensearchClusterBackupClient) DeleteOpensearchClusterBackup(ctx context.Context, request DeleteOpensearchClusterBackupRequest) (response DeleteOpensearchClusterBackupResponse, err error)
DeleteOpensearchClusterBackup Deletes a OpensearchClusterBackup resource by identifier
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/DeleteOpensearchClusterBackup.go.html to see an example of how to use DeleteOpensearchClusterBackup API.
func (client OpensearchClusterBackupClient) GetOpensearchClusterBackup(ctx context.Context, request GetOpensearchClusterBackupRequest) (response GetOpensearchClusterBackupResponse, err error)
GetOpensearchClusterBackup Gets a OpensearchClusterBackup by identifier
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/GetOpensearchClusterBackup.go.html to see an example of how to use GetOpensearchClusterBackup API.
func (client OpensearchClusterBackupClient) ListOpensearchClusterBackups(ctx context.Context, request ListOpensearchClusterBackupsRequest) (response ListOpensearchClusterBackupsResponse, err error)
ListOpensearchClusterBackups Returns a list of OpensearchClusterBackups.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListOpensearchClusterBackups.go.html to see an example of how to use ListOpensearchClusterBackups API.
func (client *OpensearchClusterBackupClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client OpensearchClusterBackupClient) UpdateOpensearchClusterBackup(ctx context.Context, request UpdateOpensearchClusterBackupRequest) (response UpdateOpensearchClusterBackupResponse, err error)
UpdateOpensearchClusterBackup Updates the OpensearchClusterBackup
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/UpdateOpensearchClusterBackup.go.html to see an example of how to use UpdateOpensearchClusterBackup API.
OpensearchClusterBackupCollection The list of cluster backups returned in a cluster backup search.
type OpensearchClusterBackupCollection struct {
// The list of cluster backups.
Items []OpensearchClusterBackupSummary `mandatory:"true" json:"items"`
}
func (m OpensearchClusterBackupCollection) String() string
func (m OpensearchClusterBackupCollection) 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
OpensearchClusterBackupLifecycleStateEnum Enum with underlying type: string
type OpensearchClusterBackupLifecycleStateEnum string
Set of constants representing the allowable values for OpensearchClusterBackupLifecycleStateEnum
const (
OpensearchClusterBackupLifecycleStateCreating OpensearchClusterBackupLifecycleStateEnum = "CREATING"
OpensearchClusterBackupLifecycleStateUpdating OpensearchClusterBackupLifecycleStateEnum = "UPDATING"
OpensearchClusterBackupLifecycleStateActive OpensearchClusterBackupLifecycleStateEnum = "ACTIVE"
OpensearchClusterBackupLifecycleStateDeleting OpensearchClusterBackupLifecycleStateEnum = "DELETING"
OpensearchClusterBackupLifecycleStateDeleted OpensearchClusterBackupLifecycleStateEnum = "DELETED"
OpensearchClusterBackupLifecycleStateFailed OpensearchClusterBackupLifecycleStateEnum = "FAILED"
)
func GetMappingOpensearchClusterBackupLifecycleStateEnum(val string) (OpensearchClusterBackupLifecycleStateEnum, bool)
GetMappingOpensearchClusterBackupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOpensearchClusterBackupLifecycleStateEnumValues() []OpensearchClusterBackupLifecycleStateEnum
GetOpensearchClusterBackupLifecycleStateEnumValues Enumerates the set of values for OpensearchClusterBackupLifecycleStateEnum
OpensearchClusterBackupSummary The summary of information about an OpenSearch cluster backup.
type OpensearchClusterBackupSummary struct {
// The OCID of the cluster backup.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment where the cluster backup is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.
BackupType OpensearchClusterBackupBackupTypeEnum `mandatory:"true" json:"backupType"`
// The OCID of the source OpenSearch cluster for the cluster backup.
SourceClusterId *string `mandatory:"true" json:"sourceClusterId"`
// The current state of the cluster backup.
LifecycleState OpensearchClusterBackupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The name of the cluster backup. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time the cluster backup was created. Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the cluster backup was updated. Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Additional information about the current lifecycle state of the cluster backup.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The date and time the cluster backup expires. Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeExpired *common.SDKTime `mandatory:"false" json:"timeExpired"`
// The size in GB of the cluster backup.
BackupSize *float64 `mandatory:"false" json:"backupSize"`
// The name of the source OpenSearch cluster for the cluster backup.
SourceClusterDisplayName *string `mandatory:"false" json:"sourceClusterDisplayName"`
// 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"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m OpensearchClusterBackupSummary) String() string
func (m OpensearchClusterBackupSummary) 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
OpensearchClusterClient a client for OpensearchCluster
type OpensearchClusterClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewOpensearchClusterClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OpensearchClusterClient, err error)
NewOpensearchClusterClientWithConfigurationProvider Creates a new default OpensearchCluster client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOpensearchClusterClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OpensearchClusterClient, err error)
NewOpensearchClusterClientWithOboToken Creates a new default OpensearchCluster client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client OpensearchClusterClient) BackupOpensearchCluster(ctx context.Context, request BackupOpensearchClusterRequest) (response BackupOpensearchClusterResponse, err error)
BackupOpensearchCluster Backup the opensearch cluster details.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/BackupOpensearchCluster.go.html to see an example of how to use BackupOpensearchCluster API.
func (client *OpensearchClusterClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OpensearchClusterClient) CreateOpensearchCluster(ctx context.Context, request CreateOpensearchClusterRequest) (response CreateOpensearchClusterResponse, err error)
CreateOpensearchCluster Creates a new OpensearchCluster.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/CreateOpensearchCluster.go.html to see an example of how to use CreateOpensearchCluster API.
func (client OpensearchClusterClient) DeleteOpensearchCluster(ctx context.Context, request DeleteOpensearchClusterRequest) (response DeleteOpensearchClusterResponse, err error)
DeleteOpensearchCluster Deletes a OpensearchCluster resource by identifier
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/DeleteOpensearchCluster.go.html to see an example of how to use DeleteOpensearchCluster API.
func (client OpensearchClusterClient) GetOpensearchCluster(ctx context.Context, request GetOpensearchClusterRequest) (response GetOpensearchClusterResponse, err error)
GetOpensearchCluster Gets a OpensearchCluster by identifier
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/GetOpensearchCluster.go.html to see an example of how to use GetOpensearchCluster API.
func (client OpensearchClusterClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
func (client OpensearchClusterClient) ListOpensearchClusters(ctx context.Context, request ListOpensearchClustersRequest) (response ListOpensearchClustersResponse, err error)
ListOpensearchClusters Returns a list of OpensearchClusters.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListOpensearchClusters.go.html to see an example of how to use ListOpensearchClusters API.
func (client OpensearchClusterClient) ListOpensearchVersions(ctx context.Context, request ListOpensearchVersionsRequest) (response ListOpensearchVersionsResponse, err error)
ListOpensearchVersions Lists the supported Opensearch versions
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListOpensearchVersions.go.html to see an example of how to use ListOpensearchVersions API.
func (client OpensearchClusterClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.
func (client OpensearchClusterClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.
func (client OpensearchClusterClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client OpensearchClusterClient) OpensearchClusterRestore(ctx context.Context, request OpensearchClusterRestoreRequest) (response OpensearchClusterRestoreResponse, err error)
OpensearchClusterRestore Restore the opensearch cluster details.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/OpensearchClusterRestore.go.html to see an example of how to use OpensearchClusterRestore API.
func (client OpensearchClusterClient) ResizeOpensearchClusterHorizontal(ctx context.Context, request ResizeOpensearchClusterHorizontalRequest) (response ResizeOpensearchClusterHorizontalResponse, err error)
ResizeOpensearchClusterHorizontal Resize the opensearch cluster horizontal details.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ResizeOpensearchClusterHorizontal.go.html to see an example of how to use ResizeOpensearchClusterHorizontal API.
func (client OpensearchClusterClient) ResizeOpensearchClusterVertical(ctx context.Context, request ResizeOpensearchClusterVerticalRequest) (response ResizeOpensearchClusterVerticalResponse, err error)
ResizeOpensearchClusterVertical Resize the opensearch cluster vertical details.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ResizeOpensearchClusterVertical.go.html to see an example of how to use ResizeOpensearchClusterVertical API.
func (client *OpensearchClusterClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client OpensearchClusterClient) UpdateOpensearchCluster(ctx context.Context, request UpdateOpensearchClusterRequest) (response UpdateOpensearchClusterResponse, err error)
UpdateOpensearchCluster Updates the OpensearchCluster
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/UpdateOpensearchCluster.go.html to see an example of how to use UpdateOpensearchCluster API.
OpensearchClusterCollection The list of OpenSearch clusters returned in a cluster search.
type OpensearchClusterCollection struct {
// The list of clusters.
Items []OpensearchClusterSummary `mandatory:"true" json:"items"`
}
func (m OpensearchClusterCollection) String() string
func (m OpensearchClusterCollection) 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
OpensearchClusterLifecycleStateEnum Enum with underlying type: string
type OpensearchClusterLifecycleStateEnum string
Set of constants representing the allowable values for OpensearchClusterLifecycleStateEnum
const (
OpensearchClusterLifecycleStateActive OpensearchClusterLifecycleStateEnum = "ACTIVE"
OpensearchClusterLifecycleStateCreating OpensearchClusterLifecycleStateEnum = "CREATING"
OpensearchClusterLifecycleStateUpdating OpensearchClusterLifecycleStateEnum = "UPDATING"
OpensearchClusterLifecycleStateDeleting OpensearchClusterLifecycleStateEnum = "DELETING"
OpensearchClusterLifecycleStateDeleted OpensearchClusterLifecycleStateEnum = "DELETED"
OpensearchClusterLifecycleStateFailed OpensearchClusterLifecycleStateEnum = "FAILED"
)
func GetMappingOpensearchClusterLifecycleStateEnum(val string) (OpensearchClusterLifecycleStateEnum, bool)
GetMappingOpensearchClusterLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOpensearchClusterLifecycleStateEnumValues() []OpensearchClusterLifecycleStateEnum
GetOpensearchClusterLifecycleStateEnumValues Enumerates the set of values for OpensearchClusterLifecycleStateEnum
OpensearchClusterRestoreRequest wrapper for the OpensearchClusterRestore operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/OpensearchClusterRestore.go.html to see an example of how to use OpensearchClusterRestoreRequest.
type OpensearchClusterRestoreRequest struct {
// unique OpensearchCluster identifier
OpensearchClusterId *string `mandatory:"true" contributesTo:"path" name:"opensearchClusterId"`
// Restore the opensearch cluster details.
RestoreOpensearchClusterDetails `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"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request OpensearchClusterRestoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request OpensearchClusterRestoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request OpensearchClusterRestoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request OpensearchClusterRestoreRequest) String() string
func (request OpensearchClusterRestoreRequest) 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
OpensearchClusterRestoreResponse wrapper for the OpensearchClusterRestore operation
type OpensearchClusterRestoreResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
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"`
}
func (response OpensearchClusterRestoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response OpensearchClusterRestoreResponse) String() string
OpensearchClusterSummary The summary of information about an OpenSearch cluster.
type OpensearchClusterSummary struct {
// The OCID of the cluster.
Id *string `mandatory:"true" json:"id"`
// The OCID for the compartment where the cluster is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The software version the cluster is running.
SoftwareVersion *string `mandatory:"true" json:"softwareVersion"`
// The total amount of storage in GB, for the cluster.
TotalStorageGB *int `mandatory:"true" json:"totalStorageGB"`
// The name of the cluster. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time the cluster was created. Format defined
// by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the cluster was updated. Format defined
// by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Additional information about the current lifecycle state of the cluster.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The current state of the cluster.
LifecycleState OpensearchClusterLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The availability domains to distribute the cluser nodes across.
AvailabilityDomains []string `mandatory:"false" json:"availabilityDomains"`
// The security mode of the cluster.
SecurityMode SecurityModeEnum `mandatory:"false" json:"securityMode,omitempty"`
}
func (m OpensearchClusterSummary) String() string
func (m OpensearchClusterSummary) 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
OpensearchVersionsCollection The list of OpenSearch versions returned in an OpenSearch version search.
type OpensearchVersionsCollection struct {
// A list of OpenSearch versions.
Items []OpensearchVersionsSummary `mandatory:"true" json:"items"`
}
func (m OpensearchVersionsCollection) String() string
func (m OpensearchVersionsCollection) 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
OpensearchVersionsSummary A description of Opensearch versions
type OpensearchVersionsSummary struct {
// The version of OpenSearch.
Version *string `mandatory:"true" json:"version"`
}
func (m OpensearchVersionsSummary) String() string
func (m OpensearchVersionsSummary) 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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateOpensearchCluster OperationTypeEnum = "CREATE_OPENSEARCH_CLUSTER"
OperationTypeUpdateOpensearchCluster OperationTypeEnum = "UPDATE_OPENSEARCH_CLUSTER"
OperationTypeDeleteOpensearchCluster OperationTypeEnum = "DELETE_OPENSEARCH_CLUSTER"
OperationTypeMoveOpensearchCluster OperationTypeEnum = "MOVE_OPENSEARCH_CLUSTER"
OperationTypeRestoreOpensearchCluster OperationTypeEnum = "RESTORE_OPENSEARCH_CLUSTER"
OperationTypeBackupOpensearchCluster OperationTypeEnum = "BACKUP_OPENSEARCH_CLUSTER"
OperationTypeUpdateOpensearchClusterBackup OperationTypeEnum = "UPDATE_OPENSEARCH_CLUSTER_BACKUP"
OperationTypeMoveOpensearchClusterBackup OperationTypeEnum = "MOVE_OPENSEARCH_CLUSTER_BACKUP"
OperationTypeDeleteOpensearchClusterBackup OperationTypeEnum = "DELETE_OPENSEARCH_CLUSTER_BACKUP"
OperationTypeUpdateOpensearchClusterSecurityConfig OperationTypeEnum = "UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
ResizeOpensearchClusterHorizontalDetails The node count configuration to update on an existing OpenSearch cluster for horizontal resizing (https://docs.cloud.oracle.com/iaas/Content/search-opensearch/Tasks/resizingacluster.htm#horizontalresize).
type ResizeOpensearchClusterHorizontalDetails struct {
// The number of master nodes to configure for the cluster.
MasterNodeCount *int `mandatory:"false" json:"masterNodeCount"`
// The number of data nodes to configure for the cluster.
DataNodeCount *int `mandatory:"false" json:"dataNodeCount"`
// The number of OpenSearch Dashboard nodes to configure for the cluster.
OpendashboardNodeCount *int `mandatory:"false" json:"opendashboardNodeCount"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ResizeOpensearchClusterHorizontalDetails) String() string
func (m ResizeOpensearchClusterHorizontalDetails) 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
ResizeOpensearchClusterHorizontalRequest wrapper for the ResizeOpensearchClusterHorizontal operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ResizeOpensearchClusterHorizontal.go.html to see an example of how to use ResizeOpensearchClusterHorizontalRequest.
type ResizeOpensearchClusterHorizontalRequest struct {
// unique OpensearchCluster identifier
OpensearchClusterId *string `mandatory:"true" contributesTo:"path" name:"opensearchClusterId"`
// Resize the opensearch cluster horizontal details.
ResizeOpensearchClusterHorizontalDetails `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"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ResizeOpensearchClusterHorizontalRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ResizeOpensearchClusterHorizontalRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ResizeOpensearchClusterHorizontalRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ResizeOpensearchClusterHorizontalRequest) String() string
func (request ResizeOpensearchClusterHorizontalRequest) 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
ResizeOpensearchClusterHorizontalResponse wrapper for the ResizeOpensearchClusterHorizontal operation
type ResizeOpensearchClusterHorizontalResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
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"`
}
func (response ResizeOpensearchClusterHorizontalResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ResizeOpensearchClusterHorizontalResponse) String() string
ResizeOpensearchClusterVerticalDetails The OCPU and memory configuration to update on an existing OpenSearch cluster for vertical resizing (https://docs.cloud.oracle.com/iaas/Content/search-opensearch/Tasks/resizingacluster.htm#vertical).
type ResizeOpensearchClusterVerticalDetails struct {
// The number of OCPUs to configure for the cluster's master nodes.
MasterNodeHostOcpuCount *int `mandatory:"false" json:"masterNodeHostOcpuCount"`
// The amount of memory in GB, to configure for the cluster's master nodes.
MasterNodeHostMemoryGB *int `mandatory:"false" json:"masterNodeHostMemoryGB"`
// The number of OCPUs to configure for the cluster's data nodes.
DataNodeHostOcpuCount *int `mandatory:"false" json:"dataNodeHostOcpuCount"`
// The amount of memory in GB, to configure for the cluster's data nodes.
DataNodeHostMemoryGB *int `mandatory:"false" json:"dataNodeHostMemoryGB"`
// The amount of storage in GB, to configure per node for the cluster's data nodes.
DataNodeStorageGB *int `mandatory:"false" json:"dataNodeStorageGB"`
// The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.
OpendashboardNodeHostOcpuCount *int `mandatory:"false" json:"opendashboardNodeHostOcpuCount"`
// The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
OpendashboardNodeHostMemoryGB *int `mandatory:"false" json:"opendashboardNodeHostMemoryGB"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ResizeOpensearchClusterVerticalDetails) String() string
func (m ResizeOpensearchClusterVerticalDetails) 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
ResizeOpensearchClusterVerticalRequest wrapper for the ResizeOpensearchClusterVertical operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/ResizeOpensearchClusterVertical.go.html to see an example of how to use ResizeOpensearchClusterVerticalRequest.
type ResizeOpensearchClusterVerticalRequest struct {
// unique OpensearchCluster identifier
OpensearchClusterId *string `mandatory:"true" contributesTo:"path" name:"opensearchClusterId"`
// Resize the opensearch cluster vertical details.
ResizeOpensearchClusterVerticalDetails `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"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ResizeOpensearchClusterVerticalRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ResizeOpensearchClusterVerticalRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ResizeOpensearchClusterVerticalRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ResizeOpensearchClusterVerticalRequest) String() string
func (request ResizeOpensearchClusterVerticalRequest) 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
ResizeOpensearchClusterVerticalResponse wrapper for the ResizeOpensearchClusterVertical operation
type ResizeOpensearchClusterVerticalResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
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"`
}
func (response ResizeOpensearchClusterVerticalResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ResizeOpensearchClusterVerticalResponse) String() string
RestoreOpensearchClusterBackupDetails Information about the source OpenSearch cluster to restore the cluster backup from.
type RestoreOpensearchClusterBackupDetails struct {
// The name of the source OpenSearch cluster for the cluster backup.
ClusterId *string `mandatory:"true" json:"clusterId"`
}
func (m RestoreOpensearchClusterBackupDetails) String() string
func (m RestoreOpensearchClusterBackupDetails) 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
RestoreOpensearchClusterDetails Information about the OpenSearch cluster backup to restore.
type RestoreOpensearchClusterDetails struct {
// The OCID of the cluster backup to restore.
OpensearchClusterBackupId *string `mandatory:"true" json:"opensearchClusterBackupId"`
// The OCID of the compartment where the cluster backup is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The prefix for the indices in the cluster backup.
Prefix *string `mandatory:"false" json:"prefix"`
}
func (m RestoreOpensearchClusterDetails) String() string
func (m RestoreOpensearchClusterDetails) 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
SecurityModeEnum Enum with underlying type: string
type SecurityModeEnum string
Set of constants representing the allowable values for SecurityModeEnum
const (
SecurityModeDisabled SecurityModeEnum = "DISABLED"
SecurityModePermissive SecurityModeEnum = "PERMISSIVE"
SecurityModeEnforcing SecurityModeEnum = "ENFORCING"
)
func GetMappingSecurityModeEnum(val string) (SecurityModeEnum, bool)
GetMappingSecurityModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSecurityModeEnumValues() []SecurityModeEnum
GetSecurityModeEnumValues Enumerates the set of values for SecurityModeEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
UpdateCheckinDetails Information about the update checkin event.
type UpdateCheckinDetails struct {
// The OCID of the OpenSearch cluster.
ClusterId *string `mandatory:"true" json:"clusterId"`
}
func (m UpdateCheckinDetails) String() string
func (m UpdateCheckinDetails) 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
UpdateClusterHardenedImageDetails Information about the cluster's hardened image.
type UpdateClusterHardenedImageDetails struct {
// The OCID of the OpenSearch cluster.
ClusterId *string `mandatory:"true" json:"clusterId"`
}
func (m UpdateClusterHardenedImageDetails) String() string
func (m UpdateClusterHardenedImageDetails) 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
UpdateClusterStatusDetails Information about the update cluster event.
type UpdateClusterStatusDetails struct {
// The OCID of the OpenSearch cluster.
ClusterId *string `mandatory:"true" json:"clusterId"`
// The state of the cluster after the cluster was updated.
LifecycleState *string `mandatory:"true" json:"lifecycleState"`
}
func (m UpdateClusterStatusDetails) String() string
func (m UpdateClusterStatusDetails) 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
UpdateOpensearchClusterBackupDetails Information about the cluster backup to update.
type UpdateOpensearchClusterBackupDetails struct {
// The name of the cluster backup.
DisplayName *string `mandatory:"true" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateOpensearchClusterBackupDetails) String() string
func (m UpdateOpensearchClusterBackupDetails) 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
UpdateOpensearchClusterBackupRequest wrapper for the UpdateOpensearchClusterBackup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/UpdateOpensearchClusterBackup.go.html to see an example of how to use UpdateOpensearchClusterBackupRequest.
type UpdateOpensearchClusterBackupRequest struct {
// unique OpensearchClusterBackup identifier
OpensearchClusterBackupId *string `mandatory:"true" contributesTo:"path" name:"opensearchClusterBackupId"`
// Update the opensearch cluster backup details.
UpdateOpensearchClusterBackupDetails `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
}
func (request UpdateOpensearchClusterBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOpensearchClusterBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOpensearchClusterBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOpensearchClusterBackupRequest) String() string
func (request UpdateOpensearchClusterBackupRequest) 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
UpdateOpensearchClusterBackupResponse wrapper for the UpdateOpensearchClusterBackup operation
type UpdateOpensearchClusterBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
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"`
}
func (response UpdateOpensearchClusterBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOpensearchClusterBackupResponse) String() string
UpdateOpensearchClusterDetails The configuration to update on an existing OpenSearch cluster. Software version and security config are not allowed to be updated at the same time.
type UpdateOpensearchClusterDetails struct {
// The name of the cluster. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
SoftwareVersion *string `mandatory:"false" json:"softwareVersion"`
// The security mode of the cluster.
SecurityMode SecurityModeEnum `mandatory:"false" json:"securityMode,omitempty"`
// The name of the master user that are used to manage security config
SecurityMasterUserName *string `mandatory:"false" json:"securityMasterUserName"`
// The password hash of the master user that are used to manage security config
SecurityMasterUserPasswordHash *string `mandatory:"false" json:"securityMasterUserPasswordHash"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateOpensearchClusterDetails) String() string
func (m UpdateOpensearchClusterDetails) 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
UpdateOpensearchClusterRequest wrapper for the UpdateOpensearchCluster operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/opensearch/UpdateOpensearchCluster.go.html to see an example of how to use UpdateOpensearchClusterRequest.
type UpdateOpensearchClusterRequest struct {
// unique OpensearchCluster identifier
OpensearchClusterId *string `mandatory:"true" contributesTo:"path" name:"opensearchClusterId"`
// Update the opensearch cluster details.
UpdateOpensearchClusterDetails `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
}
func (request UpdateOpensearchClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOpensearchClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOpensearchClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOpensearchClusterRequest) String() string
func (request UpdateOpensearchClusterRequest) 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
UpdateOpensearchClusterResponse wrapper for the UpdateOpensearchCluster operation
type UpdateOpensearchClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
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"`
}
func (response UpdateOpensearchClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOpensearchClusterResponse) String() string
WorkRequest An asynchronous work request.
type WorkRequest struct {
// The type of operation that spawned the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// The percentage complete of the operation tracked by the work request.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
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
WorkRequestCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type WorkRequestCollection struct {
// List of workRequests.
Items []WorkRequest `mandatory:"true" json:"items"`
}
func (m WorkRequestCollection) String() string
func (m WorkRequestCollection) 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
WorkRequestError An error encountered while executing an operation that is tracked by a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. For a list of error codes, see API Errors (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable string describing the error that occurred.
Message *string `mandatory:"true" json:"message"`
// The day and time the error occured, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
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
WorkRequestErrorCollection The list of work request errors returned in a work request error search.
type WorkRequestErrorCollection struct {
// A list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
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
WorkRequestLogEntry A log message from executing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The day and time the log message was written, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
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
WorkRequestLogEntryCollection The list of work request log entries returned in a work request log search.
type WorkRequestLogEntryCollection struct {
// A list of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
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
WorkRequestResource A resource that is created or operated on by an asynchronous operation that is tracked by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The OCID of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you can use for a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
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