opensearch

package
v65.71.0 Latest Latest
Warning

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

 Go to latest Published: Aug 6, 2024 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues 

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetBackupStateEnumStringValues 

func GetBackupStateEnumStringValues() []string

GetBackupStateEnumStringValues Enumerates the set of values in String for BackupStateEnum

func GetDataNodeHostTypeEnumStringValues 

func GetDataNodeHostTypeEnumStringValues() []string

GetDataNodeHostTypeEnumStringValues Enumerates the set of values in String for DataNodeHostTypeEnum

func GetListOpensearchClusterBackupsSortByEnumStringValues 

func GetListOpensearchClusterBackupsSortByEnumStringValues() []string

GetListOpensearchClusterBackupsSortByEnumStringValues Enumerates the set of values in String for ListOpensearchClusterBackupsSortByEnum

func GetListOpensearchClusterBackupsSortOrderEnumStringValues 

func GetListOpensearchClusterBackupsSortOrderEnumStringValues() []string

GetListOpensearchClusterBackupsSortOrderEnumStringValues Enumerates the set of values in String for ListOpensearchClusterBackupsSortOrderEnum

func GetListOpensearchClustersSortByEnumStringValues 

func GetListOpensearchClustersSortByEnumStringValues() []string

GetListOpensearchClustersSortByEnumStringValues Enumerates the set of values in String for ListOpensearchClustersSortByEnum

func GetListOpensearchClustersSortOrderEnumStringValues 

func GetListOpensearchClustersSortOrderEnumStringValues() []string

GetListOpensearchClustersSortOrderEnumStringValues Enumerates the set of values in String for ListOpensearchClustersSortOrderEnum

func GetMasterNodeHostTypeEnumStringValues 

func GetMasterNodeHostTypeEnumStringValues() []string

GetMasterNodeHostTypeEnumStringValues Enumerates the set of values in String for MasterNodeHostTypeEnum

func GetOpensearchClusterBackupBackupTypeEnumStringValues 

func GetOpensearchClusterBackupBackupTypeEnumStringValues() []string

GetOpensearchClusterBackupBackupTypeEnumStringValues Enumerates the set of values in String for OpensearchClusterBackupBackupTypeEnum

func GetOpensearchClusterBackupLifecycleStateEnumStringValues 

func GetOpensearchClusterBackupLifecycleStateEnumStringValues() []string

GetOpensearchClusterBackupLifecycleStateEnumStringValues Enumerates the set of values in String for OpensearchClusterBackupLifecycleStateEnum

func GetOpensearchClusterLifecycleStateEnumStringValues 

func GetOpensearchClusterLifecycleStateEnumStringValues() []string

GetOpensearchClusterLifecycleStateEnumStringValues Enumerates the set of values in String for OpensearchClusterLifecycleStateEnum

func GetOperationStatusEnumStringValues 

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues 

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetSecurityModeEnumStringValues added in v65.28.3 

func GetSecurityModeEnumStringValues() []string

GetSecurityModeEnumStringValues Enumerates the set of values in String for SecurityModeEnum

func GetSortOrderEnumStringValues 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

Types

type ActionTypeEnum 

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues 

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum 

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type BackupEventDetails 

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

BackupEventDetails Details about a cluster backup event.

func (BackupEventDetails) String 

func (m BackupEventDetails) String() string

func (BackupEventDetails) ValidateEnumValue 

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

type BackupOpensearchClusterDetails 

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

BackupOpensearchClusterDetails Information about an OpenSearch cluster backup.

func (BackupOpensearchClusterDetails) String 

func (m BackupOpensearchClusterDetails) String() string

func (BackupOpensearchClusterDetails) ValidateEnumValue 

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

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

BackupOpensearchClusterRequest wrapper for the BackupOpensearchCluster operation

See also

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

