bds

package
v60.0.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypesEnumStringValues

func GetActionTypesEnumStringValues() []string

GetActionTypesEnumStringValues Enumerates the set of values in String for ActionTypesEnum

func GetAutoScalePolicyMetricRuleMetricTypeEnumStringValues

func GetAutoScalePolicyMetricRuleMetricTypeEnumStringValues() []string

GetAutoScalePolicyMetricRuleMetricTypeEnumStringValues Enumerates the set of values in String for AutoScalePolicyMetricRuleMetricTypeEnum

func GetAutoScalePolicyPolicyTypeEnumStringValues

func GetAutoScalePolicyPolicyTypeEnumStringValues() []string

GetAutoScalePolicyPolicyTypeEnumStringValues Enumerates the set of values in String for AutoScalePolicyPolicyTypeEnum

func GetAutoScalePolicyRuleActionEnumStringValues

func GetAutoScalePolicyRuleActionEnumStringValues() []string

GetAutoScalePolicyRuleActionEnumStringValues Enumerates the set of values in String for AutoScalePolicyRuleActionEnum

func GetAutoScalingConfigurationLifecycleStateEnumStringValues

func GetAutoScalingConfigurationLifecycleStateEnumStringValues() []string

GetAutoScalingConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for AutoScalingConfigurationLifecycleStateEnum

func GetBdsApiKeyLifecycleStateEnumStringValues

func GetBdsApiKeyLifecycleStateEnumStringValues() []string

GetBdsApiKeyLifecycleStateEnumStringValues Enumerates the set of values in String for BdsApiKeyLifecycleStateEnum

func GetBdsInstanceClusterVersionEnumStringValues

func GetBdsInstanceClusterVersionEnumStringValues() []string

GetBdsInstanceClusterVersionEnumStringValues Enumerates the set of values in String for BdsInstanceClusterVersionEnum

func GetBdsInstanceLifecycleStateEnumStringValues

func GetBdsInstanceLifecycleStateEnumStringValues() []string

GetBdsInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for BdsInstanceLifecycleStateEnum

func GetBdsMetastoreConfigurationLifecycleStateEnumStringValues

func GetBdsMetastoreConfigurationLifecycleStateEnumStringValues() []string

GetBdsMetastoreConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for BdsMetastoreConfigurationLifecycleStateEnum

func GetBdsMetastoreConfigurationMetastoreTypeEnumStringValues

func GetBdsMetastoreConfigurationMetastoreTypeEnumStringValues() []string

GetBdsMetastoreConfigurationMetastoreTypeEnumStringValues Enumerates the set of values in String for BdsMetastoreConfigurationMetastoreTypeEnum

func GetListAutoScalingConfigurationsSortByEnumStringValues

func GetListAutoScalingConfigurationsSortByEnumStringValues() []string

GetListAutoScalingConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListAutoScalingConfigurationsSortByEnum

func GetListAutoScalingConfigurationsSortOrderEnumStringValues

func GetListAutoScalingConfigurationsSortOrderEnumStringValues() []string

GetListAutoScalingConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListAutoScalingConfigurationsSortOrderEnum

func GetListBdsApiKeysSortByEnumStringValues

func GetListBdsApiKeysSortByEnumStringValues() []string

GetListBdsApiKeysSortByEnumStringValues Enumerates the set of values in String for ListBdsApiKeysSortByEnum

func GetListBdsApiKeysSortOrderEnumStringValues

func GetListBdsApiKeysSortOrderEnumStringValues() []string

GetListBdsApiKeysSortOrderEnumStringValues Enumerates the set of values in String for ListBdsApiKeysSortOrderEnum

func GetListBdsInstancesSortByEnumStringValues

func GetListBdsInstancesSortByEnumStringValues() []string

GetListBdsInstancesSortByEnumStringValues Enumerates the set of values in String for ListBdsInstancesSortByEnum

func GetListBdsInstancesSortOrderEnumStringValues

func GetListBdsInstancesSortOrderEnumStringValues() []string

GetListBdsInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListBdsInstancesSortOrderEnum

func GetListBdsMetastoreConfigurationsSortByEnumStringValues

func GetListBdsMetastoreConfigurationsSortByEnumStringValues() []string

GetListBdsMetastoreConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListBdsMetastoreConfigurationsSortByEnum

func GetListBdsMetastoreConfigurationsSortOrderEnumStringValues

func GetListBdsMetastoreConfigurationsSortOrderEnumStringValues() []string

GetListBdsMetastoreConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListBdsMetastoreConfigurationsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetMetricThresholdRuleOperatorEnumStringValues

func GetMetricThresholdRuleOperatorEnumStringValues() []string

GetMetricThresholdRuleOperatorEnumStringValues Enumerates the set of values in String for MetricThresholdRuleOperatorEnum

func GetNodeLifecycleStateEnumStringValues

func GetNodeLifecycleStateEnumStringValues() []string

GetNodeLifecycleStateEnumStringValues Enumerates the set of values in String for NodeLifecycleStateEnum

func GetNodeNodeTypeEnumStringValues

func GetNodeNodeTypeEnumStringValues() []string

GetNodeNodeTypeEnumStringValues Enumerates the set of values in String for NodeNodeTypeEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypesEnumStringValues

func GetOperationTypesEnumStringValues() []string

GetOperationTypesEnumStringValues Enumerates the set of values in String for OperationTypesEnum

func GetSortOrdersEnumStringValues

func GetSortOrdersEnumStringValues() []string

GetSortOrdersEnumStringValues Enumerates the set of values in String for SortOrdersEnum

Types

type ActionTypesEnum

type ActionTypesEnum string

ActionTypesEnum Enum with underlying type: string

const (
	ActionTypesCreated    ActionTypesEnum = "CREATED"
	ActionTypesUpdated    ActionTypesEnum = "UPDATED"
	ActionTypesDeleted    ActionTypesEnum = "DELETED"
	ActionTypesInProgress ActionTypesEnum = "IN_PROGRESS"
	ActionTypesFailed     ActionTypesEnum = "FAILED"
)

Set of constants representing the allowable values for ActionTypesEnum

func GetActionTypesEnumValues

func GetActionTypesEnumValues() []ActionTypesEnum

GetActionTypesEnumValues Enumerates the set of values for ActionTypesEnum

func GetMappingActionTypesEnum

func GetMappingActionTypesEnum(val string) (ActionTypesEnum, bool)

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

type ActivateBdsMetastoreConfigurationDetails

type ActivateBdsMetastoreConfigurationDetails struct {

	// Base-64 encoded password for the cluster admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

	// Base-64 encoded passphrase of the BDS Api Key. Set only if metastore's type is EXTERNAL.
	BdsApiKeyPassphrase *string `mandatory:"false" json:"bdsApiKeyPassphrase"`
}

ActivateBdsMetastoreConfigurationDetails The reqeust body when activating a BDS metastore configuration

func (ActivateBdsMetastoreConfigurationDetails) String

func (ActivateBdsMetastoreConfigurationDetails) ValidateEnumValue

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

type ActivateBdsMetastoreConfigurationRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The metastore configuration ID
	MetastoreConfigId *string `mandatory:"true" contributesTo:"path" name:"metastoreConfigId"`

	// The request body when activating specified metastore configuration.
	ActivateBdsMetastoreConfigurationDetails `contributesTo:"body"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

ActivateBdsMetastoreConfigurationRequest wrapper for the ActivateBdsMetastoreConfiguration operation

See also

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

func (ActivateBdsMetastoreConfigurationRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ActivateBdsMetastoreConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ActivateBdsMetastoreConfigurationRequest) RetryPolicy

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

func (ActivateBdsMetastoreConfigurationRequest) String

func (ActivateBdsMetastoreConfigurationRequest) ValidateEnumValue

func (request ActivateBdsMetastoreConfigurationRequest) 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 ActivateBdsMetastoreConfigurationResponse

type ActivateBdsMetastoreConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ActivateBdsMetastoreConfigurationResponse wrapper for the ActivateBdsMetastoreConfiguration operation

func (ActivateBdsMetastoreConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ActivateBdsMetastoreConfigurationResponse) String

type AddAutoScalingConfigurationDetails

type AddAutoScalingConfigurationDetails struct {

	// A node type that is managed by an autoscale configuration. The only supported type is WORKER.
	NodeType NodeNodeTypeEnum `mandatory:"true" json:"nodeType"`

	// Whether the autoscale configuration is enabled.
	IsEnabled *bool `mandatory:"true" json:"isEnabled"`

	// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

	Policy *AutoScalePolicy `mandatory:"true" json:"policy"`

	// A user-friendly name. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

AddAutoScalingConfigurationDetails The information about the autoscale configuration.

func (AddAutoScalingConfigurationDetails) String

func (AddAutoScalingConfigurationDetails) ValidateEnumValue

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

type AddAutoScalingConfigurationRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Details for creating an autoscale configuration.
	AddAutoScalingConfigurationDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

AddAutoScalingConfigurationRequest wrapper for the AddAutoScalingConfiguration operation

See also

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

func (AddAutoScalingConfigurationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (AddAutoScalingConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (AddAutoScalingConfigurationRequest) RetryPolicy

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

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

func (AddAutoScalingConfigurationRequest) String

func (request AddAutoScalingConfigurationRequest) String() string

func (AddAutoScalingConfigurationRequest) ValidateEnumValue

func (request AddAutoScalingConfigurationRequest) 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 AddAutoScalingConfigurationResponse

type AddAutoScalingConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

AddAutoScalingConfigurationResponse wrapper for the AddAutoScalingConfiguration operation

func (AddAutoScalingConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (AddAutoScalingConfigurationResponse) String

func (response AddAutoScalingConfigurationResponse) String() string

type AddBlockStorageDetails

type AddBlockStorageDetails struct {

	// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

	// The size of block volume in GB to be added to each worker node. All the
	// details needed for attaching the block volume are managed by service itself.
	BlockVolumeSizeInGBs *int64 `mandatory:"true" json:"blockVolumeSizeInGBs"`
}

AddBlockStorageDetails The information about added block volumes.

func (AddBlockStorageDetails) String

func (m AddBlockStorageDetails) String() string

func (AddBlockStorageDetails) ValidateEnumValue

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

type AddBlockStorageRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Details for the added block storage.
	AddBlockStorageDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

AddBlockStorageRequest wrapper for the AddBlockStorage operation

See also

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

func (AddBlockStorageRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (AddBlockStorageRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (AddBlockStorageRequest) RetryPolicy

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

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

func (AddBlockStorageRequest) String

func (request AddBlockStorageRequest) String() string

func (AddBlockStorageRequest) ValidateEnumValue

func (request AddBlockStorageRequest) 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 AddBlockStorageResponse

type AddBlockStorageResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

AddBlockStorageResponse wrapper for the AddBlockStorage operation

func (AddBlockStorageResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (AddBlockStorageResponse) String

func (response AddBlockStorageResponse) String() string

type AddCloudSqlDetails

type AddCloudSqlDetails struct {

	// Shape of the node.
	Shape *string `mandatory:"true" json:"shape"`

	// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

	// The size of block volume in GB to be attached to the given node. All details needed for attaching the block volume are managed by the service itself.
	BlockVolumeSizeInGBs *int64 `mandatory:"false" json:"blockVolumeSizeInGBs"`
}

AddCloudSqlDetails The information about the added Cloud SQL.

func (AddCloudSqlDetails) String

func (m AddCloudSqlDetails) String() string

func (AddCloudSqlDetails) ValidateEnumValue

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

type AddCloudSqlRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Details for the Cloud SQL capability
	AddCloudSqlDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

AddCloudSqlRequest wrapper for the AddCloudSql operation

See also

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

func (AddCloudSqlRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (AddCloudSqlRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (AddCloudSqlRequest) RetryPolicy

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

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

func (AddCloudSqlRequest) String

func (request AddCloudSqlRequest) String() string

func (AddCloudSqlRequest) ValidateEnumValue

func (request AddCloudSqlRequest) 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 AddCloudSqlResponse

type AddCloudSqlResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

AddCloudSqlResponse wrapper for the AddCloudSql operation

func (AddCloudSqlResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (AddCloudSqlResponse) String

func (response AddCloudSqlResponse) String() string

type AddWorkerNodesDetails

type AddWorkerNodesDetails struct {

	// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

	// Number of additional worker nodes for the cluster.
	NumberOfWorkerNodes *int `mandatory:"true" json:"numberOfWorkerNodes"`
}

AddWorkerNodesDetails The information about added nodes.

func (AddWorkerNodesDetails) String

func (m AddWorkerNodesDetails) String() string

func (AddWorkerNodesDetails) ValidateEnumValue

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

type AddWorkerNodesRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Details for the newly added nodes.
	AddWorkerNodesDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

AddWorkerNodesRequest wrapper for the AddWorkerNodes operation

See also

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

func (AddWorkerNodesRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (AddWorkerNodesRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (AddWorkerNodesRequest) RetryPolicy

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

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

func (AddWorkerNodesRequest) String

func (request AddWorkerNodesRequest) String() string

func (AddWorkerNodesRequest) ValidateEnumValue

func (request AddWorkerNodesRequest) 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 AddWorkerNodesResponse

type AddWorkerNodesResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

AddWorkerNodesResponse wrapper for the AddWorkerNodes operation

func (AddWorkerNodesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (AddWorkerNodesResponse) String

func (response AddWorkerNodesResponse) String() string

type AutoScalePolicy

type AutoScalePolicy struct {

	// Types of autoscale policies. Options are SCHEDULE-BASED or THRESHOLD-BASED. (Only THRESHOLD-BASED is supported in this release.)
	PolicyType AutoScalePolicyPolicyTypeEnum `mandatory:"true" json:"policyType"`

	// The list of rules for autoscaling. If an action has multiple rules, the last rule in the array will be applied.
	Rules []AutoScalePolicyRule `mandatory:"true" json:"rules"`
}

AutoScalePolicy Policy definitions for the autoscale configuration.

func (AutoScalePolicy) String

func (m AutoScalePolicy) String() string

func (AutoScalePolicy) ValidateEnumValue

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

type AutoScalePolicyMetricRule struct {

	// Allowed value is CPU_UTILIZATION.
	MetricType AutoScalePolicyMetricRuleMetricTypeEnum `mandatory:"true" json:"metricType"`

	Threshold *MetricThresholdRule `mandatory:"true" json:"threshold"`
}

AutoScalePolicyMetricRule Metric and threshold details for triggering an autoscale action.

func (AutoScalePolicyMetricRule) String

func (m AutoScalePolicyMetricRule) String() string

func (AutoScalePolicyMetricRule) ValidateEnumValue

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

type AutoScalePolicyMetricRuleMetricTypeEnum string

AutoScalePolicyMetricRuleMetricTypeEnum Enum with underlying type: string

const (
	AutoScalePolicyMetricRuleMetricTypeCpuUtilization AutoScalePolicyMetricRuleMetricTypeEnum = "CPU_UTILIZATION"
)

Set of constants representing the allowable values for AutoScalePolicyMetricRuleMetricTypeEnum

func GetAutoScalePolicyMetricRuleMetricTypeEnumValues

func GetAutoScalePolicyMetricRuleMetricTypeEnumValues() []AutoScalePolicyMetricRuleMetricTypeEnum

GetAutoScalePolicyMetricRuleMetricTypeEnumValues Enumerates the set of values for AutoScalePolicyMetricRuleMetricTypeEnum

func GetMappingAutoScalePolicyMetricRuleMetricTypeEnum

func GetMappingAutoScalePolicyMetricRuleMetricTypeEnum(val string) (AutoScalePolicyMetricRuleMetricTypeEnum, bool)

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

type AutoScalePolicyPolicyTypeEnum

type AutoScalePolicyPolicyTypeEnum string

AutoScalePolicyPolicyTypeEnum Enum with underlying type: string

const (
	AutoScalePolicyPolicyTypeThresholdBased AutoScalePolicyPolicyTypeEnum = "THRESHOLD_BASED"
	AutoScalePolicyPolicyTypeScheduleBased  AutoScalePolicyPolicyTypeEnum = "SCHEDULE_BASED"
)

Set of constants representing the allowable values for AutoScalePolicyPolicyTypeEnum

func GetAutoScalePolicyPolicyTypeEnumValues

func GetAutoScalePolicyPolicyTypeEnumValues() []AutoScalePolicyPolicyTypeEnum

GetAutoScalePolicyPolicyTypeEnumValues Enumerates the set of values for AutoScalePolicyPolicyTypeEnum

func GetMappingAutoScalePolicyPolicyTypeEnum

func GetMappingAutoScalePolicyPolicyTypeEnum(val string) (AutoScalePolicyPolicyTypeEnum, bool)

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

type AutoScalePolicyRule

type AutoScalePolicyRule struct {

	// The valid value are CHANGE_SHAPE_SCALE_UP or CHANGE_SHAPE_SCALE_DOWN.
	Action AutoScalePolicyRuleActionEnum `mandatory:"true" json:"action"`

	Metric *AutoScalePolicyMetricRule `mandatory:"true" json:"metric"`
}

AutoScalePolicyRule A rule that defines a specific autoscale action to take and the metric that triggers that action.

func (AutoScalePolicyRule) String

func (m AutoScalePolicyRule) String() string

func (AutoScalePolicyRule) ValidateEnumValue

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

type AutoScalePolicyRuleActionEnum string

AutoScalePolicyRuleActionEnum Enum with underlying type: string

const (
	AutoScalePolicyRuleActionUp   AutoScalePolicyRuleActionEnum = "CHANGE_SHAPE_SCALE_UP"
	AutoScalePolicyRuleActionDown AutoScalePolicyRuleActionEnum = "CHANGE_SHAPE_SCALE_DOWN"
)

Set of constants representing the allowable values for AutoScalePolicyRuleActionEnum

func GetAutoScalePolicyRuleActionEnumValues

func GetAutoScalePolicyRuleActionEnumValues() []AutoScalePolicyRuleActionEnum

GetAutoScalePolicyRuleActionEnumValues Enumerates the set of values for AutoScalePolicyRuleActionEnum

func GetMappingAutoScalePolicyRuleActionEnum

func GetMappingAutoScalePolicyRuleActionEnum(val string) (AutoScalePolicyRuleActionEnum, bool)

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

type AutoScalingConfiguration

type AutoScalingConfiguration struct {

	// The unique identifier for the autoscale configuration.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// A node type that is managed by an autoscale configuration. The only supported type is WORKER.
	NodeType NodeNodeTypeEnum `mandatory:"true" json:"nodeType"`

	// The state of the autoscale configuration.
	LifecycleState AutoScalingConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The time the cluster was created, shown as an RFC 3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The time the autoscale configuration was updated, shown as an RFC 3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	Policy *AutoScalePolicy `mandatory:"true" json:"policy"`
}

AutoScalingConfiguration The information about the autoscale configuration.

func (AutoScalingConfiguration) String

func (m AutoScalingConfiguration) String() string

func (AutoScalingConfiguration) ValidateEnumValue

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

type AutoScalingConfigurationLifecycleStateEnum string

AutoScalingConfigurationLifecycleStateEnum Enum with underlying type: string

const (
	AutoScalingConfigurationLifecycleStateCreating AutoScalingConfigurationLifecycleStateEnum = "CREATING"
	AutoScalingConfigurationLifecycleStateActive   AutoScalingConfigurationLifecycleStateEnum = "ACTIVE"
	AutoScalingConfigurationLifecycleStateUpdating AutoScalingConfigurationLifecycleStateEnum = "UPDATING"
	AutoScalingConfigurationLifecycleStateDeleting AutoScalingConfigurationLifecycleStateEnum = "DELETING"
	AutoScalingConfigurationLifecycleStateDeleted  AutoScalingConfigurationLifecycleStateEnum = "DELETED"
	AutoScalingConfigurationLifecycleStateFailed   AutoScalingConfigurationLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for AutoScalingConfigurationLifecycleStateEnum

func GetAutoScalingConfigurationLifecycleStateEnumValues

func GetAutoScalingConfigurationLifecycleStateEnumValues() []AutoScalingConfigurationLifecycleStateEnum

GetAutoScalingConfigurationLifecycleStateEnumValues Enumerates the set of values for AutoScalingConfigurationLifecycleStateEnum

func GetMappingAutoScalingConfigurationLifecycleStateEnum

func GetMappingAutoScalingConfigurationLifecycleStateEnum(val string) (AutoScalingConfigurationLifecycleStateEnum, bool)

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

type AutoScalingConfigurationSummary

type AutoScalingConfigurationSummary struct {

	// The OCID of the autoscale configuration.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The state of the autoscale configuration.
	LifecycleState AutoScalingConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// A node type that is managed by an autoscale configuration. The only supported type is WORKER.
	NodeType NodeNodeTypeEnum `mandatory:"true" json:"nodeType"`

	// The time the cluster was created, shown as an RFC 3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The time the autoscale configuration was updated, shown as an RFC 3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	Policy *AutoScalePolicy `mandatory:"true" json:"policy"`
}

AutoScalingConfigurationSummary The information about the autoscale configuration.

func (AutoScalingConfigurationSummary) String

func (AutoScalingConfigurationSummary) ValidateEnumValue

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

type BdsApiKey struct {

	// Identifier of the user's API key.
	Id *string `mandatory:"true" json:"id"`

	// The user OCID for which this API key was created.
	UserId *string `mandatory:"true" json:"userId"`

	// User friendly identifier used to uniquely differentiate between different API keys.
	// Only ASCII alphanumeric characters with no spaces allowed.
	KeyAlias *string `mandatory:"true" json:"keyAlias"`

	// The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 .
	DefaultRegion *string `mandatory:"true" json:"defaultRegion"`

	// The OCID of your tenancy.
	TenantId *string `mandatory:"true" json:"tenantId"`

	// The fingerprint that corresponds to the public API key requested.
	Fingerprint *string `mandatory:"true" json:"fingerprint"`

	// The full path and file name of the private key used for authentication. This location will be automatically selected
	// on the BDS local file system.
	Pemfilepath *string `mandatory:"true" json:"pemfilepath"`

	// The state of the key.
	LifecycleState BdsApiKeyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The time the API key was created, shown as an RFC 3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

BdsApiKey The API key information.

func (BdsApiKey) String

func (m BdsApiKey) String() string

func (BdsApiKey) ValidateEnumValue

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

type BdsApiKeyLifecycleStateEnum string

BdsApiKeyLifecycleStateEnum Enum with underlying type: string

const (
	BdsApiKeyLifecycleStateCreating BdsApiKeyLifecycleStateEnum = "CREATING"
	BdsApiKeyLifecycleStateActive   BdsApiKeyLifecycleStateEnum = "ACTIVE"
	BdsApiKeyLifecycleStateDeleting BdsApiKeyLifecycleStateEnum = "DELETING"
	BdsApiKeyLifecycleStateDeleted  BdsApiKeyLifecycleStateEnum = "DELETED"
	BdsApiKeyLifecycleStateFailed   BdsApiKeyLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for BdsApiKeyLifecycleStateEnum

func GetBdsApiKeyLifecycleStateEnumValues

func GetBdsApiKeyLifecycleStateEnumValues() []BdsApiKeyLifecycleStateEnum

GetBdsApiKeyLifecycleStateEnumValues Enumerates the set of values for BdsApiKeyLifecycleStateEnum

func GetMappingBdsApiKeyLifecycleStateEnum

func GetMappingBdsApiKeyLifecycleStateEnum(val string) (BdsApiKeyLifecycleStateEnum, bool)

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

type BdsApiKeySummary

type BdsApiKeySummary struct {

	// Identifier of the user's API key.
	Id *string `mandatory:"true" json:"id"`

	// User friendly identifier used to uniquely differentiate between different API keys.
	// Only ASCII alphanumeric characters with no spaces allowed.
	KeyAlias *string `mandatory:"true" json:"keyAlias"`

	// The current status of the API key.
	LifecycleState BdsApiKeyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The name of the region to establish the Object Storage endpoint which was set as part of key creation operation.
	// If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 .
	DefaultRegion *string `mandatory:"true" json:"defaultRegion"`

	// The time the API key was created, shown as an RFC 3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}

BdsApiKeySummary The API key summary.

func (BdsApiKeySummary) String

func (m BdsApiKeySummary) String() string

func (BdsApiKeySummary) ValidateEnumValue

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

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

BdsClient a client for Bds

func NewBdsClientWithConfigurationProvider

func NewBdsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client BdsClient, err error)

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

func NewBdsClientWithOboToken

func NewBdsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client BdsClient, err error)

NewBdsClientWithOboToken Creates a new default Bds 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 (BdsClient) ActivateBdsMetastoreConfiguration

func (client BdsClient) ActivateBdsMetastoreConfiguration(ctx context.Context, request ActivateBdsMetastoreConfigurationRequest) (response ActivateBdsMetastoreConfigurationResponse, err error)

ActivateBdsMetastoreConfiguration Activate specified metastore configuration.

See also

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

func (BdsClient) AddAutoScalingConfiguration

func (client BdsClient) AddAutoScalingConfiguration(ctx context.Context, request AddAutoScalingConfigurationRequest) (response AddAutoScalingConfigurationResponse, err error)

AddAutoScalingConfiguration Add an autoscale configuration to the cluster.

See also

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

func (BdsClient) AddBlockStorage

func (client BdsClient) AddBlockStorage(ctx context.Context, request AddBlockStorageRequest) (response AddBlockStorageResponse, err error)

AddBlockStorage Adds block storage to existing worker nodes. The same amount of storage will be added to all worker nodes. No change will be made to storage that is already attached. Block storage cannot be removed.

See also

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

func (BdsClient) AddCloudSql

func (client BdsClient) AddCloudSql(ctx context.Context, request AddCloudSqlRequest) (response AddCloudSqlResponse, err error)

AddCloudSql Adds Cloud SQL to your cluster. You can use Cloud SQL to query against non-relational data stored in multiple big data sources, including Apache Hive, HDFS, Oracle NoSQL Database, and Apache HBase. Adding Cloud SQL adds a query server node to the cluster and creates cell servers on all the worker nodes in the cluster.

See also

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

func (BdsClient) AddWorkerNodes

func (client BdsClient) AddWorkerNodes(ctx context.Context, request AddWorkerNodesRequest) (response AddWorkerNodesResponse, err error)

AddWorkerNodes Increases the size (scales out) a cluster by adding worker nodes. The added worker nodes will have the same shape and will have the same amount of attached block storage as other worker nodes in the cluster.

See also

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

func (BdsClient) ChangeBdsInstanceCompartment

func (client BdsClient) ChangeBdsInstanceCompartment(ctx context.Context, request ChangeBdsInstanceCompartmentRequest) (response ChangeBdsInstanceCompartmentResponse, err error)

ChangeBdsInstanceCompartment Moves a Big Data Service cluster into a different compartment.

See also

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

func (BdsClient) ChangeShape

func (client BdsClient) ChangeShape(ctx context.Context, request ChangeShapeRequest) (response ChangeShapeResponse, err error)

ChangeShape Changes the size of a cluster by scaling up or scaling down the nodes. Nodes are scaled up or down by changing the shapes of all the nodes of the same type to the next larger or smaller shape. The node types are master, utility, worker, and Cloud SQL. Only nodes with VM-STANDARD shapes can be scaled.

See also

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

func (*BdsClient) ConfigurationProvider

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

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

func (BdsClient) CreateBdsApiKey

func (client BdsClient) CreateBdsApiKey(ctx context.Context, request CreateBdsApiKeyRequest) (response CreateBdsApiKeyResponse, err error)

CreateBdsApiKey Create an API key on behalf of the specified user.

See also

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

func (BdsClient) CreateBdsInstance

func (client BdsClient) CreateBdsInstance(ctx context.Context, request CreateBdsInstanceRequest) (response CreateBdsInstanceResponse, err error)

CreateBdsInstance Creates a Big Data Service cluster.

See also

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

func (BdsClient) CreateBdsMetastoreConfiguration

func (client BdsClient) CreateBdsMetastoreConfiguration(ctx context.Context, request CreateBdsMetastoreConfigurationRequest) (response CreateBdsMetastoreConfigurationResponse, err error)

CreateBdsMetastoreConfiguration Create and activate external metastore configuration.

See also

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

func (BdsClient) DeleteBdsApiKey

func (client BdsClient) DeleteBdsApiKey(ctx context.Context, request DeleteBdsApiKeyRequest) (response DeleteBdsApiKeyResponse, err error)

DeleteBdsApiKey Deletes the user's API key represented by the provided ID.

See also

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

func (BdsClient) DeleteBdsInstance

func (client BdsClient) DeleteBdsInstance(ctx context.Context, request DeleteBdsInstanceRequest) (response DeleteBdsInstanceResponse, err error)

DeleteBdsInstance Deletes the cluster identified by the given ID.

See also

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

func (BdsClient) DeleteBdsMetastoreConfiguration

func (client BdsClient) DeleteBdsMetastoreConfiguration(ctx context.Context, request DeleteBdsMetastoreConfigurationRequest) (response DeleteBdsMetastoreConfigurationResponse, err error)

DeleteBdsMetastoreConfiguration Delete the BDS metastore configuration represented by the provided ID.

See also

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

func (BdsClient) GetAutoScalingConfiguration

func (client BdsClient) GetAutoScalingConfiguration(ctx context.Context, request GetAutoScalingConfigurationRequest) (response GetAutoScalingConfigurationResponse, err error)

GetAutoScalingConfiguration Returns details of the autoscale configuration identified by the given ID.

See also

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

func (BdsClient) GetBdsApiKey

func (client BdsClient) GetBdsApiKey(ctx context.Context, request GetBdsApiKeyRequest) (response GetBdsApiKeyResponse, err error)

GetBdsApiKey Returns the user's API key information for the given ID.

See also

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

func (BdsClient) GetBdsInstance

func (client BdsClient) GetBdsInstance(ctx context.Context, request GetBdsInstanceRequest) (response GetBdsInstanceResponse, err error)

GetBdsInstance Returns information about the Big Data Service cluster identified by the given ID.

See also

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

func (BdsClient) GetBdsMetastoreConfiguration

func (client BdsClient) GetBdsMetastoreConfiguration(ctx context.Context, request GetBdsMetastoreConfigurationRequest) (response GetBdsMetastoreConfigurationResponse, err error)

GetBdsMetastoreConfiguration Returns the BDS Metastore configuration information for the given ID.

See also

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

func (BdsClient) GetWorkRequest

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

GetWorkRequest Returns the status of the work request identified by the given ID.

See also

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

func (BdsClient) ListAutoScalingConfigurations

func (client BdsClient) ListAutoScalingConfigurations(ctx context.Context, request ListAutoScalingConfigurationsRequest) (response ListAutoScalingConfigurationsResponse, err error)

ListAutoScalingConfigurations Returns information about the autoscaling configurations for a cluster.

See also

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

func (BdsClient) ListBdsApiKeys

func (client BdsClient) ListBdsApiKeys(ctx context.Context, request ListBdsApiKeysRequest) (response ListBdsApiKeysResponse, err error)

ListBdsApiKeys Returns a list of all API keys associated with this Big Data Service cluster.

See also

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

func (BdsClient) ListBdsInstances

func (client BdsClient) ListBdsInstances(ctx context.Context, request ListBdsInstancesRequest) (response ListBdsInstancesResponse, err error)

ListBdsInstances Returns a list of all Big Data Service clusters in a compartment.

See also

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

func (BdsClient) ListBdsMetastoreConfigurations

func (client BdsClient) ListBdsMetastoreConfigurations(ctx context.Context, request ListBdsMetastoreConfigurationsRequest) (response ListBdsMetastoreConfigurationsResponse, err error)

ListBdsMetastoreConfigurations Returns a list of metastore configurations ssociated with this Big Data Service cluster.

See also

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

func (BdsClient) ListWorkRequestErrors

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

ListWorkRequestErrors Returns a paginated list of errors for a work request identified by the given ID.

See also

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

func (BdsClient) ListWorkRequestLogs

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

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

func (BdsClient) ListWorkRequests

func (client BdsClient) 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/bds/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.

func (BdsClient) RemoveAutoScalingConfiguration

func (client BdsClient) RemoveAutoScalingConfiguration(ctx context.Context, request RemoveAutoScalingConfigurationRequest) (response RemoveAutoScalingConfigurationResponse, err error)

RemoveAutoScalingConfiguration Deletes an autoscale configuration.

See also

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

func (BdsClient) RemoveCloudSql

func (client BdsClient) RemoveCloudSql(ctx context.Context, request RemoveCloudSqlRequest) (response RemoveCloudSqlResponse, err error)

RemoveCloudSql Removes Cloud SQL from the cluster.

See also

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

func (BdsClient) RestartNode

func (client BdsClient) RestartNode(ctx context.Context, request RestartNodeRequest) (response RestartNodeResponse, err error)

RestartNode Restarts a single node of a Big Data Service cluster

See also

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

func (*BdsClient) SetRegion

func (client *BdsClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (BdsClient) TestBdsMetastoreConfiguration

func (client BdsClient) TestBdsMetastoreConfiguration(ctx context.Context, request TestBdsMetastoreConfigurationRequest) (response TestBdsMetastoreConfigurationResponse, err error)

TestBdsMetastoreConfiguration Test specified metastore configuration.

See also

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

func (BdsClient) TestBdsObjectStorageConnection

func (client BdsClient) TestBdsObjectStorageConnection(ctx context.Context, request TestBdsObjectStorageConnectionRequest) (response TestBdsObjectStorageConnectionResponse, err error)

TestBdsObjectStorageConnection Test access to specified Object Storage bucket using the API key.

See also

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

func (BdsClient) UpdateAutoScalingConfiguration

func (client BdsClient) UpdateAutoScalingConfiguration(ctx context.Context, request UpdateAutoScalingConfigurationRequest) (response UpdateAutoScalingConfigurationResponse, err error)

UpdateAutoScalingConfiguration Updates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale configuration is enabled.

See also

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

func (BdsClient) UpdateBdsInstance

func (client BdsClient) UpdateBdsInstance(ctx context.Context, request UpdateBdsInstanceRequest) (response UpdateBdsInstanceResponse, err error)

UpdateBdsInstance Updates the Big Data Service cluster identified by the given ID.

See also

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

func (BdsClient) UpdateBdsMetastoreConfiguration

func (client BdsClient) UpdateBdsMetastoreConfiguration(ctx context.Context, request UpdateBdsMetastoreConfigurationRequest) (response UpdateBdsMetastoreConfigurationResponse, err error)

UpdateBdsMetastoreConfiguration Update the BDS metastore configuration represented by the provided ID.

See also

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

type BdsInstance

type BdsInstance struct {

	// The OCID of the Big Data Service resource.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name of the cluster.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The state of the cluster.
	LifecycleState BdsInstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Boolean flag specifying whether or not the cluster is highly available (HA)
	IsHighAvailability *bool `mandatory:"true" json:"isHighAvailability"`

	// Boolean flag specifying whether or not the cluster should be set up as secure.
	IsSecure *bool `mandatory:"true" json:"isSecure"`

	// Boolean flag specifying whether or not Cloud SQL should be configured.
	IsCloudSqlConfigured *bool `mandatory:"true" json:"isCloudSqlConfigured"`

	// The list of nodes in the cluster.
	Nodes []Node `mandatory:"true" json:"nodes"`

	// Number of nodes that forming the cluster
	NumberOfNodes *int `mandatory:"true" json:"numberOfNodes"`

	// Version of the Hadoop distribution.
	ClusterVersion BdsInstanceClusterVersionEnum `mandatory:"false" json:"clusterVersion,omitempty"`

	NetworkConfig *NetworkConfig `mandatory:"false" json:"networkConfig"`

	ClusterDetails *ClusterDetails `mandatory:"false" json:"clusterDetails"`

	CloudSqlDetails *CloudSqlDetails `mandatory:"false" json:"cloudSqlDetails"`

	// The user who created the cluster.
	CreatedBy *string `mandatory:"false" json:"createdBy"`

	// The time the cluster was created, shown as an RFC 3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The time the cluster was updated, shown as an RFC 3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// Simple key-value pair that is applied without any predefined name, type, or scope.
	// Exists for cross-compatibility only. For 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.
	// For example, `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