func (BackupOpensearchClusterRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (BackupOpensearchClusterRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (BackupOpensearchClusterRequest) RetryPolicy 

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

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

func (BackupOpensearchClusterRequest) String 

func (request BackupOpensearchClusterRequest) String() string

func (BackupOpensearchClusterRequest) ValidateEnumValue 

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

type BackupOpensearchClusterResponse 

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

BackupOpensearchClusterResponse wrapper for the BackupOpensearchCluster operation

func (BackupOpensearchClusterResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (BackupOpensearchClusterResponse) String 

func (response BackupOpensearchClusterResponse) String() string

type BackupStateEnum 

type BackupStateEnum string

BackupStateEnum Enum with underlying type: string 

const (
	BackupStateDeleted BackupStateEnum = "DELETED"
	BackupStateSuccess BackupStateEnum = "SUCCESS"
	BackupStateFailed  BackupStateEnum = "FAILED"
)

Set of constants representing the allowable values for BackupStateEnum

func GetBackupStateEnumValues 

func GetBackupStateEnumValues() []BackupStateEnum

GetBackupStateEnumValues Enumerates the set of values for BackupStateEnum

func GetMappingBackupStateEnum 

func GetMappingBackupStateEnum(val string) (BackupStateEnum, bool)

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

type ChangeOpensearchClusterBackupCompartmentDetails 

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

ChangeOpensearchClusterBackupCompartmentDetails Details about the compartment that the cluster backup should move to.

func (ChangeOpensearchClusterBackupCompartmentDetails) String 

func (m ChangeOpensearchClusterBackupCompartmentDetails) String() string

func (ChangeOpensearchClusterBackupCompartmentDetails) ValidateEnumValue 

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

type ChangeOpensearchClusterCompartmentDetails 

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

ChangeOpensearchClusterCompartmentDetails Details about the compartment that the OpenSearch cluster should move to.

func (ChangeOpensearchClusterCompartmentDetails) String 

func (m ChangeOpensearchClusterCompartmentDetails) String() string

func (ChangeOpensearchClusterCompartmentDetails) ValidateEnumValue 

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

type CreateOpensearchClusterDetails 

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

CreateOpensearchClusterDetails The configuration details for a new OpenSearch cluster.

func (CreateOpensearchClusterDetails) String 

func (m CreateOpensearchClusterDetails) String() string

func (CreateOpensearchClusterDetails) ValidateEnumValue 

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

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

CreateOpensearchClusterRequest wrapper for the CreateOpensearchCluster operation

See also

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

func (CreateOpensearchClusterRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateOpensearchClusterRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateOpensearchClusterRequest) RetryPolicy 

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

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

func (CreateOpensearchClusterRequest) String 

func (request CreateOpensearchClusterRequest) String() string

func (CreateOpensearchClusterRequest) ValidateEnumValue 

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

type CreateOpensearchClusterResponse 

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

CreateOpensearchClusterResponse wrapper for the CreateOpensearchCluster operation

func (CreateOpensearchClusterResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateOpensearchClusterResponse) String 

func (response CreateOpensearchClusterResponse) String() string

type DataNodeHostTypeEnum 

type DataNodeHostTypeEnum string

DataNodeHostTypeEnum Enum with underlying type: string 

const (
	DataNodeHostTypeFlex DataNodeHostTypeEnum = "FLEX"
	DataNodeHostTypeBm   DataNodeHostTypeEnum = "BM"
)

Set of constants representing the allowable values for DataNodeHostTypeEnum

func GetDataNodeHostTypeEnumValues 

func GetDataNodeHostTypeEnumValues() []DataNodeHostTypeEnum

GetDataNodeHostTypeEnumValues Enumerates the set of values for DataNodeHostTypeEnum

func GetMappingDataNodeHostTypeEnum 

func GetMappingDataNodeHostTypeEnum(val string) (DataNodeHostTypeEnum, bool)

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

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

DeleteOpensearchClusterBackupRequest wrapper for the DeleteOpensearchClusterBackup operation

See also

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

func (DeleteOpensearchClusterBackupRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteOpensearchClusterBackupRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteOpensearchClusterBackupRequest) RetryPolicy 

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

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

func (DeleteOpensearchClusterBackupRequest) String 

func (request DeleteOpensearchClusterBackupRequest) String() string

func (DeleteOpensearchClusterBackupRequest) ValidateEnumValue 

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

type DeleteOpensearchClusterBackupResponse 

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

DeleteOpensearchClusterBackupResponse wrapper for the DeleteOpensearchClusterBackup operation

func (DeleteOpensearchClusterBackupResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteOpensearchClusterBackupResponse) String 

func (response DeleteOpensearchClusterBackupResponse) String() string

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

DeleteOpensearchClusterRequest wrapper for the DeleteOpensearchCluster operation

See also

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

func (DeleteOpensearchClusterRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteOpensearchClusterRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteOpensearchClusterRequest) RetryPolicy 

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

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

func (DeleteOpensearchClusterRequest) String 

func (request DeleteOpensearchClusterRequest) String() string

func (DeleteOpensearchClusterRequest) ValidateEnumValue 

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

type DeleteOpensearchClusterResponse 

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

DeleteOpensearchClusterResponse wrapper for the DeleteOpensearchCluster operation

func (DeleteOpensearchClusterResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteOpensearchClusterResponse) String 

func (response DeleteOpensearchClusterResponse) String() string

type ExportOpensearchClusterBackupDetails 

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

ExportOpensearchClusterBackupDetails Information about the cluster backup to export.

func (ExportOpensearchClusterBackupDetails) String 

func (m ExportOpensearchClusterBackupDetails) String() string

func (ExportOpensearchClusterBackupDetails) ValidateEnumValue 

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

type GetManifestResponse 

type GetManifestResponse struct {

	// The serialized manifest response.
	SerializedManifest *string `mandatory:"false" json:"serializedManifest"`
}

GetManifestResponse The response returned for the get manifest call.

func (GetManifestResponse) String 

func (m GetManifestResponse) String() string

func (GetManifestResponse) ValidateEnumValue 

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

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

GetOpensearchClusterBackupRequest wrapper for the GetOpensearchClusterBackup operation

See also

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

func (GetOpensearchClusterBackupRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetOpensearchClusterBackupRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetOpensearchClusterBackupRequest) RetryPolicy 

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

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

func (GetOpensearchClusterBackupRequest) String 

func (request GetOpensearchClusterBackupRequest) String() string

func (GetOpensearchClusterBackupRequest) ValidateEnumValue 

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

type GetOpensearchClusterBackupResponse 

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

GetOpensearchClusterBackupResponse wrapper for the GetOpensearchClusterBackup operation

func (GetOpensearchClusterBackupResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetOpensearchClusterBackupResponse) String 

func (response GetOpensearchClusterBackupResponse) String() string

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

GetOpensearchClusterRequest wrapper for the GetOpensearchCluster operation

See also

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

func (GetOpensearchClusterRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetOpensearchClusterRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetOpensearchClusterRequest) RetryPolicy 

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

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

func (GetOpensearchClusterRequest) String 

func (request GetOpensearchClusterRequest) String() string

func (GetOpensearchClusterRequest) ValidateEnumValue 

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

type GetOpensearchClusterResponse 

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

GetOpensearchClusterResponse wrapper for the GetOpensearchCluster operation

func (GetOpensearchClusterResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetOpensearchClusterResponse) String 

func (response GetOpensearchClusterResponse) String() string

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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

func (GetWorkRequestRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy 

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

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

func (GetWorkRequestRequest) String 

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue 

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

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

type GetWorkRequestResponse 

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

	// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
	RetryAfter *int `presentIn:"header" name:"retry-after"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String 

func (response GetWorkRequestResponse) String() string

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

ListOpensearchClusterBackupsRequest wrapper for the ListOpensearchClusterBackups operation

See also

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

func (ListOpensearchClusterBackupsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListOpensearchClusterBackupsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListOpensearchClusterBackupsRequest) RetryPolicy 

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

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

func (ListOpensearchClusterBackupsRequest) String 

func (request ListOpensearchClusterBackupsRequest) String() string

func (ListOpensearchClusterBackupsRequest) ValidateEnumValue 

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

type ListOpensearchClusterBackupsResponse 

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

ListOpensearchClusterBackupsResponse wrapper for the ListOpensearchClusterBackups operation

func (ListOpensearchClusterBackupsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListOpensearchClusterBackupsResponse) String 

func (response ListOpensearchClusterBackupsResponse) String() string

type ListOpensearchClusterBackupsSortByEnum 

type ListOpensearchClusterBackupsSortByEnum string

ListOpensearchClusterBackupsSortByEnum Enum with underlying type: string 

const (
	ListOpensearchClusterBackupsSortByTimecreated ListOpensearchClusterBackupsSortByEnum = "timeCreated"
	ListOpensearchClusterBackupsSortByDisplayname ListOpensearchClusterBackupsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListOpensearchClusterBackupsSortByEnum

func GetListOpensearchClusterBackupsSortByEnumValues 

func GetListOpensearchClusterBackupsSortByEnumValues() []ListOpensearchClusterBackupsSortByEnum

GetListOpensearchClusterBackupsSortByEnumValues Enumerates the set of values for ListOpensearchClusterBackupsSortByEnum

func GetMappingListOpensearchClusterBackupsSortByEnum 

func GetMappingListOpensearchClusterBackupsSortByEnum(val string) (ListOpensearchClusterBackupsSortByEnum, bool)

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

type ListOpensearchClusterBackupsSortOrderEnum 

type ListOpensearchClusterBackupsSortOrderEnum string

ListOpensearchClusterBackupsSortOrderEnum Enum with underlying type: string 

const (
	ListOpensearchClusterBackupsSortOrderAsc  ListOpensearchClusterBackupsSortOrderEnum = "ASC"
	ListOpensearchClusterBackupsSortOrderDesc ListOpensearchClusterBackupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOpensearchClusterBackupsSortOrderEnum

func GetListOpensearchClusterBackupsSortOrderEnumValues 

func GetListOpensearchClusterBackupsSortOrderEnumValues() []ListOpensearchClusterBackupsSortOrderEnum

GetListOpensearchClusterBackupsSortOrderEnumValues Enumerates the set of values for ListOpensearchClusterBackupsSortOrderEnum

func GetMappingListOpensearchClusterBackupsSortOrderEnum 

func GetMappingListOpensearchClusterBackupsSortOrderEnum(val string) (ListOpensearchClusterBackupsSortOrderEnum, bool)

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

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

ListOpensearchClustersRequest wrapper for the ListOpensearchClusters operation

See also

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

func (ListOpensearchClustersRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListOpensearchClustersRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListOpensearchClustersRequest) RetryPolicy 

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

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

func (ListOpensearchClustersRequest) String 

func (request ListOpensearchClustersRequest) String() string

func (ListOpensearchClustersRequest) ValidateEnumValue 

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

type ListOpensearchClustersResponse 

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

ListOpensearchClustersResponse wrapper for the ListOpensearchClusters operation

func (ListOpensearchClustersResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListOpensearchClustersResponse) String 

func (response ListOpensearchClustersResponse) String() string

type ListOpensearchClustersSortByEnum 

type ListOpensearchClustersSortByEnum string

ListOpensearchClustersSortByEnum Enum with underlying type: string 

const (
	ListOpensearchClustersSortByTimecreated ListOpensearchClustersSortByEnum = "timeCreated"
	ListOpensearchClustersSortByDisplayname ListOpensearchClustersSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListOpensearchClustersSortByEnum

func GetListOpensearchClustersSortByEnumValues 

func GetListOpensearchClustersSortByEnumValues() []ListOpensearchClustersSortByEnum

GetListOpensearchClustersSortByEnumValues Enumerates the set of values for ListOpensearchClustersSortByEnum

func GetMappingListOpensearchClustersSortByEnum 

func GetMappingListOpensearchClustersSortByEnum(val string) (ListOpensearchClustersSortByEnum, bool)

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

type ListOpensearchClustersSortOrderEnum 

type ListOpensearchClustersSortOrderEnum string

ListOpensearchClustersSortOrderEnum Enum with underlying type: string 

const (
	ListOpensearchClustersSortOrderAsc  ListOpensearchClustersSortOrderEnum = "ASC"
	ListOpensearchClustersSortOrderDesc ListOpensearchClustersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOpensearchClustersSortOrderEnum

func GetListOpensearchClustersSortOrderEnumValues 

func GetListOpensearchClustersSortOrderEnumValues() []ListOpensearchClustersSortOrderEnum

GetListOpensearchClustersSortOrderEnumValues Enumerates the set of values for ListOpensearchClustersSortOrderEnum

func GetMappingListOpensearchClustersSortOrderEnum 

func GetMappingListOpensearchClustersSortOrderEnum(val string) (ListOpensearchClustersSortOrderEnum, bool)

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

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

ListOpensearchVersionsRequest wrapper for the ListOpensearchVersions operation

See also

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

func (ListOpensearchVersionsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListOpensearchVersionsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListOpensearchVersionsRequest) RetryPolicy 

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

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

func (ListOpensearchVersionsRequest) String 

func (request ListOpensearchVersionsRequest) String() string

func (ListOpensearchVersionsRequest) ValidateEnumValue 

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

type ListOpensearchVersionsResponse 

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

ListOpensearchVersionsResponse wrapper for the ListOpensearchVersions operation

func (ListOpensearchVersionsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListOpensearchVersionsResponse) String 

func (response ListOpensearchVersionsResponse) String() string

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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

func (ListWorkRequestErrorsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy 

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

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

func (ListWorkRequestErrorsRequest) String 

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue 

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

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

type ListWorkRequestErrorsResponse 

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then 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"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String 

func (response ListWorkRequestErrorsResponse) String() string

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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

func (ListWorkRequestLogsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy 

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

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

func (ListWorkRequestLogsRequest) String 

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue 

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

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

type ListWorkRequestLogsResponse 

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then 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"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String 

func (response ListWorkRequestLogsResponse) String() string

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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

func (ListWorkRequestsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy 

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

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

func (ListWorkRequestsRequest) String 

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue 

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

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

type ListWorkRequestsResponse 

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String 

func (response ListWorkRequestsResponse) String() string

type MasterNodeHostTypeEnum 

type MasterNodeHostTypeEnum string

MasterNodeHostTypeEnum Enum with underlying type: string 

const (
	MasterNodeHostTypeFlex MasterNodeHostTypeEnum = "FLEX"
	MasterNodeHostTypeBm   MasterNodeHostTypeEnum = "BM"
)

Set of constants representing the allowable values for MasterNodeHostTypeEnum

func GetMappingMasterNodeHostTypeEnum 

func GetMappingMasterNodeHostTypeEnum(val string) (MasterNodeHostTypeEnum, bool)

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

func GetMasterNodeHostTypeEnumValues 

func GetMasterNodeHostTypeEnumValues() []MasterNodeHostTypeEnum

GetMasterNodeHostTypeEnumValues Enumerates the set of values for MasterNodeHostTypeEnum

type OpensearchCluster 

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

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

func (OpensearchCluster) String 

func (m OpensearchCluster) String() string

func (OpensearchCluster) ValidateEnumValue 

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

type OpensearchClusterBackup 

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

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

func (OpensearchClusterBackup) String 

func (m OpensearchClusterBackup) String() string

func (OpensearchClusterBackup) ValidateEnumValue 

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

type OpensearchClusterBackupBackupTypeEnum 

type OpensearchClusterBackupBackupTypeEnum string

OpensearchClusterBackupBackupTypeEnum Enum with underlying type: string 

const (
	OpensearchClusterBackupBackupTypeScheduled OpensearchClusterBackupBackupTypeEnum = "SCHEDULED"
	OpensearchClusterBackupBackupTypeManual    OpensearchClusterBackupBackupTypeEnum = "MANUAL"
)

Set of constants representing the allowable values for OpensearchClusterBackupBackupTypeEnum

func GetMappingOpensearchClusterBackupBackupTypeEnum 

func GetMappingOpensearchClusterBackupBackupTypeEnum(val string) (OpensearchClusterBackupBackupTypeEnum, bool)

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

func GetOpensearchClusterBackupBackupTypeEnumValues 

func GetOpensearchClusterBackupBackupTypeEnumValues() []OpensearchClusterBackupBackupTypeEnum

GetOpensearchClusterBackupBackupTypeEnumValues Enumerates the set of values for OpensearchClusterBackupBackupTypeEnum

type OpensearchClusterBackupClient 

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

OpensearchClusterBackupClient a client for OpensearchClusterBackup

func NewOpensearchClusterBackupClientWithConfigurationProvider 

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 

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 (*OpensearchClusterBackupClient) ConfigurationProvider 

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

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

func (OpensearchClusterBackupClient) DeleteOpensearchClusterBackup 

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

func (OpensearchClusterBackupClient) GetOpensearchClusterBackup 

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

func (OpensearchClusterBackupClient) ListOpensearchClusterBackups 

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

func (*OpensearchClusterBackupClient) SetRegion 

func (client *OpensearchClusterBackupClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OpensearchClusterBackupClient) UpdateOpensearchClusterBackup 

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

type OpensearchClusterBackupCollection 

type OpensearchClusterBackupCollection struct {

	// The list of cluster backups.
	Items []OpensearchClusterBackupSummary `mandatory:"true" json:"items"`
}

OpensearchClusterBackupCollection The list of cluster backups returned in a cluster backup search.

func (OpensearchClusterBackupCollection) String 

func (m OpensearchClusterBackupCollection) String() string

func (OpensearchClusterBackupCollection) ValidateEnumValue 

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

type OpensearchClusterBackupLifecycleStateEnum 

type OpensearchClusterBackupLifecycleStateEnum string

OpensearchClusterBackupLifecycleStateEnum Enum with underlying type: string 

const (
	OpensearchClusterBackupLifecycleStateCreating OpensearchClusterBackupLifecycleStateEnum = "CREATING"
	OpensearchClusterBackupLifecycleStateUpdating OpensearchClusterBackupLifecycleStateEnum = "UPDATING"
	OpensearchClusterBackupLifecycleStateActive   OpensearchClusterBackupLifecycleStateEnum = "ACTIVE"
	OpensearchClusterBackupLifecycleStateDeleting OpensearchClusterBackupLifecycleStateEnum = "DELETING"
	OpensearchClusterBackupLifecycleStateDeleted  OpensearchClusterBackupLifecycleStateEnum = "DELETED"
	OpensearchClusterBackupLifecycleStateFailed   OpensearchClusterBackupLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OpensearchClusterBackupLifecycleStateEnum

func GetMappingOpensearchClusterBackupLifecycleStateEnum 

func GetMappingOpensearchClusterBackupLifecycleStateEnum(val string) (OpensearchClusterBackupLifecycleStateEnum, bool)

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

func GetOpensearchClusterBackupLifecycleStateEnumValues 

func GetOpensearchClusterBackupLifecycleStateEnumValues() []OpensearchClusterBackupLifecycleStateEnum

GetOpensearchClusterBackupLifecycleStateEnumValues Enumerates the set of values for OpensearchClusterBackupLifecycleStateEnum

type OpensearchClusterBackupSummary 

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

OpensearchClusterBackupSummary The summary of information about an OpenSearch cluster backup.

func (OpensearchClusterBackupSummary) String 

func (m OpensearchClusterBackupSummary) String() string

func (OpensearchClusterBackupSummary) ValidateEnumValue 

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

type OpensearchClusterClient 

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

OpensearchClusterClient a client for OpensearchCluster

func NewOpensearchClusterClientWithConfigurationProvider 

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 

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 (OpensearchClusterClient) BackupOpensearchCluster 

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

func (*OpensearchClusterClient) ConfigurationProvider 

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

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

func (OpensearchClusterClient) CreateOpensearchCluster 

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

func (OpensearchClusterClient) DeleteOpensearchCluster 

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

func (OpensearchClusterClient) GetOpensearchCluster 

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

func (OpensearchClusterClient) GetWorkRequest 

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

func (OpensearchClusterClient) ListOpensearchClusters 

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

func (OpensearchClusterClient) ListOpensearchVersions 

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

func (OpensearchClusterClient) ListWorkRequestErrors 

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

func (OpensearchClusterClient) ListWorkRequestLogs 

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

func (OpensearchClusterClient) ListWorkRequests 

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

func (OpensearchClusterClient) OpensearchClusterRestore 

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

func (OpensearchClusterClient) ResizeOpensearchClusterHorizontal 

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

func (OpensearchClusterClient) ResizeOpensearchClusterVertical 

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

func (*OpensearchClusterClient) SetRegion 

func (client *OpensearchClusterClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OpensearchClusterClient) UpdateOpensearchCluster 

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

type OpensearchClusterCollection 

type OpensearchClusterCollection struct {

	// The list of clusters.
	Items []OpensearchClusterSummary `mandatory:"true" json:"items"`
}

OpensearchClusterCollection The list of OpenSearch clusters returned in a cluster search.

func (OpensearchClusterCollection) String 

func (m OpensearchClusterCollection) String() string

func (OpensearchClusterCollection) ValidateEnumValue 

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

type OpensearchClusterLifecycleStateEnum 

type OpensearchClusterLifecycleStateEnum string

OpensearchClusterLifecycleStateEnum Enum with underlying type: string 

const (
	OpensearchClusterLifecycleStateActive   OpensearchClusterLifecycleStateEnum = "ACTIVE"
	OpensearchClusterLifecycleStateCreating OpensearchClusterLifecycleStateEnum = "CREATING"
	OpensearchClusterLifecycleStateUpdating OpensearchClusterLifecycleStateEnum = "UPDATING"
	OpensearchClusterLifecycleStateDeleting OpensearchClusterLifecycleStateEnum = "DELETING"
	OpensearchClusterLifecycleStateDeleted  OpensearchClusterLifecycleStateEnum = "DELETED"
	OpensearchClusterLifecycleStateFailed   OpensearchClusterLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OpensearchClusterLifecycleStateEnum

func GetMappingOpensearchClusterLifecycleStateEnum 

func GetMappingOpensearchClusterLifecycleStateEnum(val string) (OpensearchClusterLifecycleStateEnum, bool)

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

func GetOpensearchClusterLifecycleStateEnumValues 

func GetOpensearchClusterLifecycleStateEnumValues() []OpensearchClusterLifecycleStateEnum

GetOpensearchClusterLifecycleStateEnumValues Enumerates the set of values for OpensearchClusterLifecycleStateEnum

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

OpensearchClusterRestoreRequest wrapper for the OpensearchClusterRestore operation

See also

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

func (OpensearchClusterRestoreRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (OpensearchClusterRestoreRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (OpensearchClusterRestoreRequest) RetryPolicy 

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

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

func (OpensearchClusterRestoreRequest) String 

func (request OpensearchClusterRestoreRequest) String() string

func (OpensearchClusterRestoreRequest) ValidateEnumValue 

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

type OpensearchClusterRestoreResponse 

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

OpensearchClusterRestoreResponse wrapper for the OpensearchClusterRestore operation

func (OpensearchClusterRestoreResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (OpensearchClusterRestoreResponse) String 

func (response OpensearchClusterRestoreResponse) String() string

type OpensearchClusterSummary 

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

OpensearchClusterSummary The summary of information about an OpenSearch cluster.

func (OpensearchClusterSummary) String 

func (m OpensearchClusterSummary) String() string

func (OpensearchClusterSummary) ValidateEnumValue 

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

type OpensearchVersionsCollection 

type OpensearchVersionsCollection struct {

	// A list of OpenSearch versions.
	Items []OpensearchVersionsSummary `mandatory:"true" json:"items"`
}

OpensearchVersionsCollection The list of OpenSearch versions returned in an OpenSearch version search.

func (OpensearchVersionsCollection) String 

func (m OpensearchVersionsCollection) String() string

func (OpensearchVersionsCollection) ValidateEnumValue 

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

type OpensearchVersionsSummary 

type OpensearchVersionsSummary struct {

	// The version of OpenSearch.
	Version *string `mandatory:"true" json:"version"`
}

OpensearchVersionsSummary A description of Opensearch versions

func (OpensearchVersionsSummary) String 

func (m OpensearchVersionsSummary) String() string

func (OpensearchVersionsSummary) ValidateEnumValue 

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

type OperationStatusEnum 

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum 

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues 

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum 

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string 

const (
	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"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum 

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues 

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type ResizeOpensearchClusterHorizontalDetails 

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

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

func (ResizeOpensearchClusterHorizontalDetails) String 

func (m ResizeOpensearchClusterHorizontalDetails) String() string

func (ResizeOpensearchClusterHorizontalDetails) ValidateEnumValue 

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

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

ResizeOpensearchClusterHorizontalRequest wrapper for the ResizeOpensearchClusterHorizontal operation

See also

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

func (ResizeOpensearchClusterHorizontalRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ResizeOpensearchClusterHorizontalRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ResizeOpensearchClusterHorizontalRequest) RetryPolicy 

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

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

func (ResizeOpensearchClusterHorizontalRequest) String 

func (request ResizeOpensearchClusterHorizontalRequest) String() string

func (ResizeOpensearchClusterHorizontalRequest) ValidateEnumValue 

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

type ResizeOpensearchClusterHorizontalResponse 

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

ResizeOpensearchClusterHorizontalResponse wrapper for the ResizeOpensearchClusterHorizontal operation

func (ResizeOpensearchClusterHorizontalResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ResizeOpensearchClusterHorizontalResponse) String 

func (response ResizeOpensearchClusterHorizontalResponse) String() string

type ResizeOpensearchClusterVerticalDetails 

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

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

func (ResizeOpensearchClusterVerticalDetails) String 

func (m ResizeOpensearchClusterVerticalDetails) String() string

func (ResizeOpensearchClusterVerticalDetails) ValidateEnumValue 

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

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

ResizeOpensearchClusterVerticalRequest wrapper for the ResizeOpensearchClusterVertical operation

See also

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

func (ResizeOpensearchClusterVerticalRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ResizeOpensearchClusterVerticalRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ResizeOpensearchClusterVerticalRequest) RetryPolicy 

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

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

func (ResizeOpensearchClusterVerticalRequest) String 

func (request ResizeOpensearchClusterVerticalRequest) String() string

func (ResizeOpensearchClusterVerticalRequest) ValidateEnumValue 

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

type ResizeOpensearchClusterVerticalResponse 

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

ResizeOpensearchClusterVerticalResponse wrapper for the ResizeOpensearchClusterVertical operation

func (ResizeOpensearchClusterVerticalResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ResizeOpensearchClusterVerticalResponse) String 

func (response ResizeOpensearchClusterVerticalResponse) String() string

type RestoreOpensearchClusterBackupDetails 

type RestoreOpensearchClusterBackupDetails struct {

	// The name of the source OpenSearch cluster for the cluster backup.
	ClusterId *string `mandatory:"true" json:"clusterId"`
}

RestoreOpensearchClusterBackupDetails Information about the source OpenSearch cluster to restore the cluster backup from.

func (RestoreOpensearchClusterBackupDetails) String 

func (m RestoreOpensearchClusterBackupDetails) String() string

func (RestoreOpensearchClusterBackupDetails) ValidateEnumValue 

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

type RestoreOpensearchClusterDetails 

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

RestoreOpensearchClusterDetails Information about the OpenSearch cluster backup to restore.

func (RestoreOpensearchClusterDetails) String 

func (m RestoreOpensearchClusterDetails) String() string

func (RestoreOpensearchClusterDetails) ValidateEnumValue 

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

type SecurityModeEnum added in v65.28.3 

type SecurityModeEnum string

SecurityModeEnum Enum with underlying type: string 

const (
	SecurityModeDisabled   SecurityModeEnum = "DISABLED"
	SecurityModePermissive SecurityModeEnum = "PERMISSIVE"
	SecurityModeEnforcing  SecurityModeEnum = "ENFORCING"
)

Set of constants representing the allowable values for SecurityModeEnum

func GetMappingSecurityModeEnum added in v65.28.3 

func GetMappingSecurityModeEnum(val string) (SecurityModeEnum, bool)

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

func GetSecurityModeEnumValues added in v65.28.3 

func GetSecurityModeEnumValues() []SecurityModeEnum

GetSecurityModeEnumValues Enumerates the set of values for SecurityModeEnum

type SortOrderEnum 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum 

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type UpdateCheckinDetails 

type UpdateCheckinDetails struct {

	// The OCID of the OpenSearch cluster.
	ClusterId *string `mandatory:"true" json:"clusterId"`
}

UpdateCheckinDetails Information about the update checkin event.

func (UpdateCheckinDetails) String 

func (m UpdateCheckinDetails) String() string

func (UpdateCheckinDetails) ValidateEnumValue 

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

type UpdateClusterHardenedImageDetails 

type UpdateClusterHardenedImageDetails struct {

	// The OCID of the OpenSearch cluster.
	ClusterId *string `mandatory:"true" json:"clusterId"`
}

UpdateClusterHardenedImageDetails Information about the cluster's hardened image.

func (UpdateClusterHardenedImageDetails) String 

func (m UpdateClusterHardenedImageDetails) String() string

func (UpdateClusterHardenedImageDetails) ValidateEnumValue 

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

type UpdateClusterStatusDetails 

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

UpdateClusterStatusDetails Information about the update cluster event.

func (UpdateClusterStatusDetails) String 

func (m UpdateClusterStatusDetails) String() string

func (UpdateClusterStatusDetails) ValidateEnumValue 

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

type UpdateOpensearchClusterBackupDetails 

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

UpdateOpensearchClusterBackupDetails Information about the cluster backup to update.

func (UpdateOpensearchClusterBackupDetails) String 

func (m UpdateOpensearchClusterBackupDetails) String() string

func (UpdateOpensearchClusterBackupDetails) ValidateEnumValue 

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

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

UpdateOpensearchClusterBackupRequest wrapper for the UpdateOpensearchClusterBackup operation

See also

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

func (UpdateOpensearchClusterBackupRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateOpensearchClusterBackupRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateOpensearchClusterBackupRequest) RetryPolicy 

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

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

func (UpdateOpensearchClusterBackupRequest) String 

func (request UpdateOpensearchClusterBackupRequest) String() string

func (UpdateOpensearchClusterBackupRequest) ValidateEnumValue 

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

type UpdateOpensearchClusterBackupResponse 

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

UpdateOpensearchClusterBackupResponse wrapper for the UpdateOpensearchClusterBackup operation

func (UpdateOpensearchClusterBackupResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateOpensearchClusterBackupResponse) String 

func (response UpdateOpensearchClusterBackupResponse) String() string

type UpdateOpensearchClusterDetails 

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

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.

func (UpdateOpensearchClusterDetails) String 

func (m UpdateOpensearchClusterDetails) String() string

func (UpdateOpensearchClusterDetails) ValidateEnumValue 

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

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

UpdateOpensearchClusterRequest wrapper for the UpdateOpensearchCluster operation

See also

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

func (UpdateOpensearchClusterRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateOpensearchClusterRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateOpensearchClusterRequest) RetryPolicy 

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

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

func (UpdateOpensearchClusterRequest) String 

func (request UpdateOpensearchClusterRequest) String() string

func (UpdateOpensearchClusterRequest) ValidateEnumValue 

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

type UpdateOpensearchClusterResponse 

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

UpdateOpensearchClusterResponse wrapper for the UpdateOpensearchCluster operation

func (UpdateOpensearchClusterResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateOpensearchClusterResponse) String 

func (response UpdateOpensearchClusterResponse) String() string

type WorkRequest 

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

WorkRequest An asynchronous work request.

func (WorkRequest) String 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue 

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

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

type WorkRequestCollection 

type WorkRequestCollection struct {

	// List of workRequests.
	Items []WorkRequest `mandatory:"true" json:"items"`
}

WorkRequestCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

func (WorkRequestCollection) String 

func (m WorkRequestCollection) String() string

func (WorkRequestCollection) ValidateEnumValue 

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

type WorkRequestError 

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

WorkRequestError An error encountered while executing an operation that is tracked by a work request.

func (WorkRequestError) String 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue 

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

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

type WorkRequestErrorCollection 

type WorkRequestErrorCollection struct {

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

WorkRequestErrorCollection The list of work request errors returned in a work request error search.

func (WorkRequestErrorCollection) String 

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue 

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

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

type WorkRequestLogEntry 

type WorkRequestLogEntry struct {

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

WorkRequestLogEntry A log message from executing an operation that is tracked by a work request.

func (WorkRequestLogEntry) String 

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue 

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

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

type WorkRequestLogEntryCollection 

type WorkRequestLogEntryCollection struct {

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

WorkRequestLogEntryCollection The list of work request log entries returned in a work request log search.

func (WorkRequestLogEntryCollection) String 

func (m WorkRequestLogEntryCollection) String() string

func (WorkRequestLogEntryCollection) ValidateEnumValue 

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

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

type WorkRequestResource 

type WorkRequestResource struct {

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

WorkRequestResource A resource that is created or operated on by an asynchronous operation that is tracked by a work request.

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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