BdsInstance Description of the cluster.

func (BdsInstance) String

func (m BdsInstance) String() string

func (BdsInstance) ValidateEnumValue

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

type BdsInstanceClusterVersionEnum string

BdsInstanceClusterVersionEnum Enum with underlying type: string

const (
	BdsInstanceClusterVersionCdh5 BdsInstanceClusterVersionEnum = "CDH5"
	BdsInstanceClusterVersionCdh6 BdsInstanceClusterVersionEnum = "CDH6"
	BdsInstanceClusterVersionOdh1 BdsInstanceClusterVersionEnum = "ODH1"
)

Set of constants representing the allowable values for BdsInstanceClusterVersionEnum

func GetBdsInstanceClusterVersionEnumValues

func GetBdsInstanceClusterVersionEnumValues() []BdsInstanceClusterVersionEnum

GetBdsInstanceClusterVersionEnumValues Enumerates the set of values for BdsInstanceClusterVersionEnum

func GetMappingBdsInstanceClusterVersionEnum

func GetMappingBdsInstanceClusterVersionEnum(val string) (BdsInstanceClusterVersionEnum, bool)

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

type BdsInstanceLifecycleStateEnum

type BdsInstanceLifecycleStateEnum string

BdsInstanceLifecycleStateEnum Enum with underlying type: string

const (
	BdsInstanceLifecycleStateCreating   BdsInstanceLifecycleStateEnum = "CREATING"
	BdsInstanceLifecycleStateActive     BdsInstanceLifecycleStateEnum = "ACTIVE"
	BdsInstanceLifecycleStateUpdating   BdsInstanceLifecycleStateEnum = "UPDATING"
	BdsInstanceLifecycleStateSuspending BdsInstanceLifecycleStateEnum = "SUSPENDING"
	BdsInstanceLifecycleStateSuspended  BdsInstanceLifecycleStateEnum = "SUSPENDED"
	BdsInstanceLifecycleStateResuming   BdsInstanceLifecycleStateEnum = "RESUMING"
	BdsInstanceLifecycleStateDeleting   BdsInstanceLifecycleStateEnum = "DELETING"
	BdsInstanceLifecycleStateDeleted    BdsInstanceLifecycleStateEnum = "DELETED"
	BdsInstanceLifecycleStateFailed     BdsInstanceLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for BdsInstanceLifecycleStateEnum

func GetBdsInstanceLifecycleStateEnumValues

func GetBdsInstanceLifecycleStateEnumValues() []BdsInstanceLifecycleStateEnum

GetBdsInstanceLifecycleStateEnumValues Enumerates the set of values for BdsInstanceLifecycleStateEnum

func GetMappingBdsInstanceLifecycleStateEnum

func GetMappingBdsInstanceLifecycleStateEnum(val string) (BdsInstanceLifecycleStateEnum, bool)

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

type BdsInstanceSummary

type BdsInstanceSummary struct {

	// The OCID of the Big Data Service resource.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name of the cluster.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The state of the cluster.
	LifecycleState BdsInstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The number of nodes that form the cluster.
	NumberOfNodes *int `mandatory:"true" json:"numberOfNodes"`

	// Boolean flag specifying whether or not the cluster is highly available(HA).
	IsHighAvailability *bool `mandatory:"true" json:"isHighAvailability"`

	// Boolean flag specifying whether or not the cluster should be set up as secure.
	IsSecure *bool `mandatory:"true" json:"isSecure"`

	// Boolean flag specifying whether Cloud SQL is configured or not.
	IsCloudSqlConfigured *bool `mandatory:"true" json:"isCloudSqlConfigured"`

	// The time the cluster was created, shown as an RFC 3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Version of the Hadoop distribution.
	ClusterVersion BdsInstanceClusterVersionEnum `mandatory:"false" json:"clusterVersion,omitempty"`

	// Simple key-value pair that is applied without any predefined name, type, or scope.
	// Exists for cross-compatibility only. For 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.
	// For example, `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

BdsInstanceSummary Summary details of the Big Data Service cluster.

func (BdsInstanceSummary) String

func (m BdsInstanceSummary) String() string

func (BdsInstanceSummary) ValidateEnumValue

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

type BdsMetastoreConfiguration struct {

	// The ID of the metastore configuration
	Id *string `mandatory:"true" json:"id"`

	// The display name of metastore configuration
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The type of the metastore in the metastore configuration.
	MetastoreType BdsMetastoreConfigurationMetastoreTypeEnum `mandatory:"true" json:"metastoreType"`

	// the lifecycle state of the metastore configuration.
	LifecycleState BdsMetastoreConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the Data Catalog metastore. Set only if metastore's type is EXTERNAL.
	MetastoreId *string `mandatory:"false" json:"metastoreId"`

	// The ID of BDS API Key used for metastore configuration. Set only if metastore's type is EXTERNAL.
	BdsApiKeyId *string `mandatory:"false" json:"bdsApiKeyId"`

	// The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

BdsMetastoreConfiguration The metastore configuration information.

func (BdsMetastoreConfiguration) String

func (m BdsMetastoreConfiguration) String() string

func (BdsMetastoreConfiguration) ValidateEnumValue

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

type BdsMetastoreConfigurationLifecycleStateEnum string

BdsMetastoreConfigurationLifecycleStateEnum Enum with underlying type: string

const (
	BdsMetastoreConfigurationLifecycleStateCreating   BdsMetastoreConfigurationLifecycleStateEnum = "CREATING"
	BdsMetastoreConfigurationLifecycleStateActivating BdsMetastoreConfigurationLifecycleStateEnum = "ACTIVATING"
	BdsMetastoreConfigurationLifecycleStateActive     BdsMetastoreConfigurationLifecycleStateEnum = "ACTIVE"
	BdsMetastoreConfigurationLifecycleStateInactive   BdsMetastoreConfigurationLifecycleStateEnum = "INACTIVE"
	BdsMetastoreConfigurationLifecycleStateUpdating   BdsMetastoreConfigurationLifecycleStateEnum = "UPDATING"
	BdsMetastoreConfigurationLifecycleStateFailed     BdsMetastoreConfigurationLifecycleStateEnum = "FAILED"
	BdsMetastoreConfigurationLifecycleStateDeleting   BdsMetastoreConfigurationLifecycleStateEnum = "DELETING"
	BdsMetastoreConfigurationLifecycleStateDeleted    BdsMetastoreConfigurationLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for BdsMetastoreConfigurationLifecycleStateEnum

func GetBdsMetastoreConfigurationLifecycleStateEnumValues

func GetBdsMetastoreConfigurationLifecycleStateEnumValues() []BdsMetastoreConfigurationLifecycleStateEnum

GetBdsMetastoreConfigurationLifecycleStateEnumValues Enumerates the set of values for BdsMetastoreConfigurationLifecycleStateEnum

func GetMappingBdsMetastoreConfigurationLifecycleStateEnum

func GetMappingBdsMetastoreConfigurationLifecycleStateEnum(val string) (BdsMetastoreConfigurationLifecycleStateEnum, bool)

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

type BdsMetastoreConfigurationMetastoreTypeEnum

type BdsMetastoreConfigurationMetastoreTypeEnum string

BdsMetastoreConfigurationMetastoreTypeEnum Enum with underlying type: string

const (
	BdsMetastoreConfigurationMetastoreTypeLocal    BdsMetastoreConfigurationMetastoreTypeEnum = "LOCAL"
	BdsMetastoreConfigurationMetastoreTypeExternal BdsMetastoreConfigurationMetastoreTypeEnum = "EXTERNAL"
)

Set of constants representing the allowable values for BdsMetastoreConfigurationMetastoreTypeEnum

func GetBdsMetastoreConfigurationMetastoreTypeEnumValues

func GetBdsMetastoreConfigurationMetastoreTypeEnumValues() []BdsMetastoreConfigurationMetastoreTypeEnum

GetBdsMetastoreConfigurationMetastoreTypeEnumValues Enumerates the set of values for BdsMetastoreConfigurationMetastoreTypeEnum

func GetMappingBdsMetastoreConfigurationMetastoreTypeEnum

func GetMappingBdsMetastoreConfigurationMetastoreTypeEnum(val string) (BdsMetastoreConfigurationMetastoreTypeEnum, bool)

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

type BdsMetastoreConfigurationSummary

type BdsMetastoreConfigurationSummary struct {

	// The ID of the metastore configuration
	Id *string `mandatory:"true" json:"id"`

	// The display name of metastore configuration
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The type of the metastore in the metastore configuration.
	MetastoreType BdsMetastoreConfigurationMetastoreTypeEnum `mandatory:"true" json:"metastoreType"`

	// the lifecycle state of the metastore configuration.
	LifecycleState BdsMetastoreConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the Data Catalog metastore. Set only if metastore's type is EXTERNAL.
	MetastoreId *string `mandatory:"false" json:"metastoreId"`

	// The ID of BDS API Key used for metastore configuration. Set only if metastore's type is EXTERNAL.
	BdsApiKeyId *string `mandatory:"false" json:"bdsApiKeyId"`

	// The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

BdsMetastoreConfigurationSummary The summary of metastore configuration information.

func (BdsMetastoreConfigurationSummary) String

func (BdsMetastoreConfigurationSummary) ValidateEnumValue

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

type ChangeBdsInstanceCompartmentDetails struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeBdsInstanceCompartmentDetails Move a Cluster to a Different Compartment

func (ChangeBdsInstanceCompartmentDetails) String

func (ChangeBdsInstanceCompartmentDetails) ValidateEnumValue

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

type ChangeBdsInstanceCompartmentRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Details for the comparment change.
	ChangeBdsInstanceCompartmentDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

ChangeBdsInstanceCompartmentRequest wrapper for the ChangeBdsInstanceCompartment operation

See also

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

func (ChangeBdsInstanceCompartmentRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeBdsInstanceCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeBdsInstanceCompartmentRequest) RetryPolicy

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

func (ChangeBdsInstanceCompartmentRequest) String

func (ChangeBdsInstanceCompartmentRequest) ValidateEnumValue

func (request ChangeBdsInstanceCompartmentRequest) 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 ChangeBdsInstanceCompartmentResponse

type ChangeBdsInstanceCompartmentResponse 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 request, provide this request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ChangeBdsInstanceCompartmentResponse wrapper for the ChangeBdsInstanceCompartment operation

func (ChangeBdsInstanceCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeBdsInstanceCompartmentResponse) String

func (response ChangeBdsInstanceCompartmentResponse) String() string

type ChangeShapeDetails

type ChangeShapeDetails struct {

	// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

	Nodes *ChangeShapeNodes `mandatory:"true" json:"nodes"`
}

ChangeShapeDetails Resize details specified for individual nodes.

func (ChangeShapeDetails) String

func (m ChangeShapeDetails) String() string

func (ChangeShapeDetails) ValidateEnumValue

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

type ChangeShapeNodes struct {

	// Change shape of worker nodes to the desired target shape. Only VM_STANDARD shapes are allowed here.
	Worker *string `mandatory:"false" json:"worker"`

	// Change shape of master nodes to the desired target shape. Only VM_STANDARD shapes are allowed here.
	Master *string `mandatory:"false" json:"master"`

	// Change shape of utility nodes to the desired target shape. Only VM_STANDARD shapes are allowed here.
	Utility *string `mandatory:"false" json:"utility"`

	// Change shape of the Cloud SQL node to the desired target shape. Only VM_STANDARD shapes are allowed here.
	Cloudsql *string `mandatory:"false" json:"cloudsql"`
}

ChangeShapeNodes Individual worker nodes groups details.

func (ChangeShapeNodes) String

func (m ChangeShapeNodes) String() string

func (ChangeShapeNodes) ValidateEnumValue

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

type ChangeShapeRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Individual change shape settings per node type. You can change the shape of master, worker, utility and Cloud SQL nodes.
	ChangeShapeDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

ChangeShapeRequest wrapper for the ChangeShape operation

See also

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

func (ChangeShapeRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeShapeRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeShapeRequest) RetryPolicy

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

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

func (ChangeShapeRequest) String

func (request ChangeShapeRequest) String() string

func (ChangeShapeRequest) ValidateEnumValue

func (request ChangeShapeRequest) 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 ChangeShapeResponse

type ChangeShapeResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ChangeShapeResponse wrapper for the ChangeShape operation

func (ChangeShapeResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeShapeResponse) String

func (response ChangeShapeResponse) String() string

type CloudSqlDetails

type CloudSqlDetails struct {

	// Shape of the node
	Shape *string `mandatory:"true" json:"shape"`

	// IP address of the Cloud SQL node.
	IpAddress *string `mandatory:"true" json:"ipAddress"`

	// The size of block volume in GB that needs to be attached to a given node.
	// All the necessary details needed for attachment are managed by service itself.
	BlockVolumeSizeInGBs *int64 `mandatory:"false" json:"blockVolumeSizeInGBs"`

	// Boolean flag specifying whether or not Kerberos principals are mapped
	// to database users.
	IsKerberosMappedToDatabaseUsers *bool `mandatory:"false" json:"isKerberosMappedToDatabaseUsers"`

	// Details about the Kerberos principals.
	KerberosDetails []KerberosDetails `mandatory:"false" json:"kerberosDetails"`
}

CloudSqlDetails The information about added Cloud SQL capability

func (CloudSqlDetails) String

func (m CloudSqlDetails) String() string

func (CloudSqlDetails) ValidateEnumValue

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

type ClusterDetails struct {

	// The time the cluster was created, shown as an RFC 3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// BDA version installed in the cluster
	BdaVersion *string `mandatory:"false" json:"bdaVersion"`

	// Big Data Manager version installed in the cluster.
	BdmVersion *string `mandatory:"false" json:"bdmVersion"`

	// Big Data Service version installed in the cluster.
	BdsVersion *string `mandatory:"false" json:"bdsVersion"`

	// Oracle Linux version installed in the cluster.
	OsVersion *string `mandatory:"false" json:"osVersion"`

	// Cloud SQL query server database version.
	DbVersion *string `mandatory:"false" json:"dbVersion"`

	// Cloud SQL cell version.
	BdCellVersion *string `mandatory:"false" json:"bdCellVersion"`

	// Big Data SQL version.
	CsqlCellVersion *string `mandatory:"false" json:"csqlCellVersion"`

	// The time the cluster was automatically or manually refreshed, shown as an RFC 3339 formatted datetime string.
	TimeRefreshed *common.SDKTime `mandatory:"false" json:"timeRefreshed"`

	// The URL of Cloudera Manager
	ClouderaManagerUrl *string `mandatory:"false" json:"clouderaManagerUrl"`

	// The URL of Ambari
	AmbariUrl *string `mandatory:"false" json:"ambariUrl"`

	// The URL of Big Data Manager.
	BigDataManagerUrl *string `mandatory:"false" json:"bigDataManagerUrl"`

	// The URL of the Hue server.
	HueServerUrl *string `mandatory:"false" json:"hueServerUrl"`
}

ClusterDetails Specific info about a Hadoop cluster

func (ClusterDetails) String

func (m ClusterDetails) String() string

func (ClusterDetails) ValidateEnumValue

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

type CreateBdsApiKeyDetails struct {

	// The OCID of the user for whom this new generated API key pair will be created.
	UserId *string `mandatory:"true" json:"userId"`

	// Base64 passphrase used to secure the private key which will be created on user behalf.
	Passphrase *string `mandatory:"true" json:"passphrase"`

	// User friendly identifier used to uniquely differentiate between different API keys associated with this Big Data Service cluster.
	// Only ASCII alphanumeric characters with no spaces allowed.
	KeyAlias *string `mandatory:"true" json:"keyAlias"`

	// The name of the region to establish the Object Storage endpoint. See https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/Region/
	// for additional information.
	DefaultRegion *string `mandatory:"false" json:"defaultRegion"`
}

CreateBdsApiKeyDetails API key created on user's behalf.

func (CreateBdsApiKeyDetails) String

func (m CreateBdsApiKeyDetails) String() string

func (CreateBdsApiKeyDetails) ValidateEnumValue

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

type CreateBdsApiKeyRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Create a new user's API key.
	CreateBdsApiKeyDetails `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
}

CreateBdsApiKeyRequest wrapper for the CreateBdsApiKey operation

See also

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

func (CreateBdsApiKeyRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateBdsApiKeyRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateBdsApiKeyRequest) RetryPolicy

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

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

func (CreateBdsApiKeyRequest) String

func (request CreateBdsApiKeyRequest) String() string

func (CreateBdsApiKeyRequest) ValidateEnumValue

func (request CreateBdsApiKeyRequest) 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 CreateBdsApiKeyResponse

type CreateBdsApiKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

CreateBdsApiKeyResponse wrapper for the CreateBdsApiKey operation

func (CreateBdsApiKeyResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateBdsApiKeyResponse) String

func (response CreateBdsApiKeyResponse) String() string

type CreateBdsInstanceDetails

type CreateBdsInstanceDetails struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Name of the Big Data Service cluster.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// Version of the Hadoop distribution.
	ClusterVersion BdsInstanceClusterVersionEnum `mandatory:"true" json:"clusterVersion"`

	// The SSH public key used to authenticate the cluster connection.
	ClusterPublicKey *string `mandatory:"true" json:"clusterPublicKey"`

	// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

	// Boolean flag specifying whether or not the cluster is highly available (HA).
	IsHighAvailability *bool `mandatory:"true" json:"isHighAvailability"`

	// Boolean flag specifying whether or not the cluster should be set up as secure.
	IsSecure *bool `mandatory:"true" json:"isSecure"`

	// The list of nodes in the Big Data Service cluster.
	Nodes []CreateNodeDetails `mandatory:"true" json:"nodes"`

	NetworkConfig *NetworkConfig `mandatory:"false" json:"networkConfig"`

	// Simple key-value pair that is applied without any predefined name, type, or scope.
	// Exists for cross-compatibility only. For 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.
	// For example, `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateBdsInstanceDetails The information about the new cluster.

func (CreateBdsInstanceDetails) String

func (m CreateBdsInstanceDetails) String() string

func (CreateBdsInstanceDetails) ValidateEnumValue

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

type CreateBdsInstanceRequest struct {

	// Details for the new cluster.
	CreateBdsInstanceDetails `contributesTo:"body"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

CreateBdsInstanceRequest wrapper for the CreateBdsInstance operation

See also

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

func (CreateBdsInstanceRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateBdsInstanceRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateBdsInstanceRequest) RetryPolicy

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

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

func (CreateBdsInstanceRequest) String

func (request CreateBdsInstanceRequest) String() string

func (CreateBdsInstanceRequest) ValidateEnumValue

func (request CreateBdsInstanceRequest) 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 CreateBdsInstanceResponse

type CreateBdsInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

CreateBdsInstanceResponse wrapper for the CreateBdsInstance operation

func (CreateBdsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateBdsInstanceResponse) String

func (response CreateBdsInstanceResponse) String() string

type CreateBdsMetastoreConfigurationDetails

type CreateBdsMetastoreConfigurationDetails struct {

	// The OCID of the Data Catalog metastore.
	MetastoreId *string `mandatory:"true" json:"metastoreId"`

	// The ID of BDS Api Key used for Data Catalog metastore integration.
	BdsApiKeyId *string `mandatory:"true" json:"bdsApiKeyId"`

	// Base-64 encoded passphrase of the BDS Api Key.
	BdsApiKeyPassphrase *string `mandatory:"true" json:"bdsApiKeyPassphrase"`

	// Base-64 encoded password for the cluster admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

	// The display name of the metastore configuration
	DisplayName *string `mandatory:"false" json:"displayName"`
}

CreateBdsMetastoreConfigurationDetails The request body when creating BDS metastore configuration.

func (CreateBdsMetastoreConfigurationDetails) String

func (CreateBdsMetastoreConfigurationDetails) ValidateEnumValue

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

type CreateBdsMetastoreConfigurationRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The request body when creating and activating external metastore configuration.
	CreateBdsMetastoreConfigurationDetails `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
}

CreateBdsMetastoreConfigurationRequest wrapper for the CreateBdsMetastoreConfiguration operation

See also

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

func (CreateBdsMetastoreConfigurationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateBdsMetastoreConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateBdsMetastoreConfigurationRequest) RetryPolicy

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

func (CreateBdsMetastoreConfigurationRequest) String

func (CreateBdsMetastoreConfigurationRequest) ValidateEnumValue

func (request CreateBdsMetastoreConfigurationRequest) 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 CreateBdsMetastoreConfigurationResponse

type CreateBdsMetastoreConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

CreateBdsMetastoreConfigurationResponse wrapper for the CreateBdsMetastoreConfiguration operation

func (CreateBdsMetastoreConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateBdsMetastoreConfigurationResponse) String

type CreateNodeDetails

type CreateNodeDetails struct {

	// The Big Data Service cluster node type.
	NodeType NodeNodeTypeEnum `mandatory:"true" json:"nodeType"`

	// Shape of the node.
	Shape *string `mandatory:"true" json:"shape"`

	// The size of block volume in GB to be attached to a given node. All the
	// details needed for attaching the block volume are managed by service itself.
	BlockVolumeSizeInGBs *int64 `mandatory:"true" json:"blockVolumeSizeInGBs"`

	// The OCID of the subnet in which the node will be created.
	SubnetId *string `mandatory:"true" json:"subnetId"`
}

CreateNodeDetails The information about the new node.

func (CreateNodeDetails) String

func (m CreateNodeDetails) String() string

func (CreateNodeDetails) ValidateEnumValue

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

type DefaultError struct {

	// A short error code that defines the error, meant for programmatic parsing.
	Code *string `mandatory:"true" json:"code"`

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`
}

DefaultError Error Information.

func (DefaultError) String

func (m DefaultError) String() string

func (DefaultError) ValidateEnumValue

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

type DeleteBdsApiKeyRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The API key identifier.
	ApiKeyId *string `mandatory:"true" contributesTo:"path" name:"apiKeyId"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

DeleteBdsApiKeyRequest wrapper for the DeleteBdsApiKey operation

See also

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

func (DeleteBdsApiKeyRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteBdsApiKeyRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteBdsApiKeyRequest) RetryPolicy

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

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

func (DeleteBdsApiKeyRequest) String

func (request DeleteBdsApiKeyRequest) String() string

func (DeleteBdsApiKeyRequest) ValidateEnumValue

func (request DeleteBdsApiKeyRequest) 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 DeleteBdsApiKeyResponse

type DeleteBdsApiKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

DeleteBdsApiKeyResponse wrapper for the DeleteBdsApiKey operation

func (DeleteBdsApiKeyResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteBdsApiKeyResponse) String

func (response DeleteBdsApiKeyResponse) String() string

type DeleteBdsInstanceRequest

type DeleteBdsInstanceRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

DeleteBdsInstanceRequest wrapper for the DeleteBdsInstance operation

See also

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

func (DeleteBdsInstanceRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteBdsInstanceRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteBdsInstanceRequest) RetryPolicy

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

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

func (DeleteBdsInstanceRequest) String

func (request DeleteBdsInstanceRequest) String() string

func (DeleteBdsInstanceRequest) ValidateEnumValue

func (request DeleteBdsInstanceRequest) 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 DeleteBdsInstanceResponse

type DeleteBdsInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

DeleteBdsInstanceResponse wrapper for the DeleteBdsInstance operation

func (DeleteBdsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteBdsInstanceResponse) String

func (response DeleteBdsInstanceResponse) String() string

type DeleteBdsMetastoreConfigurationRequest

type DeleteBdsMetastoreConfigurationRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The metastore configuration ID
	MetastoreConfigId *string `mandatory:"true" contributesTo:"path" name:"metastoreConfigId"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

DeleteBdsMetastoreConfigurationRequest wrapper for the DeleteBdsMetastoreConfiguration operation

See also

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

func (DeleteBdsMetastoreConfigurationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteBdsMetastoreConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteBdsMetastoreConfigurationRequest) RetryPolicy

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

func (DeleteBdsMetastoreConfigurationRequest) String

func (DeleteBdsMetastoreConfigurationRequest) ValidateEnumValue

func (request DeleteBdsMetastoreConfigurationRequest) 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 DeleteBdsMetastoreConfigurationResponse

type DeleteBdsMetastoreConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

DeleteBdsMetastoreConfigurationResponse wrapper for the DeleteBdsMetastoreConfiguration operation

func (DeleteBdsMetastoreConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteBdsMetastoreConfigurationResponse) String

type GetAutoScalingConfigurationRequest

type GetAutoScalingConfigurationRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Unique Oracle-assigned identifier of the autoscale configuration.
	AutoScalingConfigurationId *string `mandatory:"true" contributesTo:"path" name:"autoScalingConfigurationId"`

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

GetAutoScalingConfigurationRequest wrapper for the GetAutoScalingConfiguration operation

See also

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

func (GetAutoScalingConfigurationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetAutoScalingConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetAutoScalingConfigurationRequest) RetryPolicy

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

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

func (GetAutoScalingConfigurationRequest) String

func (request GetAutoScalingConfigurationRequest) String() string

func (GetAutoScalingConfigurationRequest) ValidateEnumValue

func (request GetAutoScalingConfigurationRequest) 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 GetAutoScalingConfigurationResponse

type GetAutoScalingConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetAutoScalingConfigurationResponse wrapper for the GetAutoScalingConfiguration operation

func (GetAutoScalingConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetAutoScalingConfigurationResponse) String

func (response GetAutoScalingConfigurationResponse) String() string

type GetBdsApiKeyRequest

type GetBdsApiKeyRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The API key identifier.
	ApiKeyId *string `mandatory:"true" contributesTo:"path" name:"apiKeyId"`

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

GetBdsApiKeyRequest wrapper for the GetBdsApiKey operation

See also

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

func (GetBdsApiKeyRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetBdsApiKeyRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetBdsApiKeyRequest) RetryPolicy

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

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

func (GetBdsApiKeyRequest) String

func (request GetBdsApiKeyRequest) String() string

func (GetBdsApiKeyRequest) ValidateEnumValue

func (request GetBdsApiKeyRequest) 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 GetBdsApiKeyResponse

type GetBdsApiKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetBdsApiKeyResponse wrapper for the GetBdsApiKey operation

func (GetBdsApiKeyResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetBdsApiKeyResponse) String

func (response GetBdsApiKeyResponse) String() string

type GetBdsInstanceRequest

type GetBdsInstanceRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

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

GetBdsInstanceRequest wrapper for the GetBdsInstance operation

See also

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

func (GetBdsInstanceRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetBdsInstanceRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetBdsInstanceRequest) RetryPolicy

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

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

func (GetBdsInstanceRequest) String

func (request GetBdsInstanceRequest) String() string

func (GetBdsInstanceRequest) ValidateEnumValue

func (request GetBdsInstanceRequest) 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 GetBdsInstanceResponse

type GetBdsInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetBdsInstanceResponse wrapper for the GetBdsInstance operation

func (GetBdsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetBdsInstanceResponse) String

func (response GetBdsInstanceResponse) String() string

type GetBdsMetastoreConfigurationRequest

type GetBdsMetastoreConfigurationRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The metastore configuration ID
	MetastoreConfigId *string `mandatory:"true" contributesTo:"path" name:"metastoreConfigId"`

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

GetBdsMetastoreConfigurationRequest wrapper for the GetBdsMetastoreConfiguration operation

See also

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

func (GetBdsMetastoreConfigurationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetBdsMetastoreConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetBdsMetastoreConfigurationRequest) RetryPolicy

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

func (GetBdsMetastoreConfigurationRequest) String

func (GetBdsMetastoreConfigurationRequest) ValidateEnumValue

func (request GetBdsMetastoreConfigurationRequest) 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 GetBdsMetastoreConfigurationResponse

type GetBdsMetastoreConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetBdsMetastoreConfigurationResponse wrapper for the GetBdsMetastoreConfiguration operation

func (GetBdsMetastoreConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetBdsMetastoreConfigurationResponse) String

func (response GetBdsMetastoreConfigurationResponse) 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/bds/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 request, provide this request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// A non-negative integer number representing the number of seconds the client should wait before polling
	// this endpoint again.
	RetryAfter *float32 `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 KerberosDetails

type KerberosDetails struct {

	// Name of the Kerberos principal.
	PrincipalName *string `mandatory:"true" json:"principalName"`

	// Location of the keytab file
	KeytabFile *string `mandatory:"true" json:"keytabFile"`
}

KerberosDetails Details about the Kerberos principals.

func (KerberosDetails) String

func (m KerberosDetails) String() string

func (KerberosDetails) ValidateEnumValue

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

type ListAutoScalingConfigurationsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

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

	// 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 ListAutoScalingConfigurationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListAutoScalingConfigurationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

	// The state of the autoscale configuration.
	LifecycleState AutoScalingConfigurationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" 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
}

ListAutoScalingConfigurationsRequest wrapper for the ListAutoScalingConfigurations operation

See also

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

func (ListAutoScalingConfigurationsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListAutoScalingConfigurationsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListAutoScalingConfigurationsRequest) RetryPolicy

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

func (ListAutoScalingConfigurationsRequest) String

func (ListAutoScalingConfigurationsRequest) ValidateEnumValue

func (request ListAutoScalingConfigurationsRequest) 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 ListAutoScalingConfigurationsResponse

type ListAutoScalingConfigurationsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a request, provide this 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"`
}

ListAutoScalingConfigurationsResponse wrapper for the ListAutoScalingConfigurations operation

func (ListAutoScalingConfigurationsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListAutoScalingConfigurationsResponse) String

type ListAutoScalingConfigurationsSortByEnum

type ListAutoScalingConfigurationsSortByEnum string

ListAutoScalingConfigurationsSortByEnum Enum with underlying type: string

const (
	ListAutoScalingConfigurationsSortByTimecreated ListAutoScalingConfigurationsSortByEnum = "timeCreated"
	ListAutoScalingConfigurationsSortByDisplayname ListAutoScalingConfigurationsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListAutoScalingConfigurationsSortByEnum

func GetListAutoScalingConfigurationsSortByEnumValues

func GetListAutoScalingConfigurationsSortByEnumValues() []ListAutoScalingConfigurationsSortByEnum

GetListAutoScalingConfigurationsSortByEnumValues Enumerates the set of values for ListAutoScalingConfigurationsSortByEnum

func GetMappingListAutoScalingConfigurationsSortByEnum

func GetMappingListAutoScalingConfigurationsSortByEnum(val string) (ListAutoScalingConfigurationsSortByEnum, bool)

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

type ListAutoScalingConfigurationsSortOrderEnum

type ListAutoScalingConfigurationsSortOrderEnum string

ListAutoScalingConfigurationsSortOrderEnum Enum with underlying type: string

const (
	ListAutoScalingConfigurationsSortOrderAsc  ListAutoScalingConfigurationsSortOrderEnum = "ASC"
	ListAutoScalingConfigurationsSortOrderDesc ListAutoScalingConfigurationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAutoScalingConfigurationsSortOrderEnum

func GetListAutoScalingConfigurationsSortOrderEnumValues

func GetListAutoScalingConfigurationsSortOrderEnumValues() []ListAutoScalingConfigurationsSortOrderEnum

GetListAutoScalingConfigurationsSortOrderEnumValues Enumerates the set of values for ListAutoScalingConfigurationsSortOrderEnum

func GetMappingListAutoScalingConfigurationsSortOrderEnum

func GetMappingListAutoScalingConfigurationsSortOrderEnum(val string) (ListAutoScalingConfigurationsSortOrderEnum, bool)

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

type ListBdsApiKeysRequest

type ListBdsApiKeysRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The state of the API key.
	LifecycleState BdsApiKeyLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// The OCID of the user for whom the API key belongs.
	UserId *string `mandatory:"false" contributesTo:"query" name:"userId"`

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

	// 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 ListBdsApiKeysSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListBdsApiKeysSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

ListBdsApiKeysRequest wrapper for the ListBdsApiKeys operation

See also

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

func (ListBdsApiKeysRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListBdsApiKeysRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListBdsApiKeysRequest) RetryPolicy

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

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

func (ListBdsApiKeysRequest) String

func (request ListBdsApiKeysRequest) String() string

func (ListBdsApiKeysRequest) ValidateEnumValue

func (request ListBdsApiKeysRequest) 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 ListBdsApiKeysResponse

type ListBdsApiKeysResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a request, provide this 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"`
}

ListBdsApiKeysResponse wrapper for the ListBdsApiKeys operation

func (ListBdsApiKeysResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListBdsApiKeysResponse) String

func (response ListBdsApiKeysResponse) String() string

type ListBdsApiKeysSortByEnum

type ListBdsApiKeysSortByEnum string

ListBdsApiKeysSortByEnum Enum with underlying type: string

const (
	ListBdsApiKeysSortByTimecreated ListBdsApiKeysSortByEnum = "timeCreated"
	ListBdsApiKeysSortByDisplayname ListBdsApiKeysSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListBdsApiKeysSortByEnum

func GetListBdsApiKeysSortByEnumValues

func GetListBdsApiKeysSortByEnumValues() []ListBdsApiKeysSortByEnum

GetListBdsApiKeysSortByEnumValues Enumerates the set of values for ListBdsApiKeysSortByEnum

func GetMappingListBdsApiKeysSortByEnum

func GetMappingListBdsApiKeysSortByEnum(val string) (ListBdsApiKeysSortByEnum, bool)

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

type ListBdsApiKeysSortOrderEnum

type ListBdsApiKeysSortOrderEnum string

ListBdsApiKeysSortOrderEnum Enum with underlying type: string

const (
	ListBdsApiKeysSortOrderAsc  ListBdsApiKeysSortOrderEnum = "ASC"
	ListBdsApiKeysSortOrderDesc ListBdsApiKeysSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBdsApiKeysSortOrderEnum

func GetListBdsApiKeysSortOrderEnumValues

func GetListBdsApiKeysSortOrderEnumValues() []ListBdsApiKeysSortOrderEnum

GetListBdsApiKeysSortOrderEnumValues Enumerates the set of values for ListBdsApiKeysSortOrderEnum

func GetMappingListBdsApiKeysSortOrderEnum

func GetMappingListBdsApiKeysSortOrderEnum(val string) (ListBdsApiKeysSortOrderEnum, bool)

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

type ListBdsInstancesRequest

type ListBdsInstancesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The state of the cluster.
	LifecycleState BdsInstanceLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

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

	// 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 ListBdsInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListBdsInstancesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

ListBdsInstancesRequest wrapper for the ListBdsInstances operation

See also

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

func (ListBdsInstancesRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListBdsInstancesRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListBdsInstancesRequest) RetryPolicy

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

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

func (ListBdsInstancesRequest) String

func (request ListBdsInstancesRequest) String() string

func (ListBdsInstancesRequest) ValidateEnumValue

func (request ListBdsInstancesRequest) 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 ListBdsInstancesResponse

type ListBdsInstancesResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a request, provide this 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"`
}

ListBdsInstancesResponse wrapper for the ListBdsInstances operation

func (ListBdsInstancesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListBdsInstancesResponse) String

func (response ListBdsInstancesResponse) String() string

type ListBdsInstancesSortByEnum

type ListBdsInstancesSortByEnum string

ListBdsInstancesSortByEnum Enum with underlying type: string

const (
	ListBdsInstancesSortByTimecreated ListBdsInstancesSortByEnum = "timeCreated"
	ListBdsInstancesSortByDisplayname ListBdsInstancesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListBdsInstancesSortByEnum

func GetListBdsInstancesSortByEnumValues

func GetListBdsInstancesSortByEnumValues() []ListBdsInstancesSortByEnum

GetListBdsInstancesSortByEnumValues Enumerates the set of values for ListBdsInstancesSortByEnum

func GetMappingListBdsInstancesSortByEnum

func GetMappingListBdsInstancesSortByEnum(val string) (ListBdsInstancesSortByEnum, bool)

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

type ListBdsInstancesSortOrderEnum

type ListBdsInstancesSortOrderEnum string

ListBdsInstancesSortOrderEnum Enum with underlying type: string

const (
	ListBdsInstancesSortOrderAsc  ListBdsInstancesSortOrderEnum = "ASC"
	ListBdsInstancesSortOrderDesc ListBdsInstancesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBdsInstancesSortOrderEnum

func GetListBdsInstancesSortOrderEnumValues

func GetListBdsInstancesSortOrderEnumValues() []ListBdsInstancesSortOrderEnum

GetListBdsInstancesSortOrderEnumValues Enumerates the set of values for ListBdsInstancesSortOrderEnum

func GetMappingListBdsInstancesSortOrderEnum

func GetMappingListBdsInstancesSortOrderEnum(val string) (ListBdsInstancesSortOrderEnum, bool)

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

type ListBdsMetastoreConfigurationsRequest

type ListBdsMetastoreConfigurationsRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The type of the metastore in the metastore configuration
	MetastoreType BdsMetastoreConfigurationMetastoreTypeEnum `mandatory:"false" contributesTo:"query" name:"metastoreType" omitEmpty:"true"`

	// The OCID of the Data Catalog metastore in the metastore configuration
	MetastoreId *string `mandatory:"false" contributesTo:"query" name:"metastoreId"`

	// The lifecycle state of the metastore in the metastore configuration
	LifecycleState BdsMetastoreConfigurationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// The ID of the API key that is associated with the external metastore in the metastore configuration
	BdsApiKeyId *string `mandatory:"false" contributesTo:"query" name:"bdsApiKeyId"`

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

	// 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 ListBdsMetastoreConfigurationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListBdsMetastoreConfigurationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

ListBdsMetastoreConfigurationsRequest wrapper for the ListBdsMetastoreConfigurations operation

See also

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

func (ListBdsMetastoreConfigurationsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListBdsMetastoreConfigurationsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListBdsMetastoreConfigurationsRequest) RetryPolicy

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

func (ListBdsMetastoreConfigurationsRequest) String

func (ListBdsMetastoreConfigurationsRequest) ValidateEnumValue

func (request ListBdsMetastoreConfigurationsRequest) 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 ListBdsMetastoreConfigurationsResponse

type ListBdsMetastoreConfigurationsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a request, provide this 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"`
}

ListBdsMetastoreConfigurationsResponse wrapper for the ListBdsMetastoreConfigurations operation

func (ListBdsMetastoreConfigurationsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListBdsMetastoreConfigurationsResponse) String

type ListBdsMetastoreConfigurationsSortByEnum

type ListBdsMetastoreConfigurationsSortByEnum string

ListBdsMetastoreConfigurationsSortByEnum Enum with underlying type: string

const (
	ListBdsMetastoreConfigurationsSortByTimecreated ListBdsMetastoreConfigurationsSortByEnum = "timeCreated"
	ListBdsMetastoreConfigurationsSortByDisplayname ListBdsMetastoreConfigurationsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListBdsMetastoreConfigurationsSortByEnum

func GetListBdsMetastoreConfigurationsSortByEnumValues

func GetListBdsMetastoreConfigurationsSortByEnumValues() []ListBdsMetastoreConfigurationsSortByEnum

GetListBdsMetastoreConfigurationsSortByEnumValues Enumerates the set of values for ListBdsMetastoreConfigurationsSortByEnum

func GetMappingListBdsMetastoreConfigurationsSortByEnum

func GetMappingListBdsMetastoreConfigurationsSortByEnum(val string) (ListBdsMetastoreConfigurationsSortByEnum, bool)

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

type ListBdsMetastoreConfigurationsSortOrderEnum

type ListBdsMetastoreConfigurationsSortOrderEnum string

ListBdsMetastoreConfigurationsSortOrderEnum Enum with underlying type: string

const (
	ListBdsMetastoreConfigurationsSortOrderAsc  ListBdsMetastoreConfigurationsSortOrderEnum = "ASC"
	ListBdsMetastoreConfigurationsSortOrderDesc ListBdsMetastoreConfigurationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBdsMetastoreConfigurationsSortOrderEnum

func GetListBdsMetastoreConfigurationsSortOrderEnumValues

func GetListBdsMetastoreConfigurationsSortOrderEnumValues() []ListBdsMetastoreConfigurationsSortOrderEnum

GetListBdsMetastoreConfigurationsSortOrderEnumValues Enumerates the set of values for ListBdsMetastoreConfigurationsSortOrderEnum

func GetMappingListBdsMetastoreConfigurationsSortOrderEnum

func GetMappingListBdsMetastoreConfigurationsSortOrderEnum(val string) (ListBdsMetastoreConfigurationsSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest

type ListWorkRequestErrorsRequest struct {

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

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

	// 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 ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/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 []WorkRequestError instances
	Items []WorkRequestError `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 request, provide this request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
	ListWorkRequestErrorsSortByDisplayname ListWorkRequestErrorsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest

type ListWorkRequestLogsRequest struct {

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

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

	// 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 ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/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 []WorkRequestLogEntry instances
	Items []WorkRequestLogEntry `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 request, provide this request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
	ListWorkRequestLogsSortByDisplayname ListWorkRequestLogsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest

type ListWorkRequestsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the resource.
	ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

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

	// 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 ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/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 []WorkRequest instances
	Items []WorkRequest `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a request, provide this 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 ListWorkRequestsSortByEnum

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByTimecreated ListWorkRequestsSortByEnum = "timeCreated"
	ListWorkRequestsSortByDisplayname ListWorkRequestsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type MetricThresholdRule

type MetricThresholdRule struct {

	// This value is the minimum period of time the metric value meets or exceeds the threshold value before the action is triggered. The value is in minutes.
	DurationInMinutes *int `mandatory:"true" json:"durationInMinutes"`

	// The comparison operator to use. Options are greater than (GT) or less than (LT).
	Operator MetricThresholdRuleOperatorEnum `mandatory:"true" json:"operator"`

	// Integer non-negative value. 0 < value < 100
	Value *int `mandatory:"true" json:"value"`
}

MetricThresholdRule An autoscale action is triggered when a performance metric meets or exceeds a threshold.

func (MetricThresholdRule) String

func (m MetricThresholdRule) String() string

func (MetricThresholdRule) ValidateEnumValue

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

type MetricThresholdRuleOperatorEnum string

MetricThresholdRuleOperatorEnum Enum with underlying type: string

const (
	MetricThresholdRuleOperatorGt MetricThresholdRuleOperatorEnum = "GT"
	MetricThresholdRuleOperatorLt MetricThresholdRuleOperatorEnum = "LT"
)

Set of constants representing the allowable values for MetricThresholdRuleOperatorEnum

func GetMappingMetricThresholdRuleOperatorEnum

func GetMappingMetricThresholdRuleOperatorEnum(val string) (MetricThresholdRuleOperatorEnum, bool)

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

func GetMetricThresholdRuleOperatorEnumValues

func GetMetricThresholdRuleOperatorEnumValues() []MetricThresholdRuleOperatorEnum

GetMetricThresholdRuleOperatorEnumValues Enumerates the set of values for MetricThresholdRuleOperatorEnum

type NetworkConfig

type NetworkConfig struct {

	// A boolean flag whether to configure a NAT gateway.
	IsNatGatewayRequired *bool `mandatory:"false" json:"isNatGatewayRequired"`

	// The CIDR IP address block of the VCN.
	CidrBlock *string `mandatory:"false" json:"cidrBlock"`
}

NetworkConfig Additional configuration of the user's network.

func (NetworkConfig) String

func (m NetworkConfig) String() string

func (NetworkConfig) ValidateEnumValue

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

type Node struct {

	// The OCID of the underlying Oracle Cloud Infrastructure Compute instance.
	InstanceId *string `mandatory:"true" json:"instanceId"`

	// The name of the node.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The state of the node.
	LifecycleState NodeLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Cluster node type.
	NodeType NodeNodeTypeEnum `mandatory:"true" json:"nodeType"`

	// Shape of the node.
	Shape *string `mandatory:"true" json:"shape"`

	// The OCID of the subnet in which the node is to be created.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// IP address of the node.
	IpAddress *string `mandatory:"true" json:"ipAddress"`

	// The fingerprint of the SSH key used for node access.
	SshFingerprint *string `mandatory:"true" json:"sshFingerprint"`

	// The name of the availability domain in which the node is running.
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The name of the fault domain in which the node is running.
	FaultDomain *string `mandatory:"true" json:"faultDomain"`

	// The time the node was created, shown as an RFC 3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The list of block volumes attached to a given node.
	AttachedBlockVolumes []VolumeAttachmentDetail `mandatory:"false" json:"attachedBlockVolumes"`

	// The fully-qualified hostname (FQDN) of the node.
	Hostname *string `mandatory:"false" json:"hostname"`

	// The OCID of the image from which the node was created.
	ImageId *string `mandatory:"false" json:"imageId"`

	// The time the cluster was updated, shown as an RFC 3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

Node Details about a node.

func (Node) String

func (m Node) String() string

func (Node) ValidateEnumValue

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

type NodeLifecycleStateEnum string

NodeLifecycleStateEnum Enum with underlying type: string

const (
	NodeLifecycleStateCreating NodeLifecycleStateEnum = "CREATING"
	NodeLifecycleStateActive   NodeLifecycleStateEnum = "ACTIVE"
	NodeLifecycleStateInactive NodeLifecycleStateEnum = "INACTIVE"
	NodeLifecycleStateUpdating NodeLifecycleStateEnum = "UPDATING"
	NodeLifecycleStateDeleting NodeLifecycleStateEnum = "DELETING"
	NodeLifecycleStateDeleted  NodeLifecycleStateEnum = "DELETED"
	NodeLifecycleStateFailed   NodeLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for NodeLifecycleStateEnum

func GetMappingNodeLifecycleStateEnum

func GetMappingNodeLifecycleStateEnum(val string) (NodeLifecycleStateEnum, bool)

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

func GetNodeLifecycleStateEnumValues

func GetNodeLifecycleStateEnumValues() []NodeLifecycleStateEnum

GetNodeLifecycleStateEnumValues Enumerates the set of values for NodeLifecycleStateEnum

type NodeNodeTypeEnum

type NodeNodeTypeEnum string

NodeNodeTypeEnum Enum with underlying type: string

const (
	NodeNodeTypeMaster   NodeNodeTypeEnum = "MASTER"
	NodeNodeTypeEdge     NodeNodeTypeEnum = "EDGE"
	NodeNodeTypeUtility  NodeNodeTypeEnum = "UTILITY"
	NodeNodeTypeWorker   NodeNodeTypeEnum = "WORKER"
	NodeNodeTypeBursting NodeNodeTypeEnum = "BURSTING"
	NodeNodeTypeCloudSql NodeNodeTypeEnum = "CLOUD_SQL"
)

Set of constants representing the allowable values for NodeNodeTypeEnum

func GetMappingNodeNodeTypeEnum

func GetMappingNodeNodeTypeEnum(val string) (NodeNodeTypeEnum, bool)

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

func GetNodeNodeTypeEnumValues

func GetNodeNodeTypeEnumValues() []NodeNodeTypeEnum

GetNodeNodeTypeEnumValues Enumerates the set of values for NodeNodeTypeEnum

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 OperationTypesEnum

type OperationTypesEnum string

OperationTypesEnum Enum with underlying type: string

const (
	OperationTypesCreateBds                 OperationTypesEnum = "CREATE_BDS"
	OperationTypesUpdateBds                 OperationTypesEnum = "UPDATE_BDS"
	OperationTypesDeleteBds                 OperationTypesEnum = "DELETE_BDS"
	OperationTypesAddBlockStorage           OperationTypesEnum = "ADD_BLOCK_STORAGE"
	OperationTypesAddWorkerNodes            OperationTypesEnum = "ADD_WORKER_NODES"
	OperationTypesAddCloudSql               OperationTypesEnum = "ADD_CLOUD_SQL"
	OperationTypesRemoveCloudSql            OperationTypesEnum = "REMOVE_CLOUD_SQL"
	OperationTypesChangeCompartmentForBds   OperationTypesEnum = "CHANGE_COMPARTMENT_FOR_BDS"
	OperationTypesChangeShape               OperationTypesEnum = "CHANGE_SHAPE"
	OperationTypesUpdateInfra               OperationTypesEnum = "UPDATE_INFRA"
	OperationTypesRestartNode               OperationTypesEnum = "RESTART_NODE"
	OperationTypesAutoscaleConfig           OperationTypesEnum = "AUTOSCALE_CONFIG"
	OperationTypesAutoscaleRun              OperationTypesEnum = "AUTOSCALE_RUN"
	OperationTypesCreateApiKey              OperationTypesEnum = "CREATE_API_KEY"
	OperationTypesDeleteApiKey              OperationTypesEnum = "DELETE_API_KEY"
	OperationTypesTestObjectStoreConnection OperationTypesEnum = "TEST_OBJECT_STORE_CONNECTION"
	OperationTypesCreateMetastoreConfig     OperationTypesEnum = "CREATE_METASTORE_CONFIG"
	OperationTypesDeleteMetastoreConfig     OperationTypesEnum = "DELETE_METASTORE_CONFIG"
	OperationTypesUpdateMetastoreConfig     OperationTypesEnum = "UPDATE_METASTORE_CONFIG"
	OperationTypesActivateMetastoreConfig   OperationTypesEnum = "ACTIVATE_METASTORE_CONFIG"
	OperationTypesTestMetastoreConfig       OperationTypesEnum = "TEST_METASTORE_CONFIG"
)

Set of constants representing the allowable values for OperationTypesEnum

func GetMappingOperationTypesEnum

func GetMappingOperationTypesEnum(val string) (OperationTypesEnum, bool)

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

func GetOperationTypesEnumValues

func GetOperationTypesEnumValues() []OperationTypesEnum

GetOperationTypesEnumValues Enumerates the set of values for OperationTypesEnum

type RemoveAutoScalingConfigurationDetails

type RemoveAutoScalingConfigurationDetails struct {

	// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}

RemoveAutoScalingConfigurationDetails The information about the removed autoscale configuration.

func (RemoveAutoScalingConfigurationDetails) String

func (RemoveAutoScalingConfigurationDetails) ValidateEnumValue

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

type RemoveAutoScalingConfigurationRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Unique Oracle-assigned identifier of the autoscale configuration.
	AutoScalingConfigurationId *string `mandatory:"true" contributesTo:"path" name:"autoScalingConfigurationId"`

	// Details for the autoscale configuration
	RemoveAutoScalingConfigurationDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

RemoveAutoScalingConfigurationRequest wrapper for the RemoveAutoScalingConfiguration operation

See also

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

func (RemoveAutoScalingConfigurationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (RemoveAutoScalingConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (RemoveAutoScalingConfigurationRequest) RetryPolicy

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

func (RemoveAutoScalingConfigurationRequest) String

func (RemoveAutoScalingConfigurationRequest) ValidateEnumValue

func (request RemoveAutoScalingConfigurationRequest) 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 RemoveAutoScalingConfigurationResponse

type RemoveAutoScalingConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

RemoveAutoScalingConfigurationResponse wrapper for the RemoveAutoScalingConfiguration operation

func (RemoveAutoScalingConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (RemoveAutoScalingConfigurationResponse) String

type RemoveCloudSqlDetails

type RemoveCloudSqlDetails struct {

	// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}

RemoveCloudSqlDetails The information about the Cloud SQL installation that was removed.

func (RemoveCloudSqlDetails) String

func (m RemoveCloudSqlDetails) String() string

func (RemoveCloudSqlDetails) ValidateEnumValue

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

type RemoveCloudSqlRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Details for the Cloud SQL capability
	RemoveCloudSqlDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

RemoveCloudSqlRequest wrapper for the RemoveCloudSql operation

See also

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

func (RemoveCloudSqlRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (RemoveCloudSqlRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (RemoveCloudSqlRequest) RetryPolicy

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

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

func (RemoveCloudSqlRequest) String

func (request RemoveCloudSqlRequest) String() string

func (RemoveCloudSqlRequest) ValidateEnumValue

func (request RemoveCloudSqlRequest) 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 RemoveCloudSqlResponse

type RemoveCloudSqlResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

RemoveCloudSqlResponse wrapper for the RemoveCloudSql operation

func (RemoveCloudSqlResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (RemoveCloudSqlResponse) String

func (response RemoveCloudSqlResponse) String() string

type RestartNodeDetails

type RestartNodeDetails struct {

	// OCID of the node to be restarted.
	NodeId *string `mandatory:"true" json:"nodeId"`
}

RestartNodeDetails The information about restarted node.

func (RestartNodeDetails) String

func (m RestartNodeDetails) String() string

func (RestartNodeDetails) ValidateEnumValue

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

type RestartNodeRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Details for restarting the node.
	RestartNodeDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

RestartNodeRequest wrapper for the RestartNode operation

See also

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

func (RestartNodeRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (RestartNodeRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (RestartNodeRequest) RetryPolicy

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

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

func (RestartNodeRequest) String

func (request RestartNodeRequest) String() string

func (RestartNodeRequest) ValidateEnumValue

func (request RestartNodeRequest) 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 RestartNodeResponse

type RestartNodeResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

RestartNodeResponse wrapper for the RestartNode operation

func (RestartNodeResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (RestartNodeResponse) String

func (response RestartNodeResponse) String() string

type SortOrdersEnum

type SortOrdersEnum string

SortOrdersEnum Enum with underlying type: string

const (
	SortOrdersAsc  SortOrdersEnum = "ASC"
	SortOrdersDesc SortOrdersEnum = "DESC"
)

Set of constants representing the allowable values for SortOrdersEnum

func GetMappingSortOrdersEnum

func GetMappingSortOrdersEnum(val string) (SortOrdersEnum, bool)

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

func GetSortOrdersEnumValues

func GetSortOrdersEnumValues() []SortOrdersEnum

GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum

type TestBdsMetastoreConfigurationDetails

type TestBdsMetastoreConfigurationDetails struct {

	// Base-64 encoded password for the cluster admin user.
	ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}

TestBdsMetastoreConfigurationDetails The reqeust body when testing a BDS metastore configuration

func (TestBdsMetastoreConfigurationDetails) String

func (TestBdsMetastoreConfigurationDetails) ValidateEnumValue

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

type TestBdsMetastoreConfigurationRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The metastore configuration ID
	MetastoreConfigId *string `mandatory:"true" contributesTo:"path" name:"metastoreConfigId"`

	// Request body for testing BDS metastore configuration.
	TestBdsMetastoreConfigurationDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

TestBdsMetastoreConfigurationRequest wrapper for the TestBdsMetastoreConfiguration operation

See also

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

func (TestBdsMetastoreConfigurationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (TestBdsMetastoreConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (TestBdsMetastoreConfigurationRequest) RetryPolicy

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

func (TestBdsMetastoreConfigurationRequest) String

func (TestBdsMetastoreConfigurationRequest) ValidateEnumValue

func (request TestBdsMetastoreConfigurationRequest) 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 TestBdsMetastoreConfigurationResponse

type TestBdsMetastoreConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

TestBdsMetastoreConfigurationResponse wrapper for the TestBdsMetastoreConfiguration operation

func (TestBdsMetastoreConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (TestBdsMetastoreConfigurationResponse) String

type TestBdsObjectStorageConnectionDetails

type TestBdsObjectStorageConnectionDetails struct {

	// An Oracle Cloud Infrastructure URI to which this connection must be attempted. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
	ObjectStorageUri *string `mandatory:"true" json:"objectStorageUri"`

	// Base64 passphrase used to secure the private key which will be created on user behalf.
	Passphrase *string `mandatory:"true" json:"passphrase"`

	// The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 .
	ObjectStorageRegion *string `mandatory:"false" json:"objectStorageRegion"`
}

TestBdsObjectStorageConnectionDetails Test access to specified Object Storage bucket using the API key.

func (TestBdsObjectStorageConnectionDetails) String

func (TestBdsObjectStorageConnectionDetails) ValidateEnumValue

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

type TestBdsObjectStorageConnectionRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The API key identifier.
	ApiKeyId *string `mandatory:"true" contributesTo:"path" name:"apiKeyId"`

	// Parameters required to validate access to the specified Object Storage bucket using the API key.
	TestBdsObjectStorageConnectionDetails `contributesTo:"body"`

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

TestBdsObjectStorageConnectionRequest wrapper for the TestBdsObjectStorageConnection operation

See also

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

func (TestBdsObjectStorageConnectionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (TestBdsObjectStorageConnectionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (TestBdsObjectStorageConnectionRequest) RetryPolicy

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

func (TestBdsObjectStorageConnectionRequest) String

func (TestBdsObjectStorageConnectionRequest) ValidateEnumValue

func (request TestBdsObjectStorageConnectionRequest) 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 TestBdsObjectStorageConnectionResponse

type TestBdsObjectStorageConnectionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

TestBdsObjectStorageConnectionResponse wrapper for the TestBdsObjectStorageConnection operation

func (TestBdsObjectStorageConnectionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (TestBdsObjectStorageConnectionResponse) String

type UpdateAutoScalingConfigurationDetails

type UpdateAutoScalingConfigurationDetails struct {

	// A user-friendly name. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Whether the autoscale configuration is enabled.
	IsEnabled *bool `mandatory:"false" json:"isEnabled"`

	// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
	ClusterAdminPassword *string `mandatory:"false" json:"clusterAdminPassword"`

	Policy *AutoScalePolicy `mandatory:"false" json:"policy"`
}

UpdateAutoScalingConfigurationDetails The information about the autoscale configuration.

func (UpdateAutoScalingConfigurationDetails) String

func (UpdateAutoScalingConfigurationDetails) ValidateEnumValue

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

type UpdateAutoScalingConfigurationRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Unique Oracle-assigned identifier of the autoscale configuration.
	AutoScalingConfigurationId *string `mandatory:"true" contributesTo:"path" name:"autoScalingConfigurationId"`

	// Details for update an autoscaling configuration.
	UpdateAutoScalingConfigurationDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

UpdateAutoScalingConfigurationRequest wrapper for the UpdateAutoScalingConfiguration operation

See also

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

func (UpdateAutoScalingConfigurationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateAutoScalingConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateAutoScalingConfigurationRequest) RetryPolicy

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

func (UpdateAutoScalingConfigurationRequest) String

func (UpdateAutoScalingConfigurationRequest) ValidateEnumValue

func (request UpdateAutoScalingConfigurationRequest) 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 UpdateAutoScalingConfigurationResponse

type UpdateAutoScalingConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

UpdateAutoScalingConfigurationResponse wrapper for the UpdateAutoScalingConfiguration operation

func (UpdateAutoScalingConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateAutoScalingConfigurationResponse) String

type UpdateBdsInstanceDetails

type UpdateBdsInstanceDetails struct {

	// Name of the cluster.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Simple key-value pair that is applied without any predefined name, type, or scope.
	// Exists for cross-compatibility only. For 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.
	// For example, `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateBdsInstanceDetails The information about to-be-updated Big Data Service cluster.

func (UpdateBdsInstanceDetails) String

func (m UpdateBdsInstanceDetails) String() string

func (UpdateBdsInstanceDetails) ValidateEnumValue

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

type UpdateBdsInstanceRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// Details for the cluster to be updated.
	UpdateBdsInstanceDetails `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
}

UpdateBdsInstanceRequest wrapper for the UpdateBdsInstance operation

See also

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

func (UpdateBdsInstanceRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateBdsInstanceRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateBdsInstanceRequest) RetryPolicy

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

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

func (UpdateBdsInstanceRequest) String

func (request UpdateBdsInstanceRequest) String() string

func (UpdateBdsInstanceRequest) ValidateEnumValue

func (request UpdateBdsInstanceRequest) 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 UpdateBdsInstanceResponse

type UpdateBdsInstanceResponse 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 request, provide this request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateBdsInstanceResponse wrapper for the UpdateBdsInstance operation

func (UpdateBdsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateBdsInstanceResponse) String

func (response UpdateBdsInstanceResponse) String() string

type UpdateBdsMetastoreConfigurationDetails

type UpdateBdsMetastoreConfigurationDetails struct {

	// The display name of the metastore configuration.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The ID of BDS Api Key used for Data Catalog metastore integration. Set only if metastore's type is EXTERNAL.
	BdsApiKeyId *string `mandatory:"false" json:"bdsApiKeyId"`

	// Base-64 encoded passphrase of the BDS Api Key.
	BdsApiKeyPassphrase *string `mandatory:"false" json:"bdsApiKeyPassphrase"`

	// Base-64 encoded password for the cluster admin user.
	ClusterAdminPassword *string `mandatory:"false" json:"clusterAdminPassword"`
}

UpdateBdsMetastoreConfigurationDetails The request body when updating BDS metastore configuration.

func (UpdateBdsMetastoreConfigurationDetails) String

func (UpdateBdsMetastoreConfigurationDetails) ValidateEnumValue

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

type UpdateBdsMetastoreConfigurationRequest struct {

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The metastore configuration ID
	MetastoreConfigId *string `mandatory:"true" contributesTo:"path" name:"metastoreConfigId"`

	// Request body for updating BDS metastore configuration.
	UpdateBdsMetastoreConfigurationDetails `contributesTo:"body"`

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

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

UpdateBdsMetastoreConfigurationRequest wrapper for the UpdateBdsMetastoreConfiguration operation

See also

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

func (UpdateBdsMetastoreConfigurationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateBdsMetastoreConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateBdsMetastoreConfigurationRequest) RetryPolicy

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

func (UpdateBdsMetastoreConfigurationRequest) String

func (UpdateBdsMetastoreConfigurationRequest) ValidateEnumValue

func (request UpdateBdsMetastoreConfigurationRequest) 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 UpdateBdsMetastoreConfigurationResponse

type UpdateBdsMetastoreConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

UpdateBdsMetastoreConfigurationResponse wrapper for the UpdateBdsMetastoreConfiguration operation

func (UpdateBdsMetastoreConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateBdsMetastoreConfigurationResponse) String

type VolumeAttachmentDetail

type VolumeAttachmentDetail struct {

	// The OCID of the volume attachment.
	VolumeAttachmentId *string `mandatory:"true" json:"volumeAttachmentId"`

	// The size of the volume in GBs.
	VolumeSizeInGBs *int64 `mandatory:"true" json:"volumeSizeInGBs"`
}

VolumeAttachmentDetail A detail of the attached block volume.

func (VolumeAttachmentDetail) String

func (m VolumeAttachmentDetail) String() string

func (VolumeAttachmentDetail) ValidateEnumValue

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

type WorkRequest struct {

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

	// The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

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

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

	// Percentage of this work request completed.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the request was created, shown as an RFC 3339 formatted datetime string.
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The time the request was started, shown as an RFC 3339 formatted datetime string.
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The time the object was finished, shown as an RFC 3339 formatted datetime string.
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

WorkRequest Description of the work request status.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

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

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

type WorkRequestError

type WorkRequestError struct {

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

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

	// The time the error occured, shown as an RFC 3339 formatted datetime string.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

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

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

type WorkRequestLogEntry

type WorkRequestLogEntry struct {

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

	// The time the log message was written, shown as an RFC 3339 formatted datetime string.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

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

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

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

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

type 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 remains 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 ActionTypesEnum `mandatory:"true" json:"actionType"`

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

	// The URI path that the user can do a GET on to access the resource metadata.
	EntityUri *string `mandatory:"false" json:"entityUri"`
}

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

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

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

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

Source Files

Jump to

Keyboard shortcuts

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