func GetActionTypesEnumStringValues() []string
GetActionTypesEnumStringValues Enumerates the set of values in String for ActionTypesEnum
func GetAddBlockStorageDetailsNodeTypeEnumStringValues() []string
GetAddBlockStorageDetailsNodeTypeEnumStringValues Enumerates the set of values in String for AddBlockStorageDetailsNodeTypeEnum
func GetAddWorkerNodesDetailsNodeTypeEnumStringValues() []string
GetAddWorkerNodesDetailsNodeTypeEnumStringValues Enumerates the set of values in String for AddWorkerNodesDetailsNodeTypeEnum
func GetAutoScalePolicyDetailsActionTypeEnumStringValues() []string
GetAutoScalePolicyDetailsActionTypeEnumStringValues Enumerates the set of values in String for AutoScalePolicyDetailsActionTypeEnum
func GetAutoScalePolicyDetailsPolicyTypeEnumStringValues() []string
GetAutoScalePolicyDetailsPolicyTypeEnumStringValues Enumerates the set of values in String for AutoScalePolicyDetailsPolicyTypeEnum
func GetAutoScalePolicyDetailsTriggerTypeEnumStringValues() []string
GetAutoScalePolicyDetailsTriggerTypeEnumStringValues Enumerates the set of values in String for AutoScalePolicyDetailsTriggerTypeEnum
func GetAutoScalePolicyMetricRuleMetricTypeEnumStringValues() []string
GetAutoScalePolicyMetricRuleMetricTypeEnumStringValues Enumerates the set of values in String for AutoScalePolicyMetricRuleMetricTypeEnum
func GetAutoScalePolicyPolicyTypeEnumStringValues() []string
GetAutoScalePolicyPolicyTypeEnumStringValues Enumerates the set of values in String for AutoScalePolicyPolicyTypeEnum
func GetAutoScalePolicyRuleActionEnumStringValues() []string
GetAutoScalePolicyRuleActionEnumStringValues Enumerates the set of values in String for AutoScalePolicyRuleActionEnum
func GetAutoScalingConfigurationLifecycleStateEnumStringValues() []string
GetAutoScalingConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for AutoScalingConfigurationLifecycleStateEnum
func GetBdsApiKeyLifecycleStateEnumStringValues() []string
GetBdsApiKeyLifecycleStateEnumStringValues Enumerates the set of values in String for BdsApiKeyLifecycleStateEnum
func GetBdsInstanceClusterProfileEnumStringValues() []string
GetBdsInstanceClusterProfileEnumStringValues Enumerates the set of values in String for BdsInstanceClusterProfileEnum
func GetBdsInstanceClusterVersionEnumStringValues() []string
GetBdsInstanceClusterVersionEnumStringValues Enumerates the set of values in String for BdsInstanceClusterVersionEnum
func GetBdsInstanceLifecycleStateEnumStringValues() []string
GetBdsInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for BdsInstanceLifecycleStateEnum
func GetBdsMetastoreConfigurationLifecycleStateEnumStringValues() []string
GetBdsMetastoreConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for BdsMetastoreConfigurationLifecycleStateEnum
func GetBdsMetastoreConfigurationMetastoreTypeEnumStringValues() []string
GetBdsMetastoreConfigurationMetastoreTypeEnumStringValues Enumerates the set of values in String for BdsMetastoreConfigurationMetastoreTypeEnum
func GetCertificateServiceInfoSummaryServiceCertificateStatusEnumStringValues() []string
GetCertificateServiceInfoSummaryServiceCertificateStatusEnumStringValues Enumerates the set of values in String for CertificateServiceInfoSummaryServiceCertificateStatusEnum
func GetCertificateServiceInfoSummaryServiceEnumStringValues() []string
GetCertificateServiceInfoSummaryServiceEnumStringValues Enumerates the set of values in String for CertificateServiceInfoSummaryServiceEnum
func GetGetIdentityConfigurationSortByEnumStringValues() []string
GetGetIdentityConfigurationSortByEnumStringValues Enumerates the set of values in String for GetIdentityConfigurationSortByEnum
func GetGetIdentityConfigurationSortOrderEnumStringValues() []string
GetGetIdentityConfigurationSortOrderEnumStringValues Enumerates the set of values in String for GetIdentityConfigurationSortOrderEnum
func GetHostSpecificCertificateDetailsCertificateTypeEnumStringValues() []string
GetHostSpecificCertificateDetailsCertificateTypeEnumStringValues Enumerates the set of values in String for HostSpecificCertificateDetailsCertificateTypeEnum
func GetIamUserSyncConfigurationLifecycleStateEnumStringValues() []string
GetIamUserSyncConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for IamUserSyncConfigurationLifecycleStateEnum
func GetIdentityConfigurationLifecycleStateEnumStringValues() []string
GetIdentityConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for IdentityConfigurationLifecycleStateEnum
func GetLevelTypeDetailsLevelTypeEnumStringValues() []string
GetLevelTypeDetailsLevelTypeEnumStringValues Enumerates the set of values in String for LevelTypeDetailsLevelTypeEnum
func GetListAutoScalingConfigurationsSortByEnumStringValues() []string
GetListAutoScalingConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListAutoScalingConfigurationsSortByEnum
func GetListAutoScalingConfigurationsSortOrderEnumStringValues() []string
GetListAutoScalingConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListAutoScalingConfigurationsSortOrderEnum
func GetListBdsApiKeysSortByEnumStringValues() []string
GetListBdsApiKeysSortByEnumStringValues Enumerates the set of values in String for ListBdsApiKeysSortByEnum
func GetListBdsApiKeysSortOrderEnumStringValues() []string
GetListBdsApiKeysSortOrderEnumStringValues Enumerates the set of values in String for ListBdsApiKeysSortOrderEnum
func GetListBdsClusterVersionsSortByEnumStringValues() []string
GetListBdsClusterVersionsSortByEnumStringValues Enumerates the set of values in String for ListBdsClusterVersionsSortByEnum
func GetListBdsClusterVersionsSortOrderEnumStringValues() []string
GetListBdsClusterVersionsSortOrderEnumStringValues Enumerates the set of values in String for ListBdsClusterVersionsSortOrderEnum
func GetListBdsInstancesSortByEnumStringValues() []string
GetListBdsInstancesSortByEnumStringValues Enumerates the set of values in String for ListBdsInstancesSortByEnum
func GetListBdsInstancesSortOrderEnumStringValues() []string
GetListBdsInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListBdsInstancesSortOrderEnum
func GetListBdsMetastoreConfigurationsSortByEnumStringValues() []string
GetListBdsMetastoreConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListBdsMetastoreConfigurationsSortByEnum
func GetListBdsMetastoreConfigurationsSortOrderEnumStringValues() []string
GetListBdsMetastoreConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListBdsMetastoreConfigurationsSortOrderEnum
func GetListIdentityConfigurationsSortByEnumStringValues() []string
GetListIdentityConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListIdentityConfigurationsSortByEnum
func GetListIdentityConfigurationsSortOrderEnumStringValues() []string
GetListIdentityConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListIdentityConfigurationsSortOrderEnum
func GetListNodeBackupConfigurationsSortByEnumStringValues() []string
GetListNodeBackupConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListNodeBackupConfigurationsSortByEnum
func GetListNodeBackupConfigurationsSortOrderEnumStringValues() []string
GetListNodeBackupConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListNodeBackupConfigurationsSortOrderEnum
func GetListNodeBackupsSortByEnumStringValues() []string
GetListNodeBackupsSortByEnumStringValues Enumerates the set of values in String for ListNodeBackupsSortByEnum
func GetListNodeBackupsSortOrderEnumStringValues() []string
GetListNodeBackupsSortOrderEnumStringValues Enumerates the set of values in String for ListNodeBackupsSortOrderEnum
func GetListNodeReplaceConfigurationsSortByEnumStringValues() []string
GetListNodeReplaceConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListNodeReplaceConfigurationsSortByEnum
func GetListNodeReplaceConfigurationsSortOrderEnumStringValues() []string
GetListNodeReplaceConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListNodeReplaceConfigurationsSortOrderEnum
func GetListOsPatchesSortByEnumStringValues() []string
GetListOsPatchesSortByEnumStringValues Enumerates the set of values in String for ListOsPatchesSortByEnum
func GetListOsPatchesSortOrderEnumStringValues() []string
GetListOsPatchesSortOrderEnumStringValues Enumerates the set of values in String for ListOsPatchesSortOrderEnum
func GetListPatchHistoriesSortByEnumStringValues() []string
GetListPatchHistoriesSortByEnumStringValues Enumerates the set of values in String for ListPatchHistoriesSortByEnum
func GetListPatchHistoriesSortOrderEnumStringValues() []string
GetListPatchHistoriesSortOrderEnumStringValues Enumerates the set of values in String for ListPatchHistoriesSortOrderEnum
func GetListResourcePrincipalConfigurationsSortByEnumStringValues() []string
GetListResourcePrincipalConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListResourcePrincipalConfigurationsSortByEnum
func GetListResourcePrincipalConfigurationsSortOrderEnumStringValues() []string
GetListResourcePrincipalConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListResourcePrincipalConfigurationsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetMetricThresholdRuleOperatorEnumStringValues() []string
GetMetricThresholdRuleOperatorEnumStringValues Enumerates the set of values in String for MetricThresholdRuleOperatorEnum
func GetNodeBackupBackupTriggerTypeEnumStringValues() []string
GetNodeBackupBackupTriggerTypeEnumStringValues Enumerates the set of values in String for NodeBackupBackupTriggerTypeEnum
func GetNodeBackupBackupTypeEnumStringValues() []string
GetNodeBackupBackupTypeEnumStringValues Enumerates the set of values in String for NodeBackupBackupTypeEnum
func GetNodeBackupConfigurationLifecycleStateEnumStringValues() []string
GetNodeBackupConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for NodeBackupConfigurationLifecycleStateEnum
func GetNodeBackupLifecycleStateEnumStringValues() []string
GetNodeBackupLifecycleStateEnumStringValues Enumerates the set of values in String for NodeBackupLifecycleStateEnum
func GetNodeLifecycleStateEnumStringValues() []string
GetNodeLifecycleStateEnumStringValues Enumerates the set of values in String for NodeLifecycleStateEnum
func GetNodeNodeTypeEnumStringValues() []string
GetNodeNodeTypeEnumStringValues Enumerates the set of values in String for NodeNodeTypeEnum
func GetNodeReplaceConfigurationLifecycleStateEnumStringValues() []string
GetNodeReplaceConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for NodeReplaceConfigurationLifecycleStateEnum
func GetNodeReplaceConfigurationMetricTypeEnumStringValues() []string
GetNodeReplaceConfigurationMetricTypeEnumStringValues Enumerates the set of values in String for NodeReplaceConfigurationMetricTypeEnum
func GetOdhPatchingConfigPatchingConfigStrategyEnumStringValues() []string
GetOdhPatchingConfigPatchingConfigStrategyEnumStringValues Enumerates the set of values in String for OdhPatchingConfigPatchingConfigStrategyEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypesEnumStringValues() []string
GetOperationTypesEnumStringValues Enumerates the set of values in String for OperationTypesEnum
func GetOsPatchDetailsPatchTypeEnumStringValues() []string
GetOsPatchDetailsPatchTypeEnumStringValues Enumerates the set of values in String for OsPatchDetailsPatchTypeEnum
func GetOsPatchPackageSummaryUpdateTypeEnumStringValues() []string
GetOsPatchPackageSummaryUpdateTypeEnumStringValues Enumerates the set of values in String for OsPatchPackageSummaryUpdateTypeEnum
func GetPatchHistorySummaryLifecycleStateEnumStringValues() []string
GetPatchHistorySummaryLifecycleStateEnumStringValues Enumerates the set of values in String for PatchHistorySummaryLifecycleStateEnum
func GetPatchHistorySummaryPatchTypeEnumStringValues() []string
GetPatchHistorySummaryPatchTypeEnumStringValues Enumerates the set of values in String for PatchHistorySummaryPatchTypeEnum
func GetPatchingConfigsPatchingConfigStrategyEnumStringValues() []string
GetPatchingConfigsPatchingConfigStrategyEnumStringValues Enumerates the set of values in String for PatchingConfigsPatchingConfigStrategyEnum
func GetResourcePrincipalConfigurationLifecycleStateEnumStringValues() []string
GetResourcePrincipalConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for ResourcePrincipalConfigurationLifecycleStateEnum
func GetScheduleTypeEnumStringValues() []string
GetScheduleTypeEnumStringValues Enumerates the set of values in String for ScheduleTypeEnum
func GetServiceEnumStringValues() []string
GetServiceEnumStringValues Enumerates the set of values in String for ServiceEnum
func GetSortOrdersEnumStringValues() []string
GetSortOrdersEnumStringValues Enumerates the set of values in String for SortOrdersEnum
func GetUpstConfigurationLifecycleStateEnumStringValues() []string
GetUpstConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for UpstConfigurationLifecycleStateEnum
ActionTypesEnum Enum with underlying type: string
type ActionTypesEnum string
Set of constants representing the allowable values for ActionTypesEnum
const (
ActionTypesCreated ActionTypesEnum = "CREATED"
ActionTypesUpdated ActionTypesEnum = "UPDATED"
ActionTypesDeleted ActionTypesEnum = "DELETED"
ActionTypesInProgress ActionTypesEnum = "IN_PROGRESS"
ActionTypesFailed ActionTypesEnum = "FAILED"
)
func GetActionTypesEnumValues() []ActionTypesEnum
GetActionTypesEnumValues Enumerates the set of values for ActionTypesEnum
func GetMappingActionTypesEnum(val string) (ActionTypesEnum, bool)
GetMappingActionTypesEnum performs case Insensitive comparison on enum value and return the desired enum
ActivateBdsMetastoreConfigurationDetails The reqeust body when activating a BDS metastore configuration
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"`
}
func (m ActivateBdsMetastoreConfigurationDetails) String() string
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
ActivateBdsMetastoreConfigurationRequest wrapper for the ActivateBdsMetastoreConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ActivateBdsMetastoreConfiguration.go.html to see an example of how to use 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
}
func (request ActivateBdsMetastoreConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ActivateBdsMetastoreConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ActivateBdsMetastoreConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ActivateBdsMetastoreConfigurationRequest) String() string
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
ActivateBdsMetastoreConfigurationResponse wrapper for the ActivateBdsMetastoreConfiguration operation
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"`
}
func (response ActivateBdsMetastoreConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ActivateBdsMetastoreConfigurationResponse) String() string
ActivateIamUserSyncConfigurationDetails Details for activating IAM user sync configuration
type ActivateIamUserSyncConfigurationDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// whether posix attribute needs to be appended to users
IsPosixAttributesAdditionRequired *bool `mandatory:"false" json:"isPosixAttributesAdditionRequired"`
}
func (m ActivateIamUserSyncConfigurationDetails) String() string
func (m ActivateIamUserSyncConfigurationDetails) 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
ActivateIamUserSyncConfigurationRequest wrapper for the ActivateIamUserSyncConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ActivateIamUserSyncConfiguration.go.html to see an example of how to use ActivateIamUserSyncConfigurationRequest.
type ActivateIamUserSyncConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The OCID of the identity configuration
IdentityConfigurationId *string `mandatory:"true" contributesTo:"path" name:"identityConfigurationId"`
// Details for activating a new IAM user sync config.
ActivateIamUserSyncConfigurationDetails `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"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ActivateIamUserSyncConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ActivateIamUserSyncConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ActivateIamUserSyncConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ActivateIamUserSyncConfigurationRequest) String() string
func (request ActivateIamUserSyncConfigurationRequest) 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
ActivateIamUserSyncConfigurationResponse wrapper for the ActivateIamUserSyncConfiguration operation
type ActivateIamUserSyncConfigurationResponse 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"`
}
func (response ActivateIamUserSyncConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ActivateIamUserSyncConfigurationResponse) String() string
ActivateUpstConfigurationDetails Details for activating UPST config on the cluster
type ActivateUpstConfigurationDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// OCID of the vault to store token exchange service principal keyta, required for creating UPST configb
VaultId *string `mandatory:"true" json:"vaultId"`
// OCID of the master encryption key in vault for encrypting token exchange service principal keytab, required for creating UPST config
MasterEncryptionKeyId *string `mandatory:"true" json:"masterEncryptionKeyId"`
}
func (m ActivateUpstConfigurationDetails) String() string
func (m ActivateUpstConfigurationDetails) 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
ActivateUpstConfigurationRequest wrapper for the ActivateUpstConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ActivateUpstConfiguration.go.html to see an example of how to use ActivateUpstConfigurationRequest.
type ActivateUpstConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The OCID of the identity configuration
IdentityConfigurationId *string `mandatory:"true" contributesTo:"path" name:"identityConfigurationId"`
// Details for activating UPST config
ActivateUpstConfigurationDetails `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"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ActivateUpstConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ActivateUpstConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ActivateUpstConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ActivateUpstConfigurationRequest) String() string
func (request ActivateUpstConfigurationRequest) 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
ActivateUpstConfigurationResponse wrapper for the ActivateUpstConfiguration operation
type ActivateUpstConfigurationResponse 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"`
}
func (response ActivateUpstConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ActivateUpstConfigurationResponse) String() string
AddAutoScalePolicyDetails Policy definition for the autoscale configuration. An autoscaling policy is part of an autoscaling configuration. For more information, see Autoscaling (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-autoscale) You can create following type of autoscaling policies: - **MetricBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered when a performance metric exceeds a threshold - **MetricBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered when a performance metric exceeds a threshold - **ScheduleBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered at the specific times that you schedule. - **ScheduleBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered at the specific times that you schedule. An autoscaling configuration can have one of above supported policies.
type AddAutoScalePolicyDetails interface {
}
AddAutoScalingConfigurationDetails The information about the autoscale configuration.
type AddAutoScalingConfigurationDetails struct {
// A node type that is managed by an autoscale configuration. The only supported types are WORKER and COMPUTE_ONLY_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"`
// 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"`
Policy *AutoScalePolicy `mandatory:"false" json:"policy"`
PolicyDetails AddAutoScalePolicyDetails `mandatory:"false" json:"policyDetails"`
}
func (m AddAutoScalingConfigurationDetails) String() string
func (m *AddAutoScalingConfigurationDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
AddAutoScalingConfigurationRequest wrapper for the AddAutoScalingConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/AddAutoScalingConfiguration.go.html to see an example of how to use 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
}
func (request AddAutoScalingConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddAutoScalingConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddAutoScalingConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddAutoScalingConfigurationRequest) String() string
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
AddAutoScalingConfigurationResponse wrapper for the AddAutoScalingConfiguration operation
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"`
}
func (response AddAutoScalingConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddAutoScalingConfigurationResponse) String() string
AddBlockStorageDetails The information about added block volumes.
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"`
// Worker node types.
NodeType AddBlockStorageDetailsNodeTypeEnum `mandatory:"true" json:"nodeType"`
}
func (m AddBlockStorageDetails) String() string
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
AddBlockStorageDetailsNodeTypeEnum Enum with underlying type: string
type AddBlockStorageDetailsNodeTypeEnum string
Set of constants representing the allowable values for AddBlockStorageDetailsNodeTypeEnum
const (
AddBlockStorageDetailsNodeTypeWorker AddBlockStorageDetailsNodeTypeEnum = "WORKER"
AddBlockStorageDetailsNodeTypeComputeOnlyWorker AddBlockStorageDetailsNodeTypeEnum = "COMPUTE_ONLY_WORKER"
AddBlockStorageDetailsNodeTypeKafkaBroker AddBlockStorageDetailsNodeTypeEnum = "KAFKA_BROKER"
)
func GetAddBlockStorageDetailsNodeTypeEnumValues() []AddBlockStorageDetailsNodeTypeEnum
GetAddBlockStorageDetailsNodeTypeEnumValues Enumerates the set of values for AddBlockStorageDetailsNodeTypeEnum
func GetMappingAddBlockStorageDetailsNodeTypeEnum(val string) (AddBlockStorageDetailsNodeTypeEnum, bool)
GetMappingAddBlockStorageDetailsNodeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddBlockStorageRequest wrapper for the AddBlockStorage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/AddBlockStorage.go.html to see an example of how to use 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
}
func (request AddBlockStorageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddBlockStorageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddBlockStorageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddBlockStorageRequest) String() string
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
AddBlockStorageResponse wrapper for the AddBlockStorage operation
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"`
}
func (response AddBlockStorageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddBlockStorageResponse) String() string
AddCloudSqlDetails The information about the added Cloud SQL.
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"`
ShapeConfig *ShapeConfigDetails `mandatory:"false" json:"shapeConfig"`
// 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"`
}
func (m AddCloudSqlDetails) String() string
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
AddCloudSqlRequest wrapper for the AddCloudSql operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/AddCloudSql.go.html to see an example of how to use 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
}
func (request AddCloudSqlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddCloudSqlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddCloudSqlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddCloudSqlRequest) String() string
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
AddCloudSqlResponse wrapper for the AddCloudSql operation
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"`
}
func (response AddCloudSqlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddCloudSqlResponse) String() string
AddKafkaDetails The information about the Kafka service to be added.
type AddKafkaDetails struct {
// Shape of the Kafka broker node.
Shape *string `mandatory:"true" json:"shape"`
// Number of Kafka nodes for the cluster.
NumberOfKafkaNodes *int `mandatory:"true" json:"numberOfKafkaNodes"`
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
ShapeConfig *ShapeConfigDetails `mandatory:"false" json:"shapeConfig"`
// The size of block volme 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"`
}
func (m AddKafkaDetails) String() string
func (m AddKafkaDetails) 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
AddKafkaRequest wrapper for the AddKafka operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/AddKafka.go.html to see an example of how to use AddKafkaRequest.
type AddKafkaRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details of the Kafka broker nodes to employ to enable the service.
AddKafkaDetails `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
}
func (request AddKafkaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddKafkaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddKafkaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddKafkaRequest) String() string
func (request AddKafkaRequest) 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
AddKafkaResponse wrapper for the AddKafka operation
type AddKafkaResponse 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"`
}
func (response AddKafkaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddKafkaResponse) String() string
AddMasterNodesDetails The information about added master nodes.
type AddMasterNodesDetails struct {
// Base-64 encoded Cluster Admin Password for cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// Number of additional master nodes for the cluster.
NumberOfMasterNodes *int `mandatory:"true" json:"numberOfMasterNodes"`
// Shape of the node. It's a read-only property derived from existing Master node.
Shape *string `mandatory:"false" json:"shape"`
// The size of block volume in GB to be attached to the given node. It's a read-only property.
BlockVolumeSizeInGBs *int64 `mandatory:"false" json:"blockVolumeSizeInGBs"`
ShapeConfig *ShapeConfigDetails `mandatory:"false" json:"shapeConfig"`
}
func (m AddMasterNodesDetails) String() string
func (m AddMasterNodesDetails) 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
AddMasterNodesRequest wrapper for the AddMasterNodes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/AddMasterNodes.go.html to see an example of how to use AddMasterNodesRequest.
type AddMasterNodesRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for the newly added nodes.
AddMasterNodesDetails `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
}
func (request AddMasterNodesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddMasterNodesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddMasterNodesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddMasterNodesRequest) String() string
func (request AddMasterNodesRequest) 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
AddMasterNodesResponse wrapper for the AddMasterNodes operation
type AddMasterNodesResponse 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"`
}
func (response AddMasterNodesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddMasterNodesResponse) String() string
AddMetricBasedHorizontalScalingPolicyDetails Details of a metric based horizontal autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.
type AddMetricBasedHorizontalScalingPolicyDetails struct {
ScaleOutConfig *MetricBasedHorizontalScaleOutConfig `mandatory:"false" json:"scaleOutConfig"`
ScaleInConfig *MetricBasedHorizontalScaleInConfig `mandatory:"false" json:"scaleInConfig"`
}
func (m AddMetricBasedHorizontalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AddMetricBasedHorizontalScalingPolicyDetails) String() string
func (m AddMetricBasedHorizontalScalingPolicyDetails) 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
AddMetricBasedVerticalScalingPolicyDetails Details of a metric based vertical autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.
type AddMetricBasedVerticalScalingPolicyDetails struct {
ScaleUpConfig *MetricBasedVerticalScaleUpConfig `mandatory:"false" json:"scaleUpConfig"`
ScaleDownConfig *MetricBasedVerticalScaleDownConfig `mandatory:"false" json:"scaleDownConfig"`
}
func (m AddMetricBasedVerticalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AddMetricBasedVerticalScalingPolicyDetails) String() string
func (m AddMetricBasedVerticalScalingPolicyDetails) 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
AddScheduleBasedHorizontalScalingPolicyDetails Details of a schedule based horizontal autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.
type AddScheduleBasedHorizontalScalingPolicyDetails struct {
// The time zone of the execution schedule, in IANA time zone database name format
Timezone *string `mandatory:"false" json:"timezone"`
// Details of a horizontal scaling schedule.
ScheduleDetails []HorizontalScalingScheduleDetails `mandatory:"false" json:"scheduleDetails"`
}
func (m AddScheduleBasedHorizontalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AddScheduleBasedHorizontalScalingPolicyDetails) String() string
func (m *AddScheduleBasedHorizontalScalingPolicyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AddScheduleBasedHorizontalScalingPolicyDetails) 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
AddScheduleBasedVerticalScalingPolicyDetails Details of a schedule based vertical autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.
type AddScheduleBasedVerticalScalingPolicyDetails struct {
// The time zone of the execution schedule, in IANA time zone database name format
Timezone *string `mandatory:"false" json:"timezone"`
// Details of a vertical scaling schedule.
ScheduleDetails []VerticalScalingScheduleDetails `mandatory:"false" json:"scheduleDetails"`
}
func (m AddScheduleBasedVerticalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AddScheduleBasedVerticalScalingPolicyDetails) String() string
func (m *AddScheduleBasedVerticalScalingPolicyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AddScheduleBasedVerticalScalingPolicyDetails) 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
AddUtilityNodesDetails The information about added utility nodes.
type AddUtilityNodesDetails struct {
// Base-64 encoded Cluster Admin Password for cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// Number of additional utility nodes for the cluster.
NumberOfUtilityNodes *int `mandatory:"true" json:"numberOfUtilityNodes"`
// Shape of the node. It's a read-only property derived from existing Utility node.
Shape *string `mandatory:"false" json:"shape"`
// The size of block volume in GB to be attached to the given node. It's a read-only property.
BlockVolumeSizeInGBs *int64 `mandatory:"false" json:"blockVolumeSizeInGBs"`
ShapeConfig *ShapeConfigDetails `mandatory:"false" json:"shapeConfig"`
}
func (m AddUtilityNodesDetails) String() string
func (m AddUtilityNodesDetails) 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
AddUtilityNodesRequest wrapper for the AddUtilityNodes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/AddUtilityNodes.go.html to see an example of how to use AddUtilityNodesRequest.
type AddUtilityNodesRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for the newly added nodes.
AddUtilityNodesDetails `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
}
func (request AddUtilityNodesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddUtilityNodesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddUtilityNodesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddUtilityNodesRequest) String() string
func (request AddUtilityNodesRequest) 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
AddUtilityNodesResponse wrapper for the AddUtilityNodes operation
type AddUtilityNodesResponse 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"`
}
func (response AddUtilityNodesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddUtilityNodesResponse) String() string
AddWorkerNodesDetails The information about added nodes.
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"`
// Worker node types, can either be Worker Data node or Compute only worker node.
NodeType AddWorkerNodesDetailsNodeTypeEnum `mandatory:"true" json:"nodeType"`
// Shape of the node. This has to be specified when adding compute only worker node at the first time. Otherwise, it's a read-only property.
Shape *string `mandatory:"false" json:"shape"`
// The size of block volume in GB to be attached to the given node. This has to be specified when adding compute only worker node at the first time. Otherwise, it's a read-only property.
BlockVolumeSizeInGBs *int64 `mandatory:"false" json:"blockVolumeSizeInGBs"`
ShapeConfig *ShapeConfigDetails `mandatory:"false" json:"shapeConfig"`
}
func (m AddWorkerNodesDetails) String() string
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
AddWorkerNodesDetailsNodeTypeEnum Enum with underlying type: string
type AddWorkerNodesDetailsNodeTypeEnum string
Set of constants representing the allowable values for AddWorkerNodesDetailsNodeTypeEnum
const (
AddWorkerNodesDetailsNodeTypeWorker AddWorkerNodesDetailsNodeTypeEnum = "WORKER"
AddWorkerNodesDetailsNodeTypeComputeOnlyWorker AddWorkerNodesDetailsNodeTypeEnum = "COMPUTE_ONLY_WORKER"
AddWorkerNodesDetailsNodeTypeEdge AddWorkerNodesDetailsNodeTypeEnum = "EDGE"
AddWorkerNodesDetailsNodeTypeKafkaBroker AddWorkerNodesDetailsNodeTypeEnum = "KAFKA_BROKER"
)
func GetAddWorkerNodesDetailsNodeTypeEnumValues() []AddWorkerNodesDetailsNodeTypeEnum
GetAddWorkerNodesDetailsNodeTypeEnumValues Enumerates the set of values for AddWorkerNodesDetailsNodeTypeEnum
func GetMappingAddWorkerNodesDetailsNodeTypeEnum(val string) (AddWorkerNodesDetailsNodeTypeEnum, bool)
GetMappingAddWorkerNodesDetailsNodeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddWorkerNodesRequest wrapper for the AddWorkerNodes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/AddWorkerNodes.go.html to see an example of how to use 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
}
func (request AddWorkerNodesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddWorkerNodesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddWorkerNodesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddWorkerNodesRequest) String() string
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
AddWorkerNodesResponse wrapper for the AddWorkerNodes operation
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"`
}
func (response AddWorkerNodesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddWorkerNodesResponse) String() string
AutoScalePolicy This model for autoscaling policy is deprecated and not supported for ODH clusters. Use the `AutoScalePolicyDetails` model to manage autoscale policy details for ODH clusters.
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"`
}
func (m AutoScalePolicy) String() string
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
AutoScalePolicyDetails Details of an autoscale policy. You can create following types of autoscaling policies: - **MetricBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered when a performance metric exceeds a threshold - **MetricBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered when a performance metric exceeds a threshold - **ScheduleBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered at the specific times that you schedule. - **ScheduleBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered at the specific times that you schedule.
type AutoScalePolicyDetails interface {
// The type of autoscaling trigger.
GetTriggerType() AutoScalePolicyDetailsTriggerTypeEnum
// The type of autoscaling action to take.
GetActionType() AutoScalePolicyDetailsActionTypeEnum
}
AutoScalePolicyDetailsActionTypeEnum Enum with underlying type: string
type AutoScalePolicyDetailsActionTypeEnum string
Set of constants representing the allowable values for AutoScalePolicyDetailsActionTypeEnum
const (
AutoScalePolicyDetailsActionTypeVerticalScaling AutoScalePolicyDetailsActionTypeEnum = "VERTICAL_SCALING"
AutoScalePolicyDetailsActionTypeHorizontalScaling AutoScalePolicyDetailsActionTypeEnum = "HORIZONTAL_SCALING"
)
func GetAutoScalePolicyDetailsActionTypeEnumValues() []AutoScalePolicyDetailsActionTypeEnum
GetAutoScalePolicyDetailsActionTypeEnumValues Enumerates the set of values for AutoScalePolicyDetailsActionTypeEnum
func GetMappingAutoScalePolicyDetailsActionTypeEnum(val string) (AutoScalePolicyDetailsActionTypeEnum, bool)
GetMappingAutoScalePolicyDetailsActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AutoScalePolicyDetailsPolicyTypeEnum Enum with underlying type: string
type AutoScalePolicyDetailsPolicyTypeEnum string
Set of constants representing the allowable values for AutoScalePolicyDetailsPolicyTypeEnum
const (
AutoScalePolicyDetailsPolicyTypeMetricBasedVerticalScalingPolicy AutoScalePolicyDetailsPolicyTypeEnum = "METRIC_BASED_VERTICAL_SCALING_POLICY"
AutoScalePolicyDetailsPolicyTypeMetricBasedHorizontalScalingPolicy AutoScalePolicyDetailsPolicyTypeEnum = "METRIC_BASED_HORIZONTAL_SCALING_POLICY"
AutoScalePolicyDetailsPolicyTypeScheduleBasedVerticalScalingPolicy AutoScalePolicyDetailsPolicyTypeEnum = "SCHEDULE_BASED_VERTICAL_SCALING_POLICY"
AutoScalePolicyDetailsPolicyTypeScheduleBasedHorizontalScalingPolicy AutoScalePolicyDetailsPolicyTypeEnum = "SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY"
)
func GetAutoScalePolicyDetailsPolicyTypeEnumValues() []AutoScalePolicyDetailsPolicyTypeEnum
GetAutoScalePolicyDetailsPolicyTypeEnumValues Enumerates the set of values for AutoScalePolicyDetailsPolicyTypeEnum
func GetMappingAutoScalePolicyDetailsPolicyTypeEnum(val string) (AutoScalePolicyDetailsPolicyTypeEnum, bool)
GetMappingAutoScalePolicyDetailsPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AutoScalePolicyDetailsTriggerTypeEnum Enum with underlying type: string
type AutoScalePolicyDetailsTriggerTypeEnum string
Set of constants representing the allowable values for AutoScalePolicyDetailsTriggerTypeEnum
const (
AutoScalePolicyDetailsTriggerTypeMetricBased AutoScalePolicyDetailsTriggerTypeEnum = "METRIC_BASED"
AutoScalePolicyDetailsTriggerTypeScheduleBased AutoScalePolicyDetailsTriggerTypeEnum = "SCHEDULE_BASED"
)
func GetAutoScalePolicyDetailsTriggerTypeEnumValues() []AutoScalePolicyDetailsTriggerTypeEnum
GetAutoScalePolicyDetailsTriggerTypeEnumValues Enumerates the set of values for AutoScalePolicyDetailsTriggerTypeEnum
func GetMappingAutoScalePolicyDetailsTriggerTypeEnum(val string) (AutoScalePolicyDetailsTriggerTypeEnum, bool)
GetMappingAutoScalePolicyDetailsTriggerTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AutoScalePolicyMetricRule Metric and threshold details for triggering an autoscale action.
type AutoScalePolicyMetricRule struct {
// Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.
MetricType AutoScalePolicyMetricRuleMetricTypeEnum `mandatory:"true" json:"metricType"`
Threshold *MetricThresholdRule `mandatory:"true" json:"threshold"`
}
func (m AutoScalePolicyMetricRule) String() string
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
AutoScalePolicyMetricRuleMetricTypeEnum Enum with underlying type: string
type AutoScalePolicyMetricRuleMetricTypeEnum string
Set of constants representing the allowable values for AutoScalePolicyMetricRuleMetricTypeEnum
const (
AutoScalePolicyMetricRuleMetricTypeCpuUtilization AutoScalePolicyMetricRuleMetricTypeEnum = "CPU_UTILIZATION"
AutoScalePolicyMetricRuleMetricTypeMemoryUtilization AutoScalePolicyMetricRuleMetricTypeEnum = "MEMORY_UTILIZATION"
)
func GetAutoScalePolicyMetricRuleMetricTypeEnumValues() []AutoScalePolicyMetricRuleMetricTypeEnum
GetAutoScalePolicyMetricRuleMetricTypeEnumValues Enumerates the set of values for AutoScalePolicyMetricRuleMetricTypeEnum
func GetMappingAutoScalePolicyMetricRuleMetricTypeEnum(val string) (AutoScalePolicyMetricRuleMetricTypeEnum, bool)
GetMappingAutoScalePolicyMetricRuleMetricTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AutoScalePolicyPolicyTypeEnum Enum with underlying type: string
type AutoScalePolicyPolicyTypeEnum string
Set of constants representing the allowable values for AutoScalePolicyPolicyTypeEnum
const (
AutoScalePolicyPolicyTypeThresholdBased AutoScalePolicyPolicyTypeEnum = "THRESHOLD_BASED"
AutoScalePolicyPolicyTypeScheduleBased AutoScalePolicyPolicyTypeEnum = "SCHEDULE_BASED"
AutoScalePolicyPolicyTypeNone AutoScalePolicyPolicyTypeEnum = "NONE"
)
func GetAutoScalePolicyPolicyTypeEnumValues() []AutoScalePolicyPolicyTypeEnum
GetAutoScalePolicyPolicyTypeEnumValues Enumerates the set of values for AutoScalePolicyPolicyTypeEnum
func GetMappingAutoScalePolicyPolicyTypeEnum(val string) (AutoScalePolicyPolicyTypeEnum, bool)
GetMappingAutoScalePolicyPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AutoScalePolicyRule A rule that defines a specific autoscale action to take and the metric that triggers that action.
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"`
}
func (m AutoScalePolicyRule) String() string
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
AutoScalePolicyRuleActionEnum Enum with underlying type: string
type AutoScalePolicyRuleActionEnum string
Set of constants representing the allowable values for AutoScalePolicyRuleActionEnum
const (
AutoScalePolicyRuleActionUp AutoScalePolicyRuleActionEnum = "CHANGE_SHAPE_SCALE_UP"
AutoScalePolicyRuleActionDown AutoScalePolicyRuleActionEnum = "CHANGE_SHAPE_SCALE_DOWN"
)
func GetAutoScalePolicyRuleActionEnumValues() []AutoScalePolicyRuleActionEnum
GetAutoScalePolicyRuleActionEnumValues Enumerates the set of values for AutoScalePolicyRuleActionEnum
func GetMappingAutoScalePolicyRuleActionEnum(val string) (AutoScalePolicyRuleActionEnum, bool)
GetMappingAutoScalePolicyRuleActionEnum performs case Insensitive comparison on enum value and return the desired enum
AutoScalingConfiguration The information about the autoscale configuration.
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 types are WORKER and COMPUTE_ONLY_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"`
PolicyDetails AutoScalePolicyDetails `mandatory:"false" json:"policyDetails"`
}
func (m AutoScalingConfiguration) String() string
func (m *AutoScalingConfiguration) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
AutoScalingConfigurationLifecycleStateEnum Enum with underlying type: string
type AutoScalingConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for AutoScalingConfigurationLifecycleStateEnum
const (
AutoScalingConfigurationLifecycleStateCreating AutoScalingConfigurationLifecycleStateEnum = "CREATING"
AutoScalingConfigurationLifecycleStateActive AutoScalingConfigurationLifecycleStateEnum = "ACTIVE"
AutoScalingConfigurationLifecycleStateInactive AutoScalingConfigurationLifecycleStateEnum = "INACTIVE"
AutoScalingConfigurationLifecycleStateUpdating AutoScalingConfigurationLifecycleStateEnum = "UPDATING"
AutoScalingConfigurationLifecycleStateDeleting AutoScalingConfigurationLifecycleStateEnum = "DELETING"
AutoScalingConfigurationLifecycleStateDeleted AutoScalingConfigurationLifecycleStateEnum = "DELETED"
AutoScalingConfigurationLifecycleStateFailed AutoScalingConfigurationLifecycleStateEnum = "FAILED"
)
func GetAutoScalingConfigurationLifecycleStateEnumValues() []AutoScalingConfigurationLifecycleStateEnum
GetAutoScalingConfigurationLifecycleStateEnumValues Enumerates the set of values for AutoScalingConfigurationLifecycleStateEnum
func GetMappingAutoScalingConfigurationLifecycleStateEnum(val string) (AutoScalingConfigurationLifecycleStateEnum, bool)
GetMappingAutoScalingConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AutoScalingConfigurationSummary The information about the autoscale configuration.
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 types are WORKER and COMPUTE_ONLY_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"`
PolicyDetails AutoScalePolicyDetails `mandatory:"false" json:"policyDetails"`
}
func (m AutoScalingConfigurationSummary) String() string
func (m *AutoScalingConfigurationSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
BackupNodeDetails The information about the nodes to backup.
type BackupNodeDetails struct {
LevelTypeDetails LevelTypeDetails `mandatory:"true" json:"levelTypeDetails"`
// Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created.
BackupType NodeBackupBackupTypeEnum `mandatory:"false" json:"backupType,omitempty"`
}
func (m BackupNodeDetails) String() string
func (m *BackupNodeDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m BackupNodeDetails) 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
BackupNodeRequest wrapper for the BackupNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/BackupNode.go.html to see an example of how to use BackupNodeRequest.
type BackupNodeRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for Taking the node's backup
BackupNodeDetails `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
}
func (request BackupNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BackupNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BackupNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BackupNodeRequest) String() string
func (request BackupNodeRequest) 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
BackupNodeResponse wrapper for the BackupNode operation
type BackupNodeResponse 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"`
}
func (response BackupNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BackupNodeResponse) String() string
BatchingBasedOdhPatchingConfig Patching configurations which allows patch the nodes batch by batch.
type BatchingBasedOdhPatchingConfig struct {
// How many nodes to be patched in each iteration.
BatchSize *int `mandatory:"true" json:"batchSize"`
// The wait time between batches in seconds.
WaitTimeBetweenBatchInSeconds *int `mandatory:"true" json:"waitTimeBetweenBatchInSeconds"`
// Acceptable number of failed-to-be-patched nodes in each batch. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of non-utility and non-master nodes.
ToleranceThresholdPerBatch *int `mandatory:"false" json:"toleranceThresholdPerBatch"`
}
func (m BatchingBasedOdhPatchingConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m BatchingBasedOdhPatchingConfig) String() string
func (m BatchingBasedOdhPatchingConfig) 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
BatchingBasedPatchingConfigs Configuration that applies the patch in batches, the batch size is a user defined parameter.
type BatchingBasedPatchingConfigs struct {
// How many nodes to be patched and rebooted in each iteration.
BatchSize *int `mandatory:"true" json:"batchSize"`
// The wait time between batches in seconds.
WaitTimeBetweenBatchInSeconds *int `mandatory:"true" json:"waitTimeBetweenBatchInSeconds"`
// Acceptable number of failed-to-be-patched nodes in each batch. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of nodes.
ToleranceThresholdPerBatch *int `mandatory:"true" json:"toleranceThresholdPerBatch"`
}
func (m BatchingBasedPatchingConfigs) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m BatchingBasedPatchingConfigs) String() string
func (m BatchingBasedPatchingConfigs) 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
BdsApiKey The API key information.
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"`
// Identity domain OCID ,where user is present. For default domain ,this field will be optional.
DomainOcid *string `mandatory:"false" json:"domainOcid"`
}
func (m BdsApiKey) String() string
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
BdsApiKeyLifecycleStateEnum Enum with underlying type: string
type BdsApiKeyLifecycleStateEnum string
Set of constants representing the allowable values for BdsApiKeyLifecycleStateEnum
const (
BdsApiKeyLifecycleStateCreating BdsApiKeyLifecycleStateEnum = "CREATING"
BdsApiKeyLifecycleStateActive BdsApiKeyLifecycleStateEnum = "ACTIVE"
BdsApiKeyLifecycleStateDeleting BdsApiKeyLifecycleStateEnum = "DELETING"
BdsApiKeyLifecycleStateDeleted BdsApiKeyLifecycleStateEnum = "DELETED"
BdsApiKeyLifecycleStateFailed BdsApiKeyLifecycleStateEnum = "FAILED"
)
func GetBdsApiKeyLifecycleStateEnumValues() []BdsApiKeyLifecycleStateEnum
GetBdsApiKeyLifecycleStateEnumValues Enumerates the set of values for BdsApiKeyLifecycleStateEnum
func GetMappingBdsApiKeyLifecycleStateEnum(val string) (BdsApiKeyLifecycleStateEnum, bool)
GetMappingBdsApiKeyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BdsApiKeySummary The API key summary.
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"`
}
func (m BdsApiKeySummary) String() string
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
BdsClient a client for Bds
type BdsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client BdsClient) ActivateBdsMetastoreConfiguration(ctx context.Context, request ActivateBdsMetastoreConfigurationRequest) (response ActivateBdsMetastoreConfigurationResponse, err error)
ActivateBdsMetastoreConfiguration Activate specified metastore configuration.
Click https://docs.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 (client BdsClient) ActivateIamUserSyncConfiguration(ctx context.Context, request ActivateIamUserSyncConfigurationRequest) (response ActivateIamUserSyncConfigurationResponse, err error)
ActivateIamUserSyncConfiguration Activate IAM user sync configuration for the given identity configuration
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ActivateIamUserSyncConfiguration.go.html to see an example of how to use ActivateIamUserSyncConfiguration API.
func (client BdsClient) ActivateUpstConfiguration(ctx context.Context, request ActivateUpstConfigurationRequest) (response ActivateUpstConfigurationResponse, err error)
ActivateUpstConfiguration Activate UPST configuration for the given identity configuration
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ActivateUpstConfiguration.go.html to see an example of how to use ActivateUpstConfiguration API.
func (client BdsClient) AddAutoScalingConfiguration(ctx context.Context, request AddAutoScalingConfigurationRequest) (response AddAutoScalingConfigurationResponse, err error)
AddAutoScalingConfiguration Add an autoscale configuration to the cluster.
Click https://docs.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 (client BdsClient) AddBlockStorage(ctx context.Context, request AddBlockStorageRequest) (response AddBlockStorageResponse, err error)
AddBlockStorage Adds block storage to existing worker/compute only worker nodes. The same amount of storage will be added to all worker/compute only worker nodes. No change will be made to storage that is already attached. Block storage cannot be removed.
Click https://docs.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 (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.
Click https://docs.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 (client BdsClient) AddKafka(ctx context.Context, request AddKafkaRequest) (response AddKafkaResponse, err error)
AddKafka Adds Kafka to a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/AddKafka.go.html to see an example of how to use AddKafka API.
func (client BdsClient) AddMasterNodes(ctx context.Context, request AddMasterNodesRequest) (response AddMasterNodesResponse, err error)
AddMasterNodes Increases the size (scales out) of a cluster by adding master nodes. The added master nodes will have the same shape and will have the same amount of attached block storage as other master nodes in the cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/AddMasterNodes.go.html to see an example of how to use AddMasterNodes API.
func (client BdsClient) AddUtilityNodes(ctx context.Context, request AddUtilityNodesRequest) (response AddUtilityNodesResponse, err error)
AddUtilityNodes Increases the size (scales out) of a cluster by adding utility nodes. The added utility nodes will have the same shape and will have the same amount of attached block storage as other utility nodes in the cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/AddUtilityNodes.go.html to see an example of how to use AddUtilityNodes API.
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(data/compute). 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.
Click https://docs.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 (client BdsClient) BackupNode(ctx context.Context, request BackupNodeRequest) (response BackupNodeResponse, err error)
BackupNode Takes a backup of of given nodes.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/BackupNode.go.html to see an example of how to use BackupNode API.
func (client BdsClient) CertificateServiceInfo(ctx context.Context, request CertificateServiceInfoRequest) (response CertificateServiceInfoResponse, err error)
CertificateServiceInfo A list of services and their certificate details.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CertificateServiceInfo.go.html to see an example of how to use CertificateServiceInfo API.
func (client BdsClient) ChangeBdsInstanceCompartment(ctx context.Context, request ChangeBdsInstanceCompartmentRequest) (response ChangeBdsInstanceCompartmentResponse, err error)
ChangeBdsInstanceCompartment Moves a Big Data Service cluster into a different compartment.
Click https://docs.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 (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.
Click https://docs.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 (client *BdsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client BdsClient) CreateBdsApiKey(ctx context.Context, request CreateBdsApiKeyRequest) (response CreateBdsApiKeyResponse, err error)
CreateBdsApiKey Create an API key on behalf of the specified user.
Click https://docs.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 (client BdsClient) CreateBdsInstance(ctx context.Context, request CreateBdsInstanceRequest) (response CreateBdsInstanceResponse, err error)
CreateBdsInstance Creates a Big Data Service cluster.
Click https://docs.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 (client BdsClient) CreateBdsMetastoreConfiguration(ctx context.Context, request CreateBdsMetastoreConfigurationRequest) (response CreateBdsMetastoreConfigurationResponse, err error)
CreateBdsMetastoreConfiguration Create and activate external metastore configuration.
Click https://docs.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 (client BdsClient) CreateIdentityConfiguration(ctx context.Context, request CreateIdentityConfigurationRequest) (response CreateIdentityConfigurationResponse, err error)
CreateIdentityConfiguration Create an identity configuration for the cluster
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateIdentityConfiguration.go.html to see an example of how to use CreateIdentityConfiguration API.
func (client BdsClient) CreateNodeBackupConfiguration(ctx context.Context, request CreateNodeBackupConfigurationRequest) (response CreateNodeBackupConfigurationResponse, err error)
CreateNodeBackupConfiguration Add a node volume backup configuration to the cluster for an indicated node type or node.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateNodeBackupConfiguration.go.html to see an example of how to use CreateNodeBackupConfiguration API.
func (client BdsClient) CreateNodeReplaceConfiguration(ctx context.Context, request CreateNodeReplaceConfigurationRequest) (response CreateNodeReplaceConfigurationResponse, err error)
CreateNodeReplaceConfiguration Add a nodeReplaceConfigurations to the cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateNodeReplaceConfiguration.go.html to see an example of how to use CreateNodeReplaceConfiguration API.
func (client BdsClient) CreateResourcePrincipalConfiguration(ctx context.Context, request CreateResourcePrincipalConfigurationRequest) (response CreateResourcePrincipalConfigurationResponse, err error)
CreateResourcePrincipalConfiguration Create a resource principal session token configuration.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateResourcePrincipalConfiguration.go.html to see an example of how to use CreateResourcePrincipalConfiguration API.
func (client BdsClient) DeactivateIamUserSyncConfiguration(ctx context.Context, request DeactivateIamUserSyncConfigurationRequest) (response DeactivateIamUserSyncConfigurationResponse, err error)
DeactivateIamUserSyncConfiguration Deactivate the IAM user sync configuration.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeactivateIamUserSyncConfiguration.go.html to see an example of how to use DeactivateIamUserSyncConfiguration API.
func (client BdsClient) DeactivateUpstConfiguration(ctx context.Context, request DeactivateUpstConfigurationRequest) (response DeactivateUpstConfigurationResponse, err error)
DeactivateUpstConfiguration Deactivate the UPST configuration represented by the provided ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeactivateUpstConfiguration.go.html to see an example of how to use DeactivateUpstConfiguration API.
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.
Click https://docs.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 (client BdsClient) DeleteBdsInstance(ctx context.Context, request DeleteBdsInstanceRequest) (response DeleteBdsInstanceResponse, err error)
DeleteBdsInstance Deletes the cluster identified by the given ID.
Click https://docs.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 (client BdsClient) DeleteBdsMetastoreConfiguration(ctx context.Context, request DeleteBdsMetastoreConfigurationRequest) (response DeleteBdsMetastoreConfigurationResponse, err error)
DeleteBdsMetastoreConfiguration Delete the BDS metastore configuration represented by the provided ID.
Click https://docs.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 (client BdsClient) DeleteIdentityConfiguration(ctx context.Context, request DeleteIdentityConfigurationRequest) (response DeleteIdentityConfigurationResponse, err error)
DeleteIdentityConfiguration Delete the identity configuration represented by the provided ID. Deletion is only allowed if this identity configuration is not associated with any active IAM user sync configuration or UPST configuration.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeleteIdentityConfiguration.go.html to see an example of how to use DeleteIdentityConfiguration API.
func (client BdsClient) DeleteNodeBackup(ctx context.Context, request DeleteNodeBackupRequest) (response DeleteNodeBackupResponse, err error)
DeleteNodeBackup Delete the NodeBackup represented by the provided ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeleteNodeBackup.go.html to see an example of how to use DeleteNodeBackup API.
func (client BdsClient) DeleteNodeBackupConfiguration(ctx context.Context, request DeleteNodeBackupConfigurationRequest) (response DeleteNodeBackupConfigurationResponse, err error)
DeleteNodeBackupConfiguration Delete the NodeBackupConfiguration represented by the provided ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeleteNodeBackupConfiguration.go.html to see an example of how to use DeleteNodeBackupConfiguration API.
func (client BdsClient) DisableCertificate(ctx context.Context, request DisableCertificateRequest) (response DisableCertificateResponse, err error)
DisableCertificate Disabling TLS/SSL for various ODH services running on the BDS cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DisableCertificate.go.html to see an example of how to use DisableCertificate API.
func (client BdsClient) EnableCertificate(ctx context.Context, request EnableCertificateRequest) (response EnableCertificateResponse, err error)
EnableCertificate Configuring TLS/SSL for various ODH services running on the BDS cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/EnableCertificate.go.html to see an example of how to use EnableCertificate API.
func (client BdsClient) ExecuteBootstrapScript(ctx context.Context, request ExecuteBootstrapScriptRequest) (response ExecuteBootstrapScriptResponse, err error)
ExecuteBootstrapScript Execute bootstrap script.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ExecuteBootstrapScript.go.html to see an example of how to use ExecuteBootstrapScript API.
func (client BdsClient) ForceRefreshResourcePrincipal(ctx context.Context, request ForceRefreshResourcePrincipalRequest) (response ForceRefreshResourcePrincipalResponse, err error)
ForceRefreshResourcePrincipal Force Refresh Resource Principal for the cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ForceRefreshResourcePrincipal.go.html to see an example of how to use ForceRefreshResourcePrincipal API.
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.
Click https://docs.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 (client BdsClient) GetBdsApiKey(ctx context.Context, request GetBdsApiKeyRequest) (response GetBdsApiKeyResponse, err error)
GetBdsApiKey Returns the user's API key information for the given ID.
Click https://docs.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 (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.
Click https://docs.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 (client BdsClient) GetBdsMetastoreConfiguration(ctx context.Context, request GetBdsMetastoreConfigurationRequest) (response GetBdsMetastoreConfigurationResponse, err error)
GetBdsMetastoreConfiguration Returns the BDS Metastore configuration information for the given ID.
Click https://docs.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 (client BdsClient) GetIdentityConfiguration(ctx context.Context, request GetIdentityConfigurationRequest) (response GetIdentityConfigurationResponse, err error)
GetIdentityConfiguration Get details of one identity config on the cluster
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetIdentityConfiguration.go.html to see an example of how to use GetIdentityConfiguration API.
func (client BdsClient) GetNodeBackup(ctx context.Context, request GetNodeBackupRequest) (response GetNodeBackupResponse, err error)
GetNodeBackup Returns details of NodeBackup identified by the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetNodeBackup.go.html to see an example of how to use GetNodeBackup API.
func (client BdsClient) GetNodeBackupConfiguration(ctx context.Context, request GetNodeBackupConfigurationRequest) (response GetNodeBackupConfigurationResponse, err error)
GetNodeBackupConfiguration Returns details of the NodeBackupConfiguration identified by the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetNodeBackupConfiguration.go.html to see an example of how to use GetNodeBackupConfiguration API.
func (client BdsClient) GetNodeReplaceConfiguration(ctx context.Context, request GetNodeReplaceConfigurationRequest) (response GetNodeReplaceConfigurationResponse, err error)
GetNodeReplaceConfiguration Returns details of the nodeReplaceConfiguration identified by the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetNodeReplaceConfiguration.go.html to see an example of how to use GetNodeReplaceConfiguration API.
func (client BdsClient) GetOsPatchDetails(ctx context.Context, request GetOsPatchDetailsRequest) (response GetOsPatchDetailsResponse, err error)
GetOsPatchDetails Get the details of an os patch
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetOsPatchDetails.go.html to see an example of how to use GetOsPatchDetails API.
func (client BdsClient) GetResourcePrincipalConfiguration(ctx context.Context, request GetResourcePrincipalConfigurationRequest) (response GetResourcePrincipalConfigurationResponse, err error)
GetResourcePrincipalConfiguration Returns details of the resourcePrincipalConfiguration identified by the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetResourcePrincipalConfiguration.go.html to see an example of how to use GetResourcePrincipalConfiguration API.
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.
Click https://docs.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 (client BdsClient) InstallOsPatch(ctx context.Context, request InstallOsPatchRequest) (response InstallOsPatchResponse, err error)
InstallOsPatch Install an os patch on a cluster
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/InstallOsPatch.go.html to see an example of how to use InstallOsPatch API.
func (client BdsClient) InstallPatch(ctx context.Context, request InstallPatchRequest) (response InstallPatchResponse, err error)
InstallPatch Install the specified patch to this cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/InstallPatch.go.html to see an example of how to use InstallPatch API.
func (client BdsClient) ListAutoScalingConfigurations(ctx context.Context, request ListAutoScalingConfigurationsRequest) (response ListAutoScalingConfigurationsResponse, err error)
ListAutoScalingConfigurations Returns information about the autoscaling configurations for a cluster.
Click https://docs.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 (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.
Click https://docs.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 (client BdsClient) ListBdsClusterVersions(ctx context.Context, request ListBdsClusterVersionsRequest) (response ListBdsClusterVersionsResponse, err error)
ListBdsClusterVersions Returns a list of cluster versions with associated odh and bds versions.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListBdsClusterVersions.go.html to see an example of how to use ListBdsClusterVersions API.
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.
Click https://docs.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 (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.
Click https://docs.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 (client BdsClient) ListIdentityConfigurations(ctx context.Context, request ListIdentityConfigurationsRequest) (response ListIdentityConfigurationsResponse, err error)
ListIdentityConfigurations Returns a list of all identity configurations associated with this Big Data Service cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListIdentityConfigurations.go.html to see an example of how to use ListIdentityConfigurations API.
func (client BdsClient) ListNodeBackupConfigurations(ctx context.Context, request ListNodeBackupConfigurationsRequest) (response ListNodeBackupConfigurationsResponse, err error)
ListNodeBackupConfigurations Returns information about the NodeBackupConfigurations.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListNodeBackupConfigurations.go.html to see an example of how to use ListNodeBackupConfigurations API.
func (client BdsClient) ListNodeBackups(ctx context.Context, request ListNodeBackupsRequest) (response ListNodeBackupsResponse, err error)
ListNodeBackups Returns information about the node Backups.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListNodeBackups.go.html to see an example of how to use ListNodeBackups API.
func (client BdsClient) ListNodeReplaceConfigurations(ctx context.Context, request ListNodeReplaceConfigurationsRequest) (response ListNodeReplaceConfigurationsResponse, err error)
ListNodeReplaceConfigurations Returns information about the NodeReplaceConfiguration.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListNodeReplaceConfigurations.go.html to see an example of how to use ListNodeReplaceConfigurations API.
func (client BdsClient) ListOsPatches(ctx context.Context, request ListOsPatchesRequest) (response ListOsPatchesResponse, err error)
ListOsPatches List all available os patches for a given cluster
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListOsPatches.go.html to see an example of how to use ListOsPatches API.
func (client BdsClient) ListPatchHistories(ctx context.Context, request ListPatchHistoriesRequest) (response ListPatchHistoriesResponse, err error)
ListPatchHistories List the patch history of this cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListPatchHistories.go.html to see an example of how to use ListPatchHistories API.
func (client BdsClient) ListPatches(ctx context.Context, request ListPatchesRequest) (response ListPatchesResponse, err error)
ListPatches List all the available patches for this cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListPatches.go.html to see an example of how to use ListPatches API.
func (client BdsClient) ListResourcePrincipalConfigurations(ctx context.Context, request ListResourcePrincipalConfigurationsRequest) (response ListResourcePrincipalConfigurationsResponse, err error)
ListResourcePrincipalConfigurations Returns information about the ResourcePrincipalConfiguration.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListResourcePrincipalConfigurations.go.html to see an example of how to use ListResourcePrincipalConfigurations API.
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.
Click https://docs.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 (client BdsClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a paginated list of logs for a given work request.
Click https://docs.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 (client BdsClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.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 (client BdsClient) RefreshConfidentialApplication(ctx context.Context, request RefreshConfidentialApplicationRequest) (response RefreshConfidentialApplicationResponse, err error)
RefreshConfidentialApplication Refresh confidential application for the given identity configuration in case of any update to the confidential application (e.g. regenerated client secret)
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RefreshConfidentialApplication.go.html to see an example of how to use RefreshConfidentialApplication API.
func (client BdsClient) RefreshUpstTokenExchangeKeytab(ctx context.Context, request RefreshUpstTokenExchangeKeytabRequest) (response RefreshUpstTokenExchangeKeytabResponse, err error)
RefreshUpstTokenExchangeKeytab Refresh token exchange kerberos principal keytab for the UPST enabled identity configuration
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RefreshUpstTokenExchangeKeytab.go.html to see an example of how to use RefreshUpstTokenExchangeKeytab API.
func (client BdsClient) RemoveAutoScalingConfiguration(ctx context.Context, request RemoveAutoScalingConfigurationRequest) (response RemoveAutoScalingConfigurationResponse, err error)
RemoveAutoScalingConfiguration Deletes an autoscale configuration.
Click https://docs.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 (client BdsClient) RemoveCloudSql(ctx context.Context, request RemoveCloudSqlRequest) (response RemoveCloudSqlResponse, err error)
RemoveCloudSql Removes Cloud SQL from the cluster.
Click https://docs.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 (client BdsClient) RemoveKafka(ctx context.Context, request RemoveKafkaRequest) (response RemoveKafkaResponse, err error)
RemoveKafka Remove Kafka from the cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RemoveKafka.go.html to see an example of how to use RemoveKafka API.
func (client BdsClient) RemoveNode(ctx context.Context, request RemoveNodeRequest) (response RemoveNodeResponse, err error)
RemoveNode Remove a single node of a Big Data Service cluster
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RemoveNode.go.html to see an example of how to use RemoveNode API.
func (client BdsClient) RemoveNodeReplaceConfiguration(ctx context.Context, request RemoveNodeReplaceConfigurationRequest) (response RemoveNodeReplaceConfigurationResponse, err error)
RemoveNodeReplaceConfiguration Deletes a nodeReplaceConfiguration
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RemoveNodeReplaceConfiguration.go.html to see an example of how to use RemoveNodeReplaceConfiguration API.
func (client BdsClient) RemoveResourcePrincipalConfiguration(ctx context.Context, request RemoveResourcePrincipalConfigurationRequest) (response RemoveResourcePrincipalConfigurationResponse, err error)
RemoveResourcePrincipalConfiguration Delete the resource principal configuration for the cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RemoveResourcePrincipalConfiguration.go.html to see an example of how to use RemoveResourcePrincipalConfiguration API.
func (client BdsClient) RenewCertificate(ctx context.Context, request RenewCertificateRequest) (response RenewCertificateResponse, err error)
RenewCertificate Renewing TLS/SSL for various ODH services running on the BDS cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RenewCertificate.go.html to see an example of how to use RenewCertificate API.
func (client BdsClient) ReplaceNode(ctx context.Context, request ReplaceNodeRequest) (response ReplaceNodeResponse, err error)
ReplaceNode Replaces a node of a Big Data Service cluster from backup.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ReplaceNode.go.html to see an example of how to use ReplaceNode API.
func (client BdsClient) RestartNode(ctx context.Context, request RestartNodeRequest) (response RestartNodeResponse, err error)
RestartNode Restarts a single node of a Big Data Service cluster
Click https://docs.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 (client *BdsClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client BdsClient) StartBdsInstance(ctx context.Context, request StartBdsInstanceRequest) (response StartBdsInstanceResponse, err error)
StartBdsInstance Starts the BDS cluster that was stopped earlier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/StartBdsInstance.go.html to see an example of how to use StartBdsInstance API.
func (client BdsClient) StopBdsInstance(ctx context.Context, request StopBdsInstanceRequest) (response StopBdsInstanceResponse, err error)
StopBdsInstance Stops the BDS cluster that can be started at later point of time.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/StopBdsInstance.go.html to see an example of how to use StopBdsInstance API.
func (client BdsClient) TestBdsMetastoreConfiguration(ctx context.Context, request TestBdsMetastoreConfigurationRequest) (response TestBdsMetastoreConfigurationResponse, err error)
TestBdsMetastoreConfiguration Test specified metastore configuration.
Click https://docs.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 (client BdsClient) TestBdsObjectStorageConnection(ctx context.Context, request TestBdsObjectStorageConnectionRequest) (response TestBdsObjectStorageConnectionResponse, err error)
TestBdsObjectStorageConnection Test access to specified Object Storage bucket using the API key.
Click https://docs.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 (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.
Click https://docs.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 (client BdsClient) UpdateBdsInstance(ctx context.Context, request UpdateBdsInstanceRequest) (response UpdateBdsInstanceResponse, err error)
UpdateBdsInstance Updates the Big Data Service cluster identified by the given ID.
Click https://docs.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 (client BdsClient) UpdateBdsMetastoreConfiguration(ctx context.Context, request UpdateBdsMetastoreConfigurationRequest) (response UpdateBdsMetastoreConfigurationResponse, err error)
UpdateBdsMetastoreConfiguration Update the BDS metastore configuration represented by the provided ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateBdsMetastoreConfiguration.go.html to see an example of how to use UpdateBdsMetastoreConfiguration API.
func (client BdsClient) UpdateIdentityConfiguration(ctx context.Context, request UpdateIdentityConfigurationRequest) (response UpdateIdentityConfigurationResponse, err error)
UpdateIdentityConfiguration Update the IAM user sync and UPST configuration for the specified identity configuration
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateIdentityConfiguration.go.html to see an example of how to use UpdateIdentityConfiguration API.
func (client BdsClient) UpdateNodeBackupConfiguration(ctx context.Context, request UpdateNodeBackupConfigurationRequest) (response UpdateNodeBackupConfigurationResponse, err error)
UpdateNodeBackupConfiguration Updates fields on NodeBackupConfiguration, including the name, the schedule.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateNodeBackupConfiguration.go.html to see an example of how to use UpdateNodeBackupConfiguration API.
func (client BdsClient) UpdateNodeReplaceConfiguration(ctx context.Context, request UpdateNodeReplaceConfigurationRequest) (response UpdateNodeReplaceConfigurationResponse, err error)
UpdateNodeReplaceConfiguration Updates fields on nodeReplaceConfigurations, including the name, the schedule
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateNodeReplaceConfiguration.go.html to see an example of how to use UpdateNodeReplaceConfiguration API.
func (client BdsClient) UpdateResourcePrincipalConfiguration(ctx context.Context, request UpdateResourcePrincipalConfigurationRequest) (response UpdateResourcePrincipalConfigurationResponse, err error)
UpdateResourcePrincipalConfiguration Updates fields on resourcePrincipalConfiguration, including the name, the lifeSpanInHours of the token.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateResourcePrincipalConfiguration.go.html to see an example of how to use UpdateResourcePrincipalConfiguration API.
BdsClusterVersionSummary Cluster version details including bds and odh version information.
type BdsClusterVersionSummary struct {
// BDS version to be used for cluster creation
BdsVersion *string `mandatory:"true" json:"bdsVersion"`
// ODH version to be used for cluster creation
OdhVersion *string `mandatory:"false" json:"odhVersion"`
}
func (m BdsClusterVersionSummary) String() string
func (m BdsClusterVersionSummary) 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
BdsInstance Description of the cluster.
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"`
// Boolean flag specifying whether or not Kafka should be configured.
IsKafkaConfigured *bool `mandatory:"true" json:"isKafkaConfigured"`
// 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"`
// Number of nodes that require a maintenance reboot
NumberOfNodesRequiringMaintenanceReboot *int `mandatory:"false" json:"numberOfNodesRequiringMaintenanceReboot"`
// pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed.
BootstrapScriptUrl *string `mandatory:"false" json:"bootstrapScriptUrl"`
// 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"`
// The OCID of the Key Management master encryption key.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// Profile of the Big Data Service cluster.
ClusterProfile BdsInstanceClusterProfileEnum `mandatory:"false" json:"clusterProfile,omitempty"`
BdsClusterVersionSummary *BdsClusterVersionSummary `mandatory:"false" json:"bdsClusterVersionSummary"`
}
func (m BdsInstance) String() string
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
BdsInstanceClusterProfileEnum Enum with underlying type: string
type BdsInstanceClusterProfileEnum string
Set of constants representing the allowable values for BdsInstanceClusterProfileEnum
const (
BdsInstanceClusterProfileHadoopExtended BdsInstanceClusterProfileEnum = "HADOOP_EXTENDED"
BdsInstanceClusterProfileHadoop BdsInstanceClusterProfileEnum = "HADOOP"
BdsInstanceClusterProfileHive BdsInstanceClusterProfileEnum = "HIVE"
BdsInstanceClusterProfileSpark BdsInstanceClusterProfileEnum = "SPARK"
BdsInstanceClusterProfileHbase BdsInstanceClusterProfileEnum = "HBASE"
BdsInstanceClusterProfileTrino BdsInstanceClusterProfileEnum = "TRINO"
BdsInstanceClusterProfileKafka BdsInstanceClusterProfileEnum = "KAFKA"
)
func GetBdsInstanceClusterProfileEnumValues() []BdsInstanceClusterProfileEnum
GetBdsInstanceClusterProfileEnumValues Enumerates the set of values for BdsInstanceClusterProfileEnum
func GetMappingBdsInstanceClusterProfileEnum(val string) (BdsInstanceClusterProfileEnum, bool)
GetMappingBdsInstanceClusterProfileEnum performs case Insensitive comparison on enum value and return the desired enum
BdsInstanceClusterVersionEnum Enum with underlying type: string
type BdsInstanceClusterVersionEnum string
Set of constants representing the allowable values for BdsInstanceClusterVersionEnum
const (
BdsInstanceClusterVersionCdh5 BdsInstanceClusterVersionEnum = "CDH5"
BdsInstanceClusterVersionCdh6 BdsInstanceClusterVersionEnum = "CDH6"
BdsInstanceClusterVersionOdh1 BdsInstanceClusterVersionEnum = "ODH1"
BdsInstanceClusterVersionOdh09 BdsInstanceClusterVersionEnum = "ODH0_9"
BdsInstanceClusterVersionOdh20 BdsInstanceClusterVersionEnum = "ODH2_0"
)
func GetBdsInstanceClusterVersionEnumValues() []BdsInstanceClusterVersionEnum
GetBdsInstanceClusterVersionEnumValues Enumerates the set of values for BdsInstanceClusterVersionEnum
func GetMappingBdsInstanceClusterVersionEnum(val string) (BdsInstanceClusterVersionEnum, bool)
GetMappingBdsInstanceClusterVersionEnum performs case Insensitive comparison on enum value and return the desired enum
BdsInstanceLifecycleStateEnum Enum with underlying type: string
type BdsInstanceLifecycleStateEnum string
Set of constants representing the allowable values for BdsInstanceLifecycleStateEnum
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"
BdsInstanceLifecycleStateInactive BdsInstanceLifecycleStateEnum = "INACTIVE"
)
func GetBdsInstanceLifecycleStateEnumValues() []BdsInstanceLifecycleStateEnum
GetBdsInstanceLifecycleStateEnumValues Enumerates the set of values for BdsInstanceLifecycleStateEnum
func GetMappingBdsInstanceLifecycleStateEnum(val string) (BdsInstanceLifecycleStateEnum, bool)
GetMappingBdsInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BdsInstanceSummary Summary details of the Big Data Service cluster.
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"`
// Boolean flag specifying whether Kafka is configured or not.
IsKafkaConfigured *bool `mandatory:"true" json:"isKafkaConfigured"`
// The time the cluster was created, shown as an RFC 3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Number of nodes that require a maintenance reboot
NumberOfNodesRequiringMaintenanceReboot *int `mandatory:"false" json:"numberOfNodesRequiringMaintenanceReboot"`
// Version of the Hadoop distribution.
ClusterVersion BdsInstanceClusterVersionEnum `mandatory:"false" json:"clusterVersion,omitempty"`
// Profile of the Big Data Service cluster.
ClusterProfile BdsInstanceClusterProfileEnum `mandatory:"false" json:"clusterProfile,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"`
}
func (m BdsInstanceSummary) String() string
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
BdsMetastoreConfiguration The metastore configuration information.
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"`
}
func (m BdsMetastoreConfiguration) String() string
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
BdsMetastoreConfigurationLifecycleStateEnum Enum with underlying type: string
type BdsMetastoreConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for BdsMetastoreConfigurationLifecycleStateEnum
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"
)
func GetBdsMetastoreConfigurationLifecycleStateEnumValues() []BdsMetastoreConfigurationLifecycleStateEnum
GetBdsMetastoreConfigurationLifecycleStateEnumValues Enumerates the set of values for BdsMetastoreConfigurationLifecycleStateEnum
func GetMappingBdsMetastoreConfigurationLifecycleStateEnum(val string) (BdsMetastoreConfigurationLifecycleStateEnum, bool)
GetMappingBdsMetastoreConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BdsMetastoreConfigurationMetastoreTypeEnum Enum with underlying type: string
type BdsMetastoreConfigurationMetastoreTypeEnum string
Set of constants representing the allowable values for BdsMetastoreConfigurationMetastoreTypeEnum
const (
BdsMetastoreConfigurationMetastoreTypeLocal BdsMetastoreConfigurationMetastoreTypeEnum = "LOCAL"
BdsMetastoreConfigurationMetastoreTypeExternal BdsMetastoreConfigurationMetastoreTypeEnum = "EXTERNAL"
)
func GetBdsMetastoreConfigurationMetastoreTypeEnumValues() []BdsMetastoreConfigurationMetastoreTypeEnum
GetBdsMetastoreConfigurationMetastoreTypeEnumValues Enumerates the set of values for BdsMetastoreConfigurationMetastoreTypeEnum
func GetMappingBdsMetastoreConfigurationMetastoreTypeEnum(val string) (BdsMetastoreConfigurationMetastoreTypeEnum, bool)
GetMappingBdsMetastoreConfigurationMetastoreTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BdsMetastoreConfigurationSummary The summary of metastore configuration information.
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"`
}
func (m BdsMetastoreConfigurationSummary) String() string
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
CertificateServiceInfoDetails Details for certificate service info
type CertificateServiceInfoDetails struct {
// List of services for which TLS/SSL needs to be enabled.
Services []ServiceEnum `mandatory:"true" json:"services"`
}
func (m CertificateServiceInfoDetails) String() string
func (m CertificateServiceInfoDetails) 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
CertificateServiceInfoRequest wrapper for the CertificateServiceInfo operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CertificateServiceInfo.go.html to see an example of how to use CertificateServiceInfoRequest.
type CertificateServiceInfoRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for certificate service info
CertificateServiceInfoDetails `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
}
func (request CertificateServiceInfoRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CertificateServiceInfoRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CertificateServiceInfoRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CertificateServiceInfoRequest) String() string
func (request CertificateServiceInfoRequest) 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
CertificateServiceInfoResponse wrapper for the CertificateServiceInfo operation
type CertificateServiceInfoResponse struct {
// The underlying http response
RawResponse *http.Response
// The []CertificateServiceInfoSummary instance
Items []CertificateServiceInfoSummary `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"`
}
func (response CertificateServiceInfoResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CertificateServiceInfoResponse) String() string
CertificateServiceInfoSummary List of TLS/SSL information of services
type CertificateServiceInfoSummary struct {
// Name of the service
Service CertificateServiceInfoSummaryServiceEnum `mandatory:"true" json:"service"`
// Whether certificate is enabled or disabled
ServiceCertificateStatus CertificateServiceInfoSummaryServiceCertificateStatusEnum `mandatory:"true" json:"serviceCertificateStatus"`
// List of Host specific certificate details
HostSpecificCertificateDetails []HostSpecificCertificateDetails `mandatory:"true" json:"hostSpecificCertificateDetails"`
}
func (m CertificateServiceInfoSummary) String() string
func (m CertificateServiceInfoSummary) 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
CertificateServiceInfoSummaryServiceCertificateStatusEnum Enum with underlying type: string
type CertificateServiceInfoSummaryServiceCertificateStatusEnum string
Set of constants representing the allowable values for CertificateServiceInfoSummaryServiceCertificateStatusEnum
const (
CertificateServiceInfoSummaryServiceCertificateStatusEnabled CertificateServiceInfoSummaryServiceCertificateStatusEnum = "ENABLED"
CertificateServiceInfoSummaryServiceCertificateStatusDisabled CertificateServiceInfoSummaryServiceCertificateStatusEnum = "DISABLED"
)
func GetCertificateServiceInfoSummaryServiceCertificateStatusEnumValues() []CertificateServiceInfoSummaryServiceCertificateStatusEnum
GetCertificateServiceInfoSummaryServiceCertificateStatusEnumValues Enumerates the set of values for CertificateServiceInfoSummaryServiceCertificateStatusEnum
func GetMappingCertificateServiceInfoSummaryServiceCertificateStatusEnum(val string) (CertificateServiceInfoSummaryServiceCertificateStatusEnum, bool)
GetMappingCertificateServiceInfoSummaryServiceCertificateStatusEnum performs case Insensitive comparison on enum value and return the desired enum
CertificateServiceInfoSummaryServiceEnum Enum with underlying type: string
type CertificateServiceInfoSummaryServiceEnum string
Set of constants representing the allowable values for CertificateServiceInfoSummaryServiceEnum
const (
CertificateServiceInfoSummaryServiceZookeeper CertificateServiceInfoSummaryServiceEnum = "ZOOKEEPER"
CertificateServiceInfoSummaryServiceAms CertificateServiceInfoSummaryServiceEnum = "AMS"
CertificateServiceInfoSummaryServiceHdfs CertificateServiceInfoSummaryServiceEnum = "HDFS"
CertificateServiceInfoSummaryServiceYarn CertificateServiceInfoSummaryServiceEnum = "YARN"
CertificateServiceInfoSummaryServiceMapreduce CertificateServiceInfoSummaryServiceEnum = "MAPREDUCE"
CertificateServiceInfoSummaryServiceOozie CertificateServiceInfoSummaryServiceEnum = "OOZIE"
CertificateServiceInfoSummaryServiceHbase CertificateServiceInfoSummaryServiceEnum = "HBASE"
CertificateServiceInfoSummaryServiceSpark CertificateServiceInfoSummaryServiceEnum = "SPARK"
CertificateServiceInfoSummaryServiceHive CertificateServiceInfoSummaryServiceEnum = "HIVE"
CertificateServiceInfoSummaryServiceKafka CertificateServiceInfoSummaryServiceEnum = "KAFKA"
CertificateServiceInfoSummaryServiceFlink CertificateServiceInfoSummaryServiceEnum = "FLINK"
CertificateServiceInfoSummaryServiceRegistry CertificateServiceInfoSummaryServiceEnum = "REGISTRY"
)
func GetCertificateServiceInfoSummaryServiceEnumValues() []CertificateServiceInfoSummaryServiceEnum
GetCertificateServiceInfoSummaryServiceEnumValues Enumerates the set of values for CertificateServiceInfoSummaryServiceEnum
func GetMappingCertificateServiceInfoSummaryServiceEnum(val string) (CertificateServiceInfoSummaryServiceEnum, bool)
GetMappingCertificateServiceInfoSummaryServiceEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeBdsInstanceCompartmentDetails Move a Cluster to a Different Compartment
type ChangeBdsInstanceCompartmentDetails struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeBdsInstanceCompartmentDetails) String() string
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
ChangeBdsInstanceCompartmentRequest wrapper for the ChangeBdsInstanceCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ChangeBdsInstanceCompartment.go.html to see an example of how to use 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
}
func (request ChangeBdsInstanceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeBdsInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeBdsInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeBdsInstanceCompartmentRequest) String() string
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
ChangeBdsInstanceCompartmentResponse wrapper for the ChangeBdsInstanceCompartment operation
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"`
}
func (response ChangeBdsInstanceCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeBdsInstanceCompartmentResponse) String() string
ChangeShapeDetails Resize details specified for individual nodes.
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"`
}
func (m ChangeShapeDetails) String() string
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
ChangeShapeNodes Individual worker nodes groups details.
type ChangeShapeNodes struct {
// Change shape of worker nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
Worker *string `mandatory:"false" json:"worker"`
WorkerShapeConfig *ShapeConfigDetails `mandatory:"false" json:"workerShapeConfig"`
// Change shape of compute only worker nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
ComputeOnlyWorker *string `mandatory:"false" json:"computeOnlyWorker"`
ComputeOnlyWorkerShapeConfig *ShapeConfigDetails `mandatory:"false" json:"computeOnlyWorkerShapeConfig"`
// Change shape of master nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
Master *string `mandatory:"false" json:"master"`
MasterShapeConfig *ShapeConfigDetails `mandatory:"false" json:"masterShapeConfig"`
// Change shape of utility nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
Utility *string `mandatory:"false" json:"utility"`
UtilityShapeConfig *ShapeConfigDetails `mandatory:"false" json:"utilityShapeConfig"`
// Change shape of the Cloud SQL node to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
Cloudsql *string `mandatory:"false" json:"cloudsql"`
CloudsqlShapeConfig *ShapeConfigDetails `mandatory:"false" json:"cloudsqlShapeConfig"`
// Change shape of edge nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
Edge *string `mandatory:"false" json:"edge"`
EdgeShapeConfig *ShapeConfigDetails `mandatory:"false" json:"edgeShapeConfig"`
// Change shape of Kafka Broker nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
KafkaBroker *string `mandatory:"false" json:"kafkaBroker"`
KafkaBrokerShapeConfig *ShapeConfigDetails `mandatory:"false" json:"kafkaBrokerShapeConfig"`
}
func (m ChangeShapeNodes) String() string
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
ChangeShapeRequest wrapper for the ChangeShape operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ChangeShape.go.html to see an example of how to use 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
}
func (request ChangeShapeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeShapeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeShapeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeShapeRequest) String() string
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
ChangeShapeResponse wrapper for the ChangeShape operation
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"`
}
func (response ChangeShapeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeShapeResponse) String() string
CloudSqlDetails The information about added Cloud SQL capability
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"`
}
func (m CloudSqlDetails) String() string
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
ClusterDetails Specific info about a Hadoop cluster
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"`
// Version of the ODH (Oracle Distribution including Apache Hadoop) installed on the cluster.
OdhVersion *string `mandatory:"false" json:"odhVersion"`
// The URL of the Jupyterhub.
JupyterHubUrl *string `mandatory:"false" json:"jupyterHubUrl"`
}
func (m ClusterDetails) String() string
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
CreateBdsApiKeyDetails API key created on user's behalf.
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"`
// Identity domain OCID , where user is present. For default domain , this field will be optional.
DomainOcid *string `mandatory:"false" json:"domainOcid"`
}
func (m CreateBdsApiKeyDetails) String() string
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
CreateBdsApiKeyRequest wrapper for the CreateBdsApiKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateBdsApiKey.go.html to see an example of how to use 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
}
func (request CreateBdsApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBdsApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBdsApiKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBdsApiKeyRequest) String() string
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
CreateBdsApiKeyResponse wrapper for the CreateBdsApiKey operation
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"`
}
func (response CreateBdsApiKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBdsApiKeyResponse) String() string
CreateBdsInstanceDetails The information about the new cluster.
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"`
// Pre-authenticated URL of the script in Object Store that is downloaded and executed.
BootstrapScriptUrl *string `mandatory:"false" json:"bootstrapScriptUrl"`
// The user-defined kerberos realm name.
KerberosRealmName *string `mandatory:"false" json:"kerberosRealmName"`
// 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"`
// The OCID of the Key Management master encryption key.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// Profile of the Big Data Service cluster.
ClusterProfile BdsInstanceClusterProfileEnum `mandatory:"false" json:"clusterProfile,omitempty"`
BdsClusterVersionSummary *BdsClusterVersionSummary `mandatory:"false" json:"bdsClusterVersionSummary"`
}
func (m CreateBdsInstanceDetails) String() string
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
CreateBdsInstanceRequest wrapper for the CreateBdsInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateBdsInstance.go.html to see an example of how to use 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
}
func (request CreateBdsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBdsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBdsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBdsInstanceRequest) String() string
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
CreateBdsInstanceResponse wrapper for the CreateBdsInstance operation
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"`
}
func (response CreateBdsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBdsInstanceResponse) String() string
CreateBdsMetastoreConfigurationDetails The request body when creating BDS metastore configuration.
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"`
}
func (m CreateBdsMetastoreConfigurationDetails) String() string
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
CreateBdsMetastoreConfigurationRequest wrapper for the CreateBdsMetastoreConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateBdsMetastoreConfiguration.go.html to see an example of how to use 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
}
func (request CreateBdsMetastoreConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBdsMetastoreConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBdsMetastoreConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBdsMetastoreConfigurationRequest) String() string
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
CreateBdsMetastoreConfigurationResponse wrapper for the CreateBdsMetastoreConfiguration operation
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"`
}
func (response CreateBdsMetastoreConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBdsMetastoreConfigurationResponse) String() string
CreateIdentityConfigurationDetails Details for creating the identity configuration.
type CreateIdentityConfigurationDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// Display name of the identity configuration, required for creating identity configuration.
DisplayName *string `mandatory:"true" json:"displayName"`
// Identity domain OCID to use for identity config, required for creating identity configuration
IdentityDomainId *string `mandatory:"true" json:"identityDomainId"`
// Identity domain confidential application ID for the identity config, required for creating identity configuration
ConfidentialApplicationId *string `mandatory:"true" json:"confidentialApplicationId"`
UpstConfigurationDetails *UpstConfigurationDetails `mandatory:"false" json:"upstConfigurationDetails"`
IamUserSyncConfigurationDetails *IamUserSyncConfigurationDetails `mandatory:"false" json:"iamUserSyncConfigurationDetails"`
}
func (m CreateIdentityConfigurationDetails) String() string
func (m CreateIdentityConfigurationDetails) 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
CreateIdentityConfigurationRequest wrapper for the CreateIdentityConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateIdentityConfiguration.go.html to see an example of how to use CreateIdentityConfigurationRequest.
type CreateIdentityConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for creating an identity configuration
CreateIdentityConfigurationDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error, without risk of executing that same action again. Retry tokens expire after 24
// hours but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateIdentityConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateIdentityConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateIdentityConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateIdentityConfigurationRequest) String() string
func (request CreateIdentityConfigurationRequest) 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
CreateIdentityConfigurationResponse wrapper for the CreateIdentityConfiguration operation
type CreateIdentityConfigurationResponse 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"`
}
func (response CreateIdentityConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateIdentityConfigurationResponse) String() string
CreateNodeBackupConfigurationDetails The information about the NodeBackupConfiguration.
type CreateNodeBackupConfigurationDetails struct {
LevelTypeDetails LevelTypeDetails `mandatory:"true" json:"levelTypeDetails"`
// Day/time recurrence (specified following RFC 5545) at which to trigger the backup process. Currently only DAILY, WEEKLY and MONTHLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR. Other fields are not supported.
Schedule *string `mandatory:"true" json:"schedule"`
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The time zone of the execution schedule, in IANA time zone database name format
Timezone *string `mandatory:"false" json:"timezone"`
// Number of backup copies to retain.
NumberOfBackupsToRetain *int `mandatory:"false" json:"numberOfBackupsToRetain"`
// Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created.
BackupType NodeBackupBackupTypeEnum `mandatory:"false" json:"backupType,omitempty"`
}
func (m CreateNodeBackupConfigurationDetails) String() string
func (m *CreateNodeBackupConfigurationDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateNodeBackupConfigurationDetails) 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
CreateNodeBackupConfigurationRequest wrapper for the CreateNodeBackupConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateNodeBackupConfiguration.go.html to see an example of how to use CreateNodeBackupConfigurationRequest.
type CreateNodeBackupConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for adding nodeBackupConfiguration to the BDS cluster.
CreateNodeBackupConfigurationDetails `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
}
func (request CreateNodeBackupConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateNodeBackupConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateNodeBackupConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateNodeBackupConfigurationRequest) String() string
func (request CreateNodeBackupConfigurationRequest) 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
CreateNodeBackupConfigurationResponse wrapper for the CreateNodeBackupConfiguration operation
type CreateNodeBackupConfigurationResponse 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"`
}
func (response CreateNodeBackupConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateNodeBackupConfigurationResponse) String() string
CreateNodeDetails The information about the new node.
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"`
ShapeConfig *ShapeConfigDetails `mandatory:"false" json:"shapeConfig"`
}
func (m CreateNodeDetails) String() string
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
CreateNodeReplaceConfigurationDetails The information about the NodeReplaceConfiguration
type CreateNodeReplaceConfigurationDetails struct {
LevelTypeDetails LevelTypeDetails `mandatory:"true" json:"levelTypeDetails"`
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// Type of compute instance health metric to use for node replacement
MetricType NodeReplaceConfigurationMetricTypeEnum `mandatory:"true" json:"metricType"`
// This value is the minimum period of time to wait before triggering node replacement. The value is in minutes.
DurationInMinutes *int `mandatory:"true" json:"durationInMinutes"`
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m CreateNodeReplaceConfigurationDetails) String() string
func (m *CreateNodeReplaceConfigurationDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateNodeReplaceConfigurationDetails) 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
CreateNodeReplaceConfigurationRequest wrapper for the CreateNodeReplaceConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateNodeReplaceConfiguration.go.html to see an example of how to use CreateNodeReplaceConfigurationRequest.
type CreateNodeReplaceConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for adding nodeReplaceConfiguration to the BDS cluster.
CreateNodeReplaceConfigurationDetails `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
}
func (request CreateNodeReplaceConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateNodeReplaceConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateNodeReplaceConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateNodeReplaceConfigurationRequest) String() string
func (request CreateNodeReplaceConfigurationRequest) 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
CreateNodeReplaceConfigurationResponse wrapper for the CreateNodeReplaceConfiguration operation
type CreateNodeReplaceConfigurationResponse 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"`
}
func (response CreateNodeReplaceConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateNodeReplaceConfigurationResponse) String() string
CreateResourcePrincipalConfigurationDetails Details of creating a resource principal configuration for the cluster.
type CreateResourcePrincipalConfigurationDetails struct {
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Base-64 encoded Cluster Admin Password for cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// Life span in hours for the resource principal session token.
SessionTokenLifeSpanDurationInHours *int `mandatory:"false" json:"sessionTokenLifeSpanDurationInHours"`
}
func (m CreateResourcePrincipalConfigurationDetails) String() string
func (m CreateResourcePrincipalConfigurationDetails) 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
CreateResourcePrincipalConfigurationRequest wrapper for the CreateResourcePrincipalConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/CreateResourcePrincipalConfiguration.go.html to see an example of how to use CreateResourcePrincipalConfigurationRequest.
type CreateResourcePrincipalConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details of creating resource principal session token for the bds cluster.
CreateResourcePrincipalConfigurationDetails `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
}
func (request CreateResourcePrincipalConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateResourcePrincipalConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateResourcePrincipalConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateResourcePrincipalConfigurationRequest) String() string
func (request CreateResourcePrincipalConfigurationRequest) 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
CreateResourcePrincipalConfigurationResponse wrapper for the CreateResourcePrincipalConfiguration operation
type CreateResourcePrincipalConfigurationResponse 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"`
}
func (response CreateResourcePrincipalConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateResourcePrincipalConfigurationResponse) String() string
DayBasedHorizontalScalingScheduleDetails Details of day based horizontal scaling schedule.
type DayBasedHorizontalScalingScheduleDetails struct {
// Time of day and horizontal scaling configuration.
TimeAndHorizontalScalingConfig []TimeAndHorizontalScalingConfig `mandatory:"false" json:"timeAndHorizontalScalingConfig"`
}
func (m DayBasedHorizontalScalingScheduleDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DayBasedHorizontalScalingScheduleDetails) String() string
func (m DayBasedHorizontalScalingScheduleDetails) 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
DayBasedVerticalScalingScheduleDetails Details of day based vertical scaling schedule.
type DayBasedVerticalScalingScheduleDetails struct {
// Time of day and vertical scaling configuration
TimeAndVerticalScalingConfig []TimeAndVerticalScalingConfig `mandatory:"false" json:"timeAndVerticalScalingConfig"`
}
func (m DayBasedVerticalScalingScheduleDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DayBasedVerticalScalingScheduleDetails) String() string
func (m DayBasedVerticalScalingScheduleDetails) 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
DeactivateIamUserSyncConfigurationDetails Details for deactivating an IAM user sync configuration
type DeactivateIamUserSyncConfigurationDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m DeactivateIamUserSyncConfigurationDetails) String() string
func (m DeactivateIamUserSyncConfigurationDetails) 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
DeactivateIamUserSyncConfigurationRequest wrapper for the DeactivateIamUserSyncConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeactivateIamUserSyncConfiguration.go.html to see an example of how to use DeactivateIamUserSyncConfigurationRequest.
type DeactivateIamUserSyncConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The OCID of the identity configuration
IdentityConfigurationId *string `mandatory:"true" contributesTo:"path" name:"identityConfigurationId"`
// Details for deactivating the IAM user sync config
DeactivateIamUserSyncConfigurationDetails `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
}
func (request DeactivateIamUserSyncConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeactivateIamUserSyncConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeactivateIamUserSyncConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeactivateIamUserSyncConfigurationRequest) String() string
func (request DeactivateIamUserSyncConfigurationRequest) 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
DeactivateIamUserSyncConfigurationResponse wrapper for the DeactivateIamUserSyncConfiguration operation
type DeactivateIamUserSyncConfigurationResponse 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"`
}
func (response DeactivateIamUserSyncConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeactivateIamUserSyncConfigurationResponse) String() string
DeactivateUpstConfigurationDetails Details for deleting UPST config from cluster
type DeactivateUpstConfigurationDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m DeactivateUpstConfigurationDetails) String() string
func (m DeactivateUpstConfigurationDetails) 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
DeactivateUpstConfigurationRequest wrapper for the DeactivateUpstConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeactivateUpstConfiguration.go.html to see an example of how to use DeactivateUpstConfigurationRequest.
type DeactivateUpstConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The OCID of the identity configuration
IdentityConfigurationId *string `mandatory:"true" contributesTo:"path" name:"identityConfigurationId"`
// Details for deactivating the UPST config
DeactivateUpstConfigurationDetails `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
}
func (request DeactivateUpstConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeactivateUpstConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeactivateUpstConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeactivateUpstConfigurationRequest) String() string
func (request DeactivateUpstConfigurationRequest) 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
DeactivateUpstConfigurationResponse wrapper for the DeactivateUpstConfiguration operation
type DeactivateUpstConfigurationResponse 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"`
}
func (response DeactivateUpstConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeactivateUpstConfigurationResponse) String() string
DefaultError Error Information.
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"`
}
func (m DefaultError) String() string
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
DeleteBdsApiKeyRequest wrapper for the DeleteBdsApiKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeleteBdsApiKey.go.html to see an example of how to use 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
}
func (request DeleteBdsApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBdsApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBdsApiKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBdsApiKeyRequest) String() string
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
DeleteBdsApiKeyResponse wrapper for the DeleteBdsApiKey operation
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"`
}
func (response DeleteBdsApiKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBdsApiKeyResponse) String() string
DeleteBdsInstanceRequest wrapper for the DeleteBdsInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeleteBdsInstance.go.html to see an example of how to use 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
}
func (request DeleteBdsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBdsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBdsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBdsInstanceRequest) String() string
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
DeleteBdsInstanceResponse wrapper for the DeleteBdsInstance operation
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"`
}
func (response DeleteBdsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBdsInstanceResponse) String() string
DeleteBdsMetastoreConfigurationRequest wrapper for the DeleteBdsMetastoreConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeleteBdsMetastoreConfiguration.go.html to see an example of how to use 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
}
func (request DeleteBdsMetastoreConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBdsMetastoreConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBdsMetastoreConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBdsMetastoreConfigurationRequest) String() string
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
DeleteBdsMetastoreConfigurationResponse wrapper for the DeleteBdsMetastoreConfiguration operation
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"`
}
func (response DeleteBdsMetastoreConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBdsMetastoreConfigurationResponse) String() string
DeleteIdentityConfigurationRequest wrapper for the DeleteIdentityConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeleteIdentityConfiguration.go.html to see an example of how to use DeleteIdentityConfigurationRequest.
type DeleteIdentityConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The OCID of the identity configuration
IdentityConfigurationId *string `mandatory:"true" contributesTo:"path" name:"identityConfigurationId"`
// 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
}
func (request DeleteIdentityConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteIdentityConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteIdentityConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteIdentityConfigurationRequest) String() string
func (request DeleteIdentityConfigurationRequest) 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
DeleteIdentityConfigurationResponse wrapper for the DeleteIdentityConfiguration operation
type DeleteIdentityConfigurationResponse 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"`
}
func (response DeleteIdentityConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteIdentityConfigurationResponse) String() string
DeleteNodeBackupConfigurationRequest wrapper for the DeleteNodeBackupConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeleteNodeBackupConfiguration.go.html to see an example of how to use DeleteNodeBackupConfigurationRequest.
type DeleteNodeBackupConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique Oracle-assigned identifier of the NodeBackupConfiguration.
NodeBackupConfigurationId *string `mandatory:"true" contributesTo:"path" name:"nodeBackupConfigurationId"`
// 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
}
func (request DeleteNodeBackupConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteNodeBackupConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteNodeBackupConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteNodeBackupConfigurationRequest) String() string
func (request DeleteNodeBackupConfigurationRequest) 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
DeleteNodeBackupConfigurationResponse wrapper for the DeleteNodeBackupConfiguration operation
type DeleteNodeBackupConfigurationResponse 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"`
}
func (response DeleteNodeBackupConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteNodeBackupConfigurationResponse) String() string
DeleteNodeBackupRequest wrapper for the DeleteNodeBackup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DeleteNodeBackup.go.html to see an example of how to use DeleteNodeBackupRequest.
type DeleteNodeBackupRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique assigned identifier of the nodeBackupId.
NodeBackupId *string `mandatory:"true" contributesTo:"path" name:"nodeBackupId"`
// 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
}
func (request DeleteNodeBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteNodeBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteNodeBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteNodeBackupRequest) String() string
func (request DeleteNodeBackupRequest) 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
DeleteNodeBackupResponse wrapper for the DeleteNodeBackup operation
type DeleteNodeBackupResponse 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"`
}
func (response DeleteNodeBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteNodeBackupResponse) String() string
DisableCertificateDetails The request body info about disable certificate service list.
type DisableCertificateDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// List of services for which certificate needs to be disabled.
Services []ServiceEnum `mandatory:"true" json:"services"`
}
func (m DisableCertificateDetails) String() string
func (m DisableCertificateDetails) 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
DisableCertificateRequest wrapper for the DisableCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/DisableCertificate.go.html to see an example of how to use DisableCertificateRequest.
type DisableCertificateRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for disabling certificate.
DisableCertificateDetails `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
}
func (request DisableCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DisableCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DisableCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DisableCertificateRequest) String() string
func (request DisableCertificateRequest) 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
DisableCertificateResponse wrapper for the DisableCertificate operation
type DisableCertificateResponse 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"`
}
func (response DisableCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DisableCertificateResponse) String() string
DomainBasedOdhPatchingConfig This patching config will patch all nodes in one AD/FD at a time.
type DomainBasedOdhPatchingConfig struct {
// The wait time between AD/FD in seconds.
WaitTimeBetweenDomainInSeconds *int `mandatory:"true" json:"waitTimeBetweenDomainInSeconds"`
// Acceptable number of failed-to-be-patched nodes in each domain. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of non-utility and non-master nodes.
ToleranceThresholdPerDomain *int `mandatory:"false" json:"toleranceThresholdPerDomain"`
}
func (m DomainBasedOdhPatchingConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DomainBasedOdhPatchingConfig) String() string
func (m DomainBasedOdhPatchingConfig) 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
DomainBasedPatchingConfigs This patching config will patch all nodes in one AD/FD at a time.
type DomainBasedPatchingConfigs struct {
// The wait time between AD/FD in seconds.
WaitTimeBetweenDomainInSeconds *int `mandatory:"true" json:"waitTimeBetweenDomainInSeconds"`
// Acceptable number of failed-to-be-patched nodes in each domain. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of nodes.
ToleranceThresholdPerDomain *int `mandatory:"true" json:"toleranceThresholdPerDomain"`
}
func (m DomainBasedPatchingConfigs) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DomainBasedPatchingConfigs) String() string
func (m DomainBasedPatchingConfigs) 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
DowntimeBasedOdhPatchingConfig Patching configurations which allows downtime. This patching config will patch all the nodes in parallel.
type DowntimeBasedOdhPatchingConfig struct {
}
func (m DowntimeBasedOdhPatchingConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DowntimeBasedOdhPatchingConfig) String() string
func (m DowntimeBasedOdhPatchingConfig) 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
DowntimeBasedPatchingConfigs Patching configurations which allows downtime. This patching config will patch and reboot all the nodes in parallel.
type DowntimeBasedPatchingConfigs struct {
}
func (m DowntimeBasedPatchingConfigs) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DowntimeBasedPatchingConfigs) String() string
func (m DowntimeBasedPatchingConfigs) 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
EnableCertificateDetails The request body info about configure certificate service list.
type EnableCertificateDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// List of services for which certificate needs to be enabled.
Services []ServiceEnum `mandatory:"true" json:"services"`
// Plain text certificate/s in order, separated by new line character. If not provided in request a self-signed root certificate is generated inside the cluster. In case hostCertDetails is provided, root certificate is mandatory.
RootCertificate *string `mandatory:"false" json:"rootCertificate"`
// List of leaf certificates to use for services on each host. If custom host certificate is provided the root certificate becomes required.
HostCertDetails []HostCertDetails `mandatory:"false" json:"hostCertDetails"`
// Base-64 encoded password for CA certificate's private key. This value can be empty.
ServerKeyPassword *string `mandatory:"false" json:"serverKeyPassword"`
}
func (m EnableCertificateDetails) String() string
func (m EnableCertificateDetails) 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
EnableCertificateRequest wrapper for the EnableCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/EnableCertificate.go.html to see an example of how to use EnableCertificateRequest.
type EnableCertificateRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for configuring certificate.
EnableCertificateDetails `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
}
func (request EnableCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request EnableCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request EnableCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request EnableCertificateRequest) String() string
func (request EnableCertificateRequest) 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
EnableCertificateResponse wrapper for the EnableCertificate operation
type EnableCertificateResponse 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"`
}
func (response EnableCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response EnableCertificateResponse) String() string
ExecuteBootstrapScriptDetails The information about the bootstrap script to be executed.
type ExecuteBootstrapScriptDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed.
BootstrapScriptUrl *string `mandatory:"false" json:"bootstrapScriptUrl"`
}
func (m ExecuteBootstrapScriptDetails) String() string
func (m ExecuteBootstrapScriptDetails) 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
ExecuteBootstrapScriptRequest wrapper for the ExecuteBootstrapScript operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ExecuteBootstrapScript.go.html to see an example of how to use ExecuteBootstrapScriptRequest.
type ExecuteBootstrapScriptRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details of the bootstrap script to execute on this cluster.
ExecuteBootstrapScriptDetails `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
}
func (request ExecuteBootstrapScriptRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ExecuteBootstrapScriptRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExecuteBootstrapScriptRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExecuteBootstrapScriptRequest) String() string
func (request ExecuteBootstrapScriptRequest) 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
ExecuteBootstrapScriptResponse wrapper for the ExecuteBootstrapScript operation
type ExecuteBootstrapScriptResponse 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"`
}
func (response ExecuteBootstrapScriptResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExecuteBootstrapScriptResponse) String() string
ForceRefreshResourcePrincipalDetails Force Refresh Resource Principal Session Token Details.
type ForceRefreshResourcePrincipalDetails struct {
// Base-64 encoded Cluster Admin Password for cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m ForceRefreshResourcePrincipalDetails) String() string
func (m ForceRefreshResourcePrincipalDetails) 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
ForceRefreshResourcePrincipalRequest wrapper for the ForceRefreshResourcePrincipal operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ForceRefreshResourcePrincipal.go.html to see an example of how to use ForceRefreshResourcePrincipalRequest.
type ForceRefreshResourcePrincipalRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration.
ResourcePrincipalConfigurationId *string `mandatory:"true" contributesTo:"path" name:"resourcePrincipalConfigurationId"`
// Details of refreshing resource principal session token
ForceRefreshResourcePrincipalDetails `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
}
func (request ForceRefreshResourcePrincipalRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ForceRefreshResourcePrincipalRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ForceRefreshResourcePrincipalRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ForceRefreshResourcePrincipalRequest) String() string
func (request ForceRefreshResourcePrincipalRequest) 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
ForceRefreshResourcePrincipalResponse wrapper for the ForceRefreshResourcePrincipal operation
type ForceRefreshResourcePrincipalResponse 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"`
}
func (response ForceRefreshResourcePrincipalResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ForceRefreshResourcePrincipalResponse) String() string
GetAutoScalingConfigurationRequest wrapper for the GetAutoScalingConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetAutoScalingConfiguration.go.html to see an example of how to use 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
}
func (request GetAutoScalingConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAutoScalingConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAutoScalingConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAutoScalingConfigurationRequest) String() string
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
GetAutoScalingConfigurationResponse wrapper for the GetAutoScalingConfiguration operation
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"`
}
func (response GetAutoScalingConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAutoScalingConfigurationResponse) String() string
GetBdsApiKeyRequest wrapper for the GetBdsApiKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetBdsApiKey.go.html to see an example of how to use 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
}
func (request GetBdsApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBdsApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBdsApiKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBdsApiKeyRequest) String() string
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
GetBdsApiKeyResponse wrapper for the GetBdsApiKey operation
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"`
}
func (response GetBdsApiKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBdsApiKeyResponse) String() string
GetBdsInstanceRequest wrapper for the GetBdsInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetBdsInstance.go.html to see an example of how to use 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
}
func (request GetBdsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBdsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBdsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBdsInstanceRequest) String() string
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
GetBdsInstanceResponse wrapper for the GetBdsInstance operation
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"`
}
func (response GetBdsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBdsInstanceResponse) String() string
GetBdsMetastoreConfigurationRequest wrapper for the GetBdsMetastoreConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetBdsMetastoreConfiguration.go.html to see an example of how to use 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
}
func (request GetBdsMetastoreConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBdsMetastoreConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBdsMetastoreConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBdsMetastoreConfigurationRequest) String() string
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
GetBdsMetastoreConfigurationResponse wrapper for the GetBdsMetastoreConfiguration operation
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"`
}
func (response GetBdsMetastoreConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBdsMetastoreConfigurationResponse) String() string
GetIdentityConfigurationRequest wrapper for the GetIdentityConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetIdentityConfiguration.go.html to see an example of how to use GetIdentityConfigurationRequest.
type GetIdentityConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The OCID of the identity configuration
IdentityConfigurationId *string `mandatory:"true" contributesTo:"path" name:"identityConfigurationId"`
// 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 GetIdentityConfigurationSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder GetIdentityConfigurationSortOrderEnum `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
}
func (request GetIdentityConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetIdentityConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetIdentityConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetIdentityConfigurationRequest) String() string
func (request GetIdentityConfigurationRequest) 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
GetIdentityConfigurationResponse wrapper for the GetIdentityConfiguration operation
type GetIdentityConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of IdentityConfiguration instances
IdentityConfiguration `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"`
}
func (response GetIdentityConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetIdentityConfigurationResponse) String() string
GetIdentityConfigurationSortByEnum Enum with underlying type: string
type GetIdentityConfigurationSortByEnum string
Set of constants representing the allowable values for GetIdentityConfigurationSortByEnum
const (
GetIdentityConfigurationSortByTimecreated GetIdentityConfigurationSortByEnum = "timeCreated"
GetIdentityConfigurationSortByDisplayname GetIdentityConfigurationSortByEnum = "displayName"
)
func GetGetIdentityConfigurationSortByEnumValues() []GetIdentityConfigurationSortByEnum
GetGetIdentityConfigurationSortByEnumValues Enumerates the set of values for GetIdentityConfigurationSortByEnum
func GetMappingGetIdentityConfigurationSortByEnum(val string) (GetIdentityConfigurationSortByEnum, bool)
GetMappingGetIdentityConfigurationSortByEnum performs case Insensitive comparison on enum value and return the desired enum
GetIdentityConfigurationSortOrderEnum Enum with underlying type: string
type GetIdentityConfigurationSortOrderEnum string
Set of constants representing the allowable values for GetIdentityConfigurationSortOrderEnum
const (
GetIdentityConfigurationSortOrderAsc GetIdentityConfigurationSortOrderEnum = "ASC"
GetIdentityConfigurationSortOrderDesc GetIdentityConfigurationSortOrderEnum = "DESC"
)
func GetGetIdentityConfigurationSortOrderEnumValues() []GetIdentityConfigurationSortOrderEnum
GetGetIdentityConfigurationSortOrderEnumValues Enumerates the set of values for GetIdentityConfigurationSortOrderEnum
func GetMappingGetIdentityConfigurationSortOrderEnum(val string) (GetIdentityConfigurationSortOrderEnum, bool)
GetMappingGetIdentityConfigurationSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
GetNodeBackupConfigurationRequest wrapper for the GetNodeBackupConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetNodeBackupConfiguration.go.html to see an example of how to use GetNodeBackupConfigurationRequest.
type GetNodeBackupConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique Oracle-assigned identifier of the NodeBackupConfiguration.
NodeBackupConfigurationId *string `mandatory:"true" contributesTo:"path" name:"nodeBackupConfigurationId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetNodeBackupConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNodeBackupConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNodeBackupConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNodeBackupConfigurationRequest) String() string
func (request GetNodeBackupConfigurationRequest) 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
GetNodeBackupConfigurationResponse wrapper for the GetNodeBackupConfiguration operation
type GetNodeBackupConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The NodeBackupConfiguration instance
NodeBackupConfiguration `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"`
}
func (response GetNodeBackupConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNodeBackupConfigurationResponse) String() string
GetNodeBackupRequest wrapper for the GetNodeBackup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetNodeBackup.go.html to see an example of how to use GetNodeBackupRequest.
type GetNodeBackupRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique assigned identifier of the nodeBackupId.
NodeBackupId *string `mandatory:"true" contributesTo:"path" name:"nodeBackupId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetNodeBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNodeBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNodeBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNodeBackupRequest) String() string
func (request GetNodeBackupRequest) 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
GetNodeBackupResponse wrapper for the GetNodeBackup operation
type GetNodeBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// The NodeBackup instance
NodeBackup `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"`
}
func (response GetNodeBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNodeBackupResponse) String() string
GetNodeReplaceConfigurationRequest wrapper for the GetNodeReplaceConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetNodeReplaceConfiguration.go.html to see an example of how to use GetNodeReplaceConfigurationRequest.
type GetNodeReplaceConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique Oracle-assigned identifier of the NodeReplaceConfiguration.
NodeReplaceConfigurationId *string `mandatory:"true" contributesTo:"path" name:"nodeReplaceConfigurationId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetNodeReplaceConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNodeReplaceConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNodeReplaceConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNodeReplaceConfigurationRequest) String() string
func (request GetNodeReplaceConfigurationRequest) 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
GetNodeReplaceConfigurationResponse wrapper for the GetNodeReplaceConfiguration operation
type GetNodeReplaceConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The NodeReplaceConfiguration instance
NodeReplaceConfiguration `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"`
}
func (response GetNodeReplaceConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNodeReplaceConfigurationResponse) String() string
GetOsPatchDetailsRequest wrapper for the GetOsPatchDetails operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetOsPatchDetails.go.html to see an example of how to use GetOsPatchDetailsRequest.
type GetOsPatchDetailsRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The version of the OS patch.
OsPatchVersion *string `mandatory:"true" contributesTo:"query" name:"osPatchVersion"`
// 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
}
func (request GetOsPatchDetailsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOsPatchDetailsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOsPatchDetailsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOsPatchDetailsRequest) String() string
func (request GetOsPatchDetailsRequest) 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
GetOsPatchDetailsResponse wrapper for the GetOsPatchDetails operation
type GetOsPatchDetailsResponse struct {
// The underlying http response
RawResponse *http.Response
// The OsPatchDetails instance
OsPatchDetails `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"`
}
func (response GetOsPatchDetailsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOsPatchDetailsResponse) String() string
GetResourcePrincipalConfigurationRequest wrapper for the GetResourcePrincipalConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetResourcePrincipalConfiguration.go.html to see an example of how to use GetResourcePrincipalConfigurationRequest.
type GetResourcePrincipalConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration.
ResourcePrincipalConfigurationId *string `mandatory:"true" contributesTo:"path" name:"resourcePrincipalConfigurationId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetResourcePrincipalConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetResourcePrincipalConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetResourcePrincipalConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetResourcePrincipalConfigurationRequest) String() string
func (request GetResourcePrincipalConfigurationRequest) 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
GetResourcePrincipalConfigurationResponse wrapper for the GetResourcePrincipalConfiguration operation
type GetResourcePrincipalConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The ResourcePrincipalConfiguration instance
ResourcePrincipalConfiguration `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"`
}
func (response GetResourcePrincipalConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetResourcePrincipalConfigurationResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a 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"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HorizontalScalingScheduleDetails Details of a horizontal scaling schedule.
type HorizontalScalingScheduleDetails interface {
}
HostCertDetails Details about the host and corresponding certificate.
type HostCertDetails struct {
// Fully qualified domain name (FQDN) of the host
HostName *string `mandatory:"true" json:"hostName"`
// Certificate value in string format
Certificate *string `mandatory:"true" json:"certificate"`
// Private key of the provided certificate
PrivateKey *string `mandatory:"true" json:"privateKey"`
}
func (m HostCertDetails) String() string
func (m HostCertDetails) 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
HostSpecificCertificateDetails Host specific certificate details
type HostSpecificCertificateDetails struct {
// Name of the host.
HostName *string `mandatory:"false" json:"hostName"`
// Type of certificate self signed or CA signed
CertificateType HostSpecificCertificateDetailsCertificateTypeEnum `mandatory:"false" json:"certificateType,omitempty"`
// The time the certificate expires, shown as an RFC 3339 formatted datetime string.
TimeExpiry *common.SDKTime `mandatory:"false" json:"timeExpiry"`
}
func (m HostSpecificCertificateDetails) String() string
func (m HostSpecificCertificateDetails) 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
HostSpecificCertificateDetailsCertificateTypeEnum Enum with underlying type: string
type HostSpecificCertificateDetailsCertificateTypeEnum string
Set of constants representing the allowable values for HostSpecificCertificateDetailsCertificateTypeEnum
const (
HostSpecificCertificateDetailsCertificateTypeCustomSigned HostSpecificCertificateDetailsCertificateTypeEnum = "CUSTOM_SIGNED"
HostSpecificCertificateDetailsCertificateTypeSelfSigned HostSpecificCertificateDetailsCertificateTypeEnum = "SELF_SIGNED"
)
func GetHostSpecificCertificateDetailsCertificateTypeEnumValues() []HostSpecificCertificateDetailsCertificateTypeEnum
GetHostSpecificCertificateDetailsCertificateTypeEnumValues Enumerates the set of values for HostSpecificCertificateDetailsCertificateTypeEnum
func GetMappingHostSpecificCertificateDetailsCertificateTypeEnum(val string) (HostSpecificCertificateDetailsCertificateTypeEnum, bool)
GetMappingHostSpecificCertificateDetailsCertificateTypeEnum performs case Insensitive comparison on enum value and return the desired enum
IamUserSyncConfiguration Information about the IAM user sync configuration.
type IamUserSyncConfiguration struct {
// whether to append POSIX attributes to IAM users
IsPosixAttributesAdditionRequired *bool `mandatory:"true" json:"isPosixAttributesAdditionRequired"`
// Lifecycle state of the IAM user sync config
LifecycleState IamUserSyncConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Time when this IAM user sync config was created, shown as an RFC 3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Time when this IAM user sync config was updated, shown as an RFC 3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
}
func (m IamUserSyncConfiguration) String() string
func (m IamUserSyncConfiguration) 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
IamUserSyncConfigurationDetails Details for activating/updating an IAM user sync configuration
type IamUserSyncConfigurationDetails struct {
// whether posix attribute needs to be appended to users, required for updating IAM user sync configuration
IsPosixAttributesAdditionRequired *bool `mandatory:"false" json:"isPosixAttributesAdditionRequired"`
}
func (m IamUserSyncConfigurationDetails) String() string
func (m IamUserSyncConfigurationDetails) 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
IamUserSyncConfigurationLifecycleStateEnum Enum with underlying type: string
type IamUserSyncConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for IamUserSyncConfigurationLifecycleStateEnum
const (
IamUserSyncConfigurationLifecycleStateCreating IamUserSyncConfigurationLifecycleStateEnum = "CREATING"
IamUserSyncConfigurationLifecycleStateActive IamUserSyncConfigurationLifecycleStateEnum = "ACTIVE"
IamUserSyncConfigurationLifecycleStateInactive IamUserSyncConfigurationLifecycleStateEnum = "INACTIVE"
IamUserSyncConfigurationLifecycleStateDeleting IamUserSyncConfigurationLifecycleStateEnum = "DELETING"
IamUserSyncConfigurationLifecycleStateUpdating IamUserSyncConfigurationLifecycleStateEnum = "UPDATING"
IamUserSyncConfigurationLifecycleStateFailed IamUserSyncConfigurationLifecycleStateEnum = "FAILED"
)
func GetIamUserSyncConfigurationLifecycleStateEnumValues() []IamUserSyncConfigurationLifecycleStateEnum
GetIamUserSyncConfigurationLifecycleStateEnumValues Enumerates the set of values for IamUserSyncConfigurationLifecycleStateEnum
func GetMappingIamUserSyncConfigurationLifecycleStateEnum(val string) (IamUserSyncConfigurationLifecycleStateEnum, bool)
GetMappingIamUserSyncConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
IdentityConfiguration Details about the identity configuration
type IdentityConfiguration struct {
// The id of the UPST config
Id *string `mandatory:"true" json:"id"`
// the display name of the identity configuration
DisplayName *string `mandatory:"true" json:"displayName"`
// Identity domain to use for identity config
IdentityDomainId *string `mandatory:"true" json:"identityDomainId"`
// identity domain confidential application ID for the identity config
ConfidentialApplicationId *string `mandatory:"true" json:"confidentialApplicationId"`
// Lifecycle state of the identity configuration
LifecycleState IdentityConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Time when this identity configuration was created, shown as an RFC 3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Time when this identity configuration config was updated, shown as an RFC 3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
IamUserSyncConfiguration *IamUserSyncConfiguration `mandatory:"false" json:"iamUserSyncConfiguration"`
UpstConfiguration *UpstConfiguration `mandatory:"false" json:"upstConfiguration"`
}
func (m IdentityConfiguration) String() string
func (m IdentityConfiguration) 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
IdentityConfigurationLifecycleStateEnum Enum with underlying type: string
type IdentityConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for IdentityConfigurationLifecycleStateEnum
const (
IdentityConfigurationLifecycleStateActive IdentityConfigurationLifecycleStateEnum = "ACTIVE"
IdentityConfigurationLifecycleStateDeleted IdentityConfigurationLifecycleStateEnum = "DELETED"
)
func GetIdentityConfigurationLifecycleStateEnumValues() []IdentityConfigurationLifecycleStateEnum
GetIdentityConfigurationLifecycleStateEnumValues Enumerates the set of values for IdentityConfigurationLifecycleStateEnum
func GetMappingIdentityConfigurationLifecycleStateEnum(val string) (IdentityConfigurationLifecycleStateEnum, bool)
GetMappingIdentityConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
IdentityConfigurationSummary Summary of the identity config
type IdentityConfigurationSummary struct {
// The id of the identity config
Id *string `mandatory:"true" json:"id"`
// Display name of the identity config
DisplayName *string `mandatory:"true" json:"displayName"`
// Lifecycle state of the identity config
LifecycleState IdentityConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m IdentityConfigurationSummary) String() string
func (m IdentityConfigurationSummary) 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
InstallOsPatchDetails Os patch details for installing a os patches to a cluster.
type InstallOsPatchDetails struct {
// The target os patch version.
OsPatchVersion *string `mandatory:"true" json:"osPatchVersion"`
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
PatchingConfigs PatchingConfigs `mandatory:"false" json:"patchingConfigs"`
}
func (m InstallOsPatchDetails) String() string
func (m *InstallOsPatchDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m InstallOsPatchDetails) 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
InstallOsPatchRequest wrapper for the InstallOsPatch operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/InstallOsPatch.go.html to see an example of how to use InstallOsPatchRequest.
type InstallOsPatchRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details of the target os patch that will be installed
InstallOsPatchDetails `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
}
func (request InstallOsPatchRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request InstallOsPatchRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request InstallOsPatchRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request InstallOsPatchRequest) String() string
func (request InstallOsPatchRequest) 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
InstallOsPatchResponse wrapper for the InstallOsPatch operation
type InstallOsPatchResponse 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"`
}
func (response InstallOsPatchResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response InstallOsPatchResponse) String() string
InstallPatchDetails The reqeust body while installing a patch to a cluster.
type InstallPatchDetails struct {
// The version of the patch to be installed.
Version *string `mandatory:"true" json:"version"`
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
PatchingConfig OdhPatchingConfig `mandatory:"false" json:"patchingConfig"`
}
func (m InstallPatchDetails) String() string
func (m *InstallPatchDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m InstallPatchDetails) 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
InstallPatchRequest wrapper for the InstallPatch operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/InstallPatch.go.html to see an example of how to use InstallPatchRequest.
type InstallPatchRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details of the patch to be installed.
InstallPatchDetails `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
}
func (request InstallPatchRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request InstallPatchRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request InstallPatchRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request InstallPatchRequest) String() string
func (request InstallPatchRequest) 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
InstallPatchResponse wrapper for the InstallPatch operation
type InstallPatchResponse 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"`
}
func (response InstallPatchResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response InstallPatchResponse) String() string
KerberosDetails Details about the Kerberos principals.
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"`
}
func (m KerberosDetails) String() string
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
LevelTypeDetails Details of the type of level used to trigger the creation of a new node backup configuration or node replacement configuration.
type LevelTypeDetails interface {
}
LevelTypeDetailsLevelTypeEnum Enum with underlying type: string
type LevelTypeDetailsLevelTypeEnum string
Set of constants representing the allowable values for LevelTypeDetailsLevelTypeEnum
const (
LevelTypeDetailsLevelTypeLevel LevelTypeDetailsLevelTypeEnum = "NODE_LEVEL"
LevelTypeDetailsLevelTypeTypeLevel LevelTypeDetailsLevelTypeEnum = "NODE_TYPE_LEVEL"
)
func GetLevelTypeDetailsLevelTypeEnumValues() []LevelTypeDetailsLevelTypeEnum
GetLevelTypeDetailsLevelTypeEnumValues Enumerates the set of values for LevelTypeDetailsLevelTypeEnum
func GetMappingLevelTypeDetailsLevelTypeEnum(val string) (LevelTypeDetailsLevelTypeEnum, bool)
GetMappingLevelTypeDetailsLevelTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListAutoScalingConfigurationsRequest wrapper for the ListAutoScalingConfigurations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListAutoScalingConfigurations.go.html to see an example of how to use 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
}
func (request ListAutoScalingConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAutoScalingConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAutoScalingConfigurationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAutoScalingConfigurationsRequest) String() string
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
ListAutoScalingConfigurationsResponse wrapper for the ListAutoScalingConfigurations operation
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"`
}
func (response ListAutoScalingConfigurationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAutoScalingConfigurationsResponse) String() string
ListAutoScalingConfigurationsSortByEnum Enum with underlying type: string
type ListAutoScalingConfigurationsSortByEnum string
Set of constants representing the allowable values for ListAutoScalingConfigurationsSortByEnum
const (
ListAutoScalingConfigurationsSortByTimecreated ListAutoScalingConfigurationsSortByEnum = "timeCreated"
ListAutoScalingConfigurationsSortByDisplayname ListAutoScalingConfigurationsSortByEnum = "displayName"
)
func GetListAutoScalingConfigurationsSortByEnumValues() []ListAutoScalingConfigurationsSortByEnum
GetListAutoScalingConfigurationsSortByEnumValues Enumerates the set of values for ListAutoScalingConfigurationsSortByEnum
func GetMappingListAutoScalingConfigurationsSortByEnum(val string) (ListAutoScalingConfigurationsSortByEnum, bool)
GetMappingListAutoScalingConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAutoScalingConfigurationsSortOrderEnum Enum with underlying type: string
type ListAutoScalingConfigurationsSortOrderEnum string
Set of constants representing the allowable values for ListAutoScalingConfigurationsSortOrderEnum
const (
ListAutoScalingConfigurationsSortOrderAsc ListAutoScalingConfigurationsSortOrderEnum = "ASC"
ListAutoScalingConfigurationsSortOrderDesc ListAutoScalingConfigurationsSortOrderEnum = "DESC"
)
func GetListAutoScalingConfigurationsSortOrderEnumValues() []ListAutoScalingConfigurationsSortOrderEnum
GetListAutoScalingConfigurationsSortOrderEnumValues Enumerates the set of values for ListAutoScalingConfigurationsSortOrderEnum
func GetMappingListAutoScalingConfigurationsSortOrderEnum(val string) (ListAutoScalingConfigurationsSortOrderEnum, bool)
GetMappingListAutoScalingConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBdsApiKeysRequest wrapper for the ListBdsApiKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListBdsApiKeys.go.html to see an example of how to use 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
}
func (request ListBdsApiKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBdsApiKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBdsApiKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBdsApiKeysRequest) String() string
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
ListBdsApiKeysResponse wrapper for the ListBdsApiKeys operation
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"`
}
func (response ListBdsApiKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBdsApiKeysResponse) String() string
ListBdsApiKeysSortByEnum Enum with underlying type: string
type ListBdsApiKeysSortByEnum string
Set of constants representing the allowable values for ListBdsApiKeysSortByEnum
const (
ListBdsApiKeysSortByTimecreated ListBdsApiKeysSortByEnum = "timeCreated"
ListBdsApiKeysSortByDisplayname ListBdsApiKeysSortByEnum = "displayName"
)
func GetListBdsApiKeysSortByEnumValues() []ListBdsApiKeysSortByEnum
GetListBdsApiKeysSortByEnumValues Enumerates the set of values for ListBdsApiKeysSortByEnum
func GetMappingListBdsApiKeysSortByEnum(val string) (ListBdsApiKeysSortByEnum, bool)
GetMappingListBdsApiKeysSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBdsApiKeysSortOrderEnum Enum with underlying type: string
type ListBdsApiKeysSortOrderEnum string
Set of constants representing the allowable values for ListBdsApiKeysSortOrderEnum
const (
ListBdsApiKeysSortOrderAsc ListBdsApiKeysSortOrderEnum = "ASC"
ListBdsApiKeysSortOrderDesc ListBdsApiKeysSortOrderEnum = "DESC"
)
func GetListBdsApiKeysSortOrderEnumValues() []ListBdsApiKeysSortOrderEnum
GetListBdsApiKeysSortOrderEnumValues Enumerates the set of values for ListBdsApiKeysSortOrderEnum
func GetMappingListBdsApiKeysSortOrderEnum(val string) (ListBdsApiKeysSortOrderEnum, bool)
GetMappingListBdsApiKeysSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBdsClusterVersionsRequest wrapper for the ListBdsClusterVersions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListBdsClusterVersions.go.html to see an example of how to use ListBdsClusterVersionsRequest.
type ListBdsClusterVersionsRequest struct {
// 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. If no value is specified bdsVersion is default.
SortBy ListBdsClusterVersionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListBdsClusterVersionsSortOrderEnum `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
}
func (request ListBdsClusterVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBdsClusterVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBdsClusterVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBdsClusterVersionsRequest) String() string
func (request ListBdsClusterVersionsRequest) 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
ListBdsClusterVersionsResponse wrapper for the ListBdsClusterVersions operation
type ListBdsClusterVersionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []BdsClusterVersionSummary instances
Items []BdsClusterVersionSummary `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"`
}
func (response ListBdsClusterVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBdsClusterVersionsResponse) String() string
ListBdsClusterVersionsSortByEnum Enum with underlying type: string
type ListBdsClusterVersionsSortByEnum string
Set of constants representing the allowable values for ListBdsClusterVersionsSortByEnum
const (
ListBdsClusterVersionsSortByBdsversion ListBdsClusterVersionsSortByEnum = "bdsVersion"
)
func GetListBdsClusterVersionsSortByEnumValues() []ListBdsClusterVersionsSortByEnum
GetListBdsClusterVersionsSortByEnumValues Enumerates the set of values for ListBdsClusterVersionsSortByEnum
func GetMappingListBdsClusterVersionsSortByEnum(val string) (ListBdsClusterVersionsSortByEnum, bool)
GetMappingListBdsClusterVersionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBdsClusterVersionsSortOrderEnum Enum with underlying type: string
type ListBdsClusterVersionsSortOrderEnum string
Set of constants representing the allowable values for ListBdsClusterVersionsSortOrderEnum
const (
ListBdsClusterVersionsSortOrderAsc ListBdsClusterVersionsSortOrderEnum = "ASC"
ListBdsClusterVersionsSortOrderDesc ListBdsClusterVersionsSortOrderEnum = "DESC"
)
func GetListBdsClusterVersionsSortOrderEnumValues() []ListBdsClusterVersionsSortOrderEnum
GetListBdsClusterVersionsSortOrderEnumValues Enumerates the set of values for ListBdsClusterVersionsSortOrderEnum
func GetMappingListBdsClusterVersionsSortOrderEnum(val string) (ListBdsClusterVersionsSortOrderEnum, bool)
GetMappingListBdsClusterVersionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBdsInstancesRequest wrapper for the ListBdsInstances operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListBdsInstances.go.html to see an example of how to use 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
}
func (request ListBdsInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBdsInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBdsInstancesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBdsInstancesRequest) String() string
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
ListBdsInstancesResponse wrapper for the ListBdsInstances operation
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"`
}
func (response ListBdsInstancesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBdsInstancesResponse) String() string
ListBdsInstancesSortByEnum Enum with underlying type: string
type ListBdsInstancesSortByEnum string
Set of constants representing the allowable values for ListBdsInstancesSortByEnum
const (
ListBdsInstancesSortByTimecreated ListBdsInstancesSortByEnum = "timeCreated"
ListBdsInstancesSortByDisplayname ListBdsInstancesSortByEnum = "displayName"
)
func GetListBdsInstancesSortByEnumValues() []ListBdsInstancesSortByEnum
GetListBdsInstancesSortByEnumValues Enumerates the set of values for ListBdsInstancesSortByEnum
func GetMappingListBdsInstancesSortByEnum(val string) (ListBdsInstancesSortByEnum, bool)
GetMappingListBdsInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBdsInstancesSortOrderEnum Enum with underlying type: string
type ListBdsInstancesSortOrderEnum string
Set of constants representing the allowable values for ListBdsInstancesSortOrderEnum
const (
ListBdsInstancesSortOrderAsc ListBdsInstancesSortOrderEnum = "ASC"
ListBdsInstancesSortOrderDesc ListBdsInstancesSortOrderEnum = "DESC"
)
func GetListBdsInstancesSortOrderEnumValues() []ListBdsInstancesSortOrderEnum
GetListBdsInstancesSortOrderEnumValues Enumerates the set of values for ListBdsInstancesSortOrderEnum
func GetMappingListBdsInstancesSortOrderEnum(val string) (ListBdsInstancesSortOrderEnum, bool)
GetMappingListBdsInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBdsMetastoreConfigurationsRequest wrapper for the ListBdsMetastoreConfigurations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListBdsMetastoreConfigurations.go.html to see an example of how to use 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
}
func (request ListBdsMetastoreConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBdsMetastoreConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBdsMetastoreConfigurationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBdsMetastoreConfigurationsRequest) String() string
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
ListBdsMetastoreConfigurationsResponse wrapper for the ListBdsMetastoreConfigurations operation
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"`
}
func (response ListBdsMetastoreConfigurationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBdsMetastoreConfigurationsResponse) String() string
ListBdsMetastoreConfigurationsSortByEnum Enum with underlying type: string
type ListBdsMetastoreConfigurationsSortByEnum string
Set of constants representing the allowable values for ListBdsMetastoreConfigurationsSortByEnum
const (
ListBdsMetastoreConfigurationsSortByTimecreated ListBdsMetastoreConfigurationsSortByEnum = "timeCreated"
ListBdsMetastoreConfigurationsSortByDisplayname ListBdsMetastoreConfigurationsSortByEnum = "displayName"
)
func GetListBdsMetastoreConfigurationsSortByEnumValues() []ListBdsMetastoreConfigurationsSortByEnum
GetListBdsMetastoreConfigurationsSortByEnumValues Enumerates the set of values for ListBdsMetastoreConfigurationsSortByEnum
func GetMappingListBdsMetastoreConfigurationsSortByEnum(val string) (ListBdsMetastoreConfigurationsSortByEnum, bool)
GetMappingListBdsMetastoreConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBdsMetastoreConfigurationsSortOrderEnum Enum with underlying type: string
type ListBdsMetastoreConfigurationsSortOrderEnum string
Set of constants representing the allowable values for ListBdsMetastoreConfigurationsSortOrderEnum
const (
ListBdsMetastoreConfigurationsSortOrderAsc ListBdsMetastoreConfigurationsSortOrderEnum = "ASC"
ListBdsMetastoreConfigurationsSortOrderDesc ListBdsMetastoreConfigurationsSortOrderEnum = "DESC"
)
func GetListBdsMetastoreConfigurationsSortOrderEnumValues() []ListBdsMetastoreConfigurationsSortOrderEnum
GetListBdsMetastoreConfigurationsSortOrderEnumValues Enumerates the set of values for ListBdsMetastoreConfigurationsSortOrderEnum
func GetMappingListBdsMetastoreConfigurationsSortOrderEnum(val string) (ListBdsMetastoreConfigurationsSortOrderEnum, bool)
GetMappingListBdsMetastoreConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListIdentityConfigurationsRequest wrapper for the ListIdentityConfigurations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListIdentityConfigurations.go.html to see an example of how to use ListIdentityConfigurationsRequest.
type ListIdentityConfigurationsRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListIdentityConfigurationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListIdentityConfigurationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The state of the identity config
LifecycleState IdentityConfigurationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListIdentityConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIdentityConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIdentityConfigurationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIdentityConfigurationsRequest) String() string
func (request ListIdentityConfigurationsRequest) 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
ListIdentityConfigurationsResponse wrapper for the ListIdentityConfigurations operation
type ListIdentityConfigurationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []IdentityConfigurationSummary instances
Items []IdentityConfigurationSummary `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"`
}
func (response ListIdentityConfigurationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIdentityConfigurationsResponse) String() string
ListIdentityConfigurationsSortByEnum Enum with underlying type: string
type ListIdentityConfigurationsSortByEnum string
Set of constants representing the allowable values for ListIdentityConfigurationsSortByEnum
const (
ListIdentityConfigurationsSortByTimecreated ListIdentityConfigurationsSortByEnum = "timeCreated"
ListIdentityConfigurationsSortByDisplayname ListIdentityConfigurationsSortByEnum = "displayName"
)
func GetListIdentityConfigurationsSortByEnumValues() []ListIdentityConfigurationsSortByEnum
GetListIdentityConfigurationsSortByEnumValues Enumerates the set of values for ListIdentityConfigurationsSortByEnum
func GetMappingListIdentityConfigurationsSortByEnum(val string) (ListIdentityConfigurationsSortByEnum, bool)
GetMappingListIdentityConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListIdentityConfigurationsSortOrderEnum Enum with underlying type: string
type ListIdentityConfigurationsSortOrderEnum string
Set of constants representing the allowable values for ListIdentityConfigurationsSortOrderEnum
const (
ListIdentityConfigurationsSortOrderAsc ListIdentityConfigurationsSortOrderEnum = "ASC"
ListIdentityConfigurationsSortOrderDesc ListIdentityConfigurationsSortOrderEnum = "DESC"
)
func GetListIdentityConfigurationsSortOrderEnumValues() []ListIdentityConfigurationsSortOrderEnum
GetListIdentityConfigurationsSortOrderEnumValues Enumerates the set of values for ListIdentityConfigurationsSortOrderEnum
func GetMappingListIdentityConfigurationsSortOrderEnum(val string) (ListIdentityConfigurationsSortOrderEnum, bool)
GetMappingListIdentityConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListNodeBackupConfigurationsRequest wrapper for the ListNodeBackupConfigurations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListNodeBackupConfigurations.go.html to see an example of how to use ListNodeBackupConfigurationsRequest.
type ListNodeBackupConfigurationsRequest struct {
// 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 ListNodeBackupConfigurationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListNodeBackupConfigurationsSortOrderEnum `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 NodeBackupConfiguration configuration.
LifecycleState NodeBackupConfigurationLifecycleStateEnum `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
}
func (request ListNodeBackupConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNodeBackupConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNodeBackupConfigurationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNodeBackupConfigurationsRequest) String() string
func (request ListNodeBackupConfigurationsRequest) 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
ListNodeBackupConfigurationsResponse wrapper for the ListNodeBackupConfigurations operation
type ListNodeBackupConfigurationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []NodeBackupConfigurationSummary instances
Items []NodeBackupConfigurationSummary `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"`
}
func (response ListNodeBackupConfigurationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNodeBackupConfigurationsResponse) String() string
ListNodeBackupConfigurationsSortByEnum Enum with underlying type: string
type ListNodeBackupConfigurationsSortByEnum string
Set of constants representing the allowable values for ListNodeBackupConfigurationsSortByEnum
const (
ListNodeBackupConfigurationsSortByTimecreated ListNodeBackupConfigurationsSortByEnum = "timeCreated"
ListNodeBackupConfigurationsSortByDisplayname ListNodeBackupConfigurationsSortByEnum = "displayName"
)
func GetListNodeBackupConfigurationsSortByEnumValues() []ListNodeBackupConfigurationsSortByEnum
GetListNodeBackupConfigurationsSortByEnumValues Enumerates the set of values for ListNodeBackupConfigurationsSortByEnum
func GetMappingListNodeBackupConfigurationsSortByEnum(val string) (ListNodeBackupConfigurationsSortByEnum, bool)
GetMappingListNodeBackupConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListNodeBackupConfigurationsSortOrderEnum Enum with underlying type: string
type ListNodeBackupConfigurationsSortOrderEnum string
Set of constants representing the allowable values for ListNodeBackupConfigurationsSortOrderEnum
const (
ListNodeBackupConfigurationsSortOrderAsc ListNodeBackupConfigurationsSortOrderEnum = "ASC"
ListNodeBackupConfigurationsSortOrderDesc ListNodeBackupConfigurationsSortOrderEnum = "DESC"
)
func GetListNodeBackupConfigurationsSortOrderEnumValues() []ListNodeBackupConfigurationsSortOrderEnum
GetListNodeBackupConfigurationsSortOrderEnumValues Enumerates the set of values for ListNodeBackupConfigurationsSortOrderEnum
func GetMappingListNodeBackupConfigurationsSortOrderEnum(val string) (ListNodeBackupConfigurationsSortOrderEnum, bool)
GetMappingListNodeBackupConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListNodeBackupsRequest wrapper for the ListNodeBackups operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListNodeBackups.go.html to see an example of how to use ListNodeBackupsRequest.
type ListNodeBackupsRequest struct {
// 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 ListNodeBackupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListNodeBackupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The node host name belonged to a node that has a node backup.
NodeHostName *string `mandatory:"false" contributesTo:"query" name:"nodeHostName"`
// The state of the Node's Backup.
LifecycleState NodeBackupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The display name belonged to the node backup.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListNodeBackupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNodeBackupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNodeBackupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNodeBackupsRequest) String() string
func (request ListNodeBackupsRequest) 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
ListNodeBackupsResponse wrapper for the ListNodeBackups operation
type ListNodeBackupsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []NodeBackupSummary instances
Items []NodeBackupSummary `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"`
}
func (response ListNodeBackupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNodeBackupsResponse) String() string
ListNodeBackupsSortByEnum Enum with underlying type: string
type ListNodeBackupsSortByEnum string
Set of constants representing the allowable values for ListNodeBackupsSortByEnum
const (
ListNodeBackupsSortByTimecreated ListNodeBackupsSortByEnum = "timeCreated"
ListNodeBackupsSortByDisplayname ListNodeBackupsSortByEnum = "displayName"
)
func GetListNodeBackupsSortByEnumValues() []ListNodeBackupsSortByEnum
GetListNodeBackupsSortByEnumValues Enumerates the set of values for ListNodeBackupsSortByEnum
func GetMappingListNodeBackupsSortByEnum(val string) (ListNodeBackupsSortByEnum, bool)
GetMappingListNodeBackupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListNodeBackupsSortOrderEnum Enum with underlying type: string
type ListNodeBackupsSortOrderEnum string
Set of constants representing the allowable values for ListNodeBackupsSortOrderEnum
const (
ListNodeBackupsSortOrderAsc ListNodeBackupsSortOrderEnum = "ASC"
ListNodeBackupsSortOrderDesc ListNodeBackupsSortOrderEnum = "DESC"
)
func GetListNodeBackupsSortOrderEnumValues() []ListNodeBackupsSortOrderEnum
GetListNodeBackupsSortOrderEnumValues Enumerates the set of values for ListNodeBackupsSortOrderEnum
func GetMappingListNodeBackupsSortOrderEnum(val string) (ListNodeBackupsSortOrderEnum, bool)
GetMappingListNodeBackupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListNodeReplaceConfigurationsRequest wrapper for the ListNodeReplaceConfigurations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListNodeReplaceConfigurations.go.html to see an example of how to use ListNodeReplaceConfigurationsRequest.
type ListNodeReplaceConfigurationsRequest struct {
// 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 ListNodeReplaceConfigurationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListNodeReplaceConfigurationsSortOrderEnum `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 NodeReplaceConfiguration.
LifecycleState NodeReplaceConfigurationLifecycleStateEnum `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
}
func (request ListNodeReplaceConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNodeReplaceConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNodeReplaceConfigurationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNodeReplaceConfigurationsRequest) String() string
func (request ListNodeReplaceConfigurationsRequest) 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
ListNodeReplaceConfigurationsResponse wrapper for the ListNodeReplaceConfigurations operation
type ListNodeReplaceConfigurationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []NodeReplaceConfigurationSummary instances
Items []NodeReplaceConfigurationSummary `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"`
}
func (response ListNodeReplaceConfigurationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNodeReplaceConfigurationsResponse) String() string
ListNodeReplaceConfigurationsSortByEnum Enum with underlying type: string
type ListNodeReplaceConfigurationsSortByEnum string
Set of constants representing the allowable values for ListNodeReplaceConfigurationsSortByEnum
const (
ListNodeReplaceConfigurationsSortByTimecreated ListNodeReplaceConfigurationsSortByEnum = "timeCreated"
ListNodeReplaceConfigurationsSortByDisplayname ListNodeReplaceConfigurationsSortByEnum = "displayName"
)
func GetListNodeReplaceConfigurationsSortByEnumValues() []ListNodeReplaceConfigurationsSortByEnum
GetListNodeReplaceConfigurationsSortByEnumValues Enumerates the set of values for ListNodeReplaceConfigurationsSortByEnum
func GetMappingListNodeReplaceConfigurationsSortByEnum(val string) (ListNodeReplaceConfigurationsSortByEnum, bool)
GetMappingListNodeReplaceConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListNodeReplaceConfigurationsSortOrderEnum Enum with underlying type: string
type ListNodeReplaceConfigurationsSortOrderEnum string
Set of constants representing the allowable values for ListNodeReplaceConfigurationsSortOrderEnum
const (
ListNodeReplaceConfigurationsSortOrderAsc ListNodeReplaceConfigurationsSortOrderEnum = "ASC"
ListNodeReplaceConfigurationsSortOrderDesc ListNodeReplaceConfigurationsSortOrderEnum = "DESC"
)
func GetListNodeReplaceConfigurationsSortOrderEnumValues() []ListNodeReplaceConfigurationsSortOrderEnum
GetListNodeReplaceConfigurationsSortOrderEnumValues Enumerates the set of values for ListNodeReplaceConfigurationsSortOrderEnum
func GetMappingListNodeReplaceConfigurationsSortOrderEnum(val string) (ListNodeReplaceConfigurationsSortOrderEnum, bool)
GetMappingListNodeReplaceConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOsPatchesRequest wrapper for the ListOsPatches operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListOsPatches.go.html to see an example of how to use ListOsPatchesRequest.
type ListOsPatchesRequest struct {
// 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 ListOsPatchesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListOsPatchesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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
}
func (request ListOsPatchesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOsPatchesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOsPatchesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOsPatchesRequest) String() string
func (request ListOsPatchesRequest) 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
ListOsPatchesResponse wrapper for the ListOsPatches operation
type ListOsPatchesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []OsPatchSummary instances
Items []OsPatchSummary `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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response ListOsPatchesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOsPatchesResponse) String() string
ListOsPatchesSortByEnum Enum with underlying type: string
type ListOsPatchesSortByEnum string
Set of constants representing the allowable values for ListOsPatchesSortByEnum
const (
ListOsPatchesSortByTimecreated ListOsPatchesSortByEnum = "timeCreated"
ListOsPatchesSortByDisplayname ListOsPatchesSortByEnum = "displayName"
)
func GetListOsPatchesSortByEnumValues() []ListOsPatchesSortByEnum
GetListOsPatchesSortByEnumValues Enumerates the set of values for ListOsPatchesSortByEnum
func GetMappingListOsPatchesSortByEnum(val string) (ListOsPatchesSortByEnum, bool)
GetMappingListOsPatchesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOsPatchesSortOrderEnum Enum with underlying type: string
type ListOsPatchesSortOrderEnum string
Set of constants representing the allowable values for ListOsPatchesSortOrderEnum
const (
ListOsPatchesSortOrderAsc ListOsPatchesSortOrderEnum = "ASC"
ListOsPatchesSortOrderDesc ListOsPatchesSortOrderEnum = "DESC"
)
func GetListOsPatchesSortOrderEnumValues() []ListOsPatchesSortOrderEnum
GetListOsPatchesSortOrderEnumValues Enumerates the set of values for ListOsPatchesSortOrderEnum
func GetMappingListOsPatchesSortOrderEnum(val string) (ListOsPatchesSortOrderEnum, bool)
GetMappingListOsPatchesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPatchHistoriesRequest wrapper for the ListPatchHistories operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListPatchHistories.go.html to see an example of how to use ListPatchHistoriesRequest.
type ListPatchHistoriesRequest 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"`
// The status of the patch.
LifecycleState PatchHistorySummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The version of the patch
PatchVersion *string `mandatory:"false" contributesTo:"query" name:"patchVersion"`
// 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 ListPatchHistoriesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListPatchHistoriesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 type of a BDS patch history entity.
PatchType PatchHistorySummaryPatchTypeEnum `mandatory:"false" contributesTo:"query" name:"patchType" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPatchHistoriesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPatchHistoriesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPatchHistoriesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPatchHistoriesRequest) String() string
func (request ListPatchHistoriesRequest) 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
ListPatchHistoriesResponse wrapper for the ListPatchHistories operation
type ListPatchHistoriesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []PatchHistorySummary instances
Items []PatchHistorySummary `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"`
}
func (response ListPatchHistoriesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPatchHistoriesResponse) String() string
ListPatchHistoriesSortByEnum Enum with underlying type: string
type ListPatchHistoriesSortByEnum string
Set of constants representing the allowable values for ListPatchHistoriesSortByEnum
const (
ListPatchHistoriesSortByTimecreated ListPatchHistoriesSortByEnum = "timeCreated"
ListPatchHistoriesSortByDisplayname ListPatchHistoriesSortByEnum = "displayName"
)
func GetListPatchHistoriesSortByEnumValues() []ListPatchHistoriesSortByEnum
GetListPatchHistoriesSortByEnumValues Enumerates the set of values for ListPatchHistoriesSortByEnum
func GetMappingListPatchHistoriesSortByEnum(val string) (ListPatchHistoriesSortByEnum, bool)
GetMappingListPatchHistoriesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPatchHistoriesSortOrderEnum Enum with underlying type: string
type ListPatchHistoriesSortOrderEnum string
Set of constants representing the allowable values for ListPatchHistoriesSortOrderEnum
const (
ListPatchHistoriesSortOrderAsc ListPatchHistoriesSortOrderEnum = "ASC"
ListPatchHistoriesSortOrderDesc ListPatchHistoriesSortOrderEnum = "DESC"
)
func GetListPatchHistoriesSortOrderEnumValues() []ListPatchHistoriesSortOrderEnum
GetListPatchHistoriesSortOrderEnumValues Enumerates the set of values for ListPatchHistoriesSortOrderEnum
func GetMappingListPatchHistoriesSortOrderEnum(val string) (ListPatchHistoriesSortOrderEnum, bool)
GetMappingListPatchHistoriesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPatchesRequest wrapper for the ListPatches operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListPatches.go.html to see an example of how to use ListPatchesRequest.
type ListPatchesRequest 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"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPatchesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPatchesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPatchesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPatchesRequest) String() string
func (request ListPatchesRequest) 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
ListPatchesResponse wrapper for the ListPatches operation
type ListPatchesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []PatchSummary instances
Items []PatchSummary `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"`
}
func (response ListPatchesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPatchesResponse) String() string
ListResourcePrincipalConfigurationsRequest wrapper for the ListResourcePrincipalConfigurations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListResourcePrincipalConfigurations.go.html to see an example of how to use ListResourcePrincipalConfigurationsRequest.
type ListResourcePrincipalConfigurationsRequest struct {
// 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 ListResourcePrincipalConfigurationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListResourcePrincipalConfigurationsSortOrderEnum `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 ResourcePrincipalConfiguration.
LifecycleState ResourcePrincipalConfigurationLifecycleStateEnum `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
}
func (request ListResourcePrincipalConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListResourcePrincipalConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListResourcePrincipalConfigurationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListResourcePrincipalConfigurationsRequest) String() string
func (request ListResourcePrincipalConfigurationsRequest) 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
ListResourcePrincipalConfigurationsResponse wrapper for the ListResourcePrincipalConfigurations operation
type ListResourcePrincipalConfigurationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ResourcePrincipalConfigurationSummary instances
Items []ResourcePrincipalConfigurationSummary `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"`
}
func (response ListResourcePrincipalConfigurationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListResourcePrincipalConfigurationsResponse) String() string
ListResourcePrincipalConfigurationsSortByEnum Enum with underlying type: string
type ListResourcePrincipalConfigurationsSortByEnum string
Set of constants representing the allowable values for ListResourcePrincipalConfigurationsSortByEnum
const (
ListResourcePrincipalConfigurationsSortByTimecreated ListResourcePrincipalConfigurationsSortByEnum = "timeCreated"
ListResourcePrincipalConfigurationsSortByDisplayname ListResourcePrincipalConfigurationsSortByEnum = "displayName"
)
func GetListResourcePrincipalConfigurationsSortByEnumValues() []ListResourcePrincipalConfigurationsSortByEnum
GetListResourcePrincipalConfigurationsSortByEnumValues Enumerates the set of values for ListResourcePrincipalConfigurationsSortByEnum
func GetMappingListResourcePrincipalConfigurationsSortByEnum(val string) (ListResourcePrincipalConfigurationsSortByEnum, bool)
GetMappingListResourcePrincipalConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListResourcePrincipalConfigurationsSortOrderEnum Enum with underlying type: string
type ListResourcePrincipalConfigurationsSortOrderEnum string
Set of constants representing the allowable values for ListResourcePrincipalConfigurationsSortOrderEnum
const (
ListResourcePrincipalConfigurationsSortOrderAsc ListResourcePrincipalConfigurationsSortOrderEnum = "ASC"
ListResourcePrincipalConfigurationsSortOrderDesc ListResourcePrincipalConfigurationsSortOrderEnum = "DESC"
)
func GetListResourcePrincipalConfigurationsSortOrderEnumValues() []ListResourcePrincipalConfigurationsSortOrderEnum
GetListResourcePrincipalConfigurationsSortOrderEnumValues Enumerates the set of values for ListResourcePrincipalConfigurationsSortOrderEnum
func GetMappingListResourcePrincipalConfigurationsSortOrderEnum(val string) (ListResourcePrincipalConfigurationsSortOrderEnum, bool)
GetMappingListResourcePrincipalConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The 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
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []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"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
ListWorkRequestErrorsSortByDisplayname ListWorkRequestErrorsSortByEnum = "displayName"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The 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
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []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"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
ListWorkRequestLogsSortByDisplayname ListWorkRequestLogsSortByEnum = "displayName"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ListWorkRequests.go.html to see an example of how to use 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
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []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"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimecreated ListWorkRequestsSortByEnum = "timeCreated"
ListWorkRequestsSortByDisplayname ListWorkRequestsSortByEnum = "displayName"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
MetricBasedHorizontalScaleInConfig Configration for a metric based horizontal scale-in policy.
type MetricBasedHorizontalScaleInConfig struct {
Metric *AutoScalePolicyMetricRule `mandatory:"false" json:"metric"`
// This value is the minimum number of nodes the cluster can be scaled-in to.
MinNodeCount *int `mandatory:"false" json:"minNodeCount"`
// This value is the number of nodes to remove during a scale-in event.
StepSize *int `mandatory:"false" json:"stepSize"`
}
func (m MetricBasedHorizontalScaleInConfig) String() string
func (m MetricBasedHorizontalScaleInConfig) 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
MetricBasedHorizontalScaleOutConfig Configration for a metric based horizontal scale-out policy.
type MetricBasedHorizontalScaleOutConfig struct {
Metric *AutoScalePolicyMetricRule `mandatory:"false" json:"metric"`
// This value is the maximum number of nodes the cluster can be scaled-out to.
MaxNodeCount *int `mandatory:"false" json:"maxNodeCount"`
// This value is the number of nodes to add during a scale-out event.
StepSize *int `mandatory:"false" json:"stepSize"`
}
func (m MetricBasedHorizontalScaleOutConfig) String() string
func (m MetricBasedHorizontalScaleOutConfig) 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
MetricBasedHorizontalScalingPolicyDetails Details of a metric based horizontal autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.
type MetricBasedHorizontalScalingPolicyDetails struct {
ScaleOutConfig *MetricBasedHorizontalScaleOutConfig `mandatory:"false" json:"scaleOutConfig"`
ScaleInConfig *MetricBasedHorizontalScaleInConfig `mandatory:"false" json:"scaleInConfig"`
// The type of autoscaling trigger.
TriggerType AutoScalePolicyDetailsTriggerTypeEnum `mandatory:"true" json:"triggerType"`
// The type of autoscaling action to take.
ActionType AutoScalePolicyDetailsActionTypeEnum `mandatory:"true" json:"actionType"`
}
func (m MetricBasedHorizontalScalingPolicyDetails) GetActionType() AutoScalePolicyDetailsActionTypeEnum
GetActionType returns ActionType
func (m MetricBasedHorizontalScalingPolicyDetails) GetTriggerType() AutoScalePolicyDetailsTriggerTypeEnum
GetTriggerType returns TriggerType
func (m MetricBasedHorizontalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MetricBasedHorizontalScalingPolicyDetails) String() string
func (m MetricBasedHorizontalScalingPolicyDetails) 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
MetricBasedVerticalScaleDownConfig Configration for a metric based vertical scale-down policy.
type MetricBasedVerticalScaleDownConfig struct {
Metric *AutoScalePolicyMetricRule `mandatory:"false" json:"metric"`
// For nodes with flexible compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the minimum number of OCPUs each node can be scaled-down to. This value is not used for nodes with fixed compute shapes.
MinOcpusPerNode *int `mandatory:"false" json:"minOcpusPerNode"`
// For nodes with flexible compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the minimum memory in GBs each node can be scaled-down to. This value is not used for nodes with fixed compute shapes.
MinMemoryPerNode *int `mandatory:"false" json:"minMemoryPerNode"`
// For nodes with flexible compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the number of OCPUs to remove from each node during a scale-down event. This value is not used for nodes with fixed compute shapes.
OcpuStepSize *int `mandatory:"false" json:"ocpuStepSize"`
// For nodes with flexible compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the size of memory in GBs to remove from each node during a scale-down event. This value is not used for nodes with fixed compute shapes.
MemoryStepSize *int `mandatory:"false" json:"memoryStepSize"`
}
func (m MetricBasedVerticalScaleDownConfig) String() string
func (m MetricBasedVerticalScaleDownConfig) 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
MetricBasedVerticalScaleUpConfig Configration for a metric based vertical scale-up policy.
type MetricBasedVerticalScaleUpConfig struct {
Metric *AutoScalePolicyMetricRule `mandatory:"false" json:"metric"`
// For nodes with flexible compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the maximum number of OCPUs each node can be scaled-up to. This value is not used for nodes with fixed compute shapes.
MaxOcpusPerNode *int `mandatory:"false" json:"maxOcpusPerNode"`
// For nodes with flexible compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the maximum memory in GBs each node can be scaled-up to. This value is not used for nodes with fixed compute shapes.
MaxMemoryPerNode *int `mandatory:"false" json:"maxMemoryPerNode"`
// For nodes with flexible compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the number of OCPUs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.
OcpuStepSize *int `mandatory:"false" json:"ocpuStepSize"`
// For nodes with flexible compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the size of memory in GBs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.
MemoryStepSize *int `mandatory:"false" json:"memoryStepSize"`
}
func (m MetricBasedVerticalScaleUpConfig) String() string
func (m MetricBasedVerticalScaleUpConfig) 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
MetricBasedVerticalScalingPolicyDetails Details of a metric based vertical autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.
type MetricBasedVerticalScalingPolicyDetails struct {
ScaleUpConfig *MetricBasedVerticalScaleUpConfig `mandatory:"false" json:"scaleUpConfig"`
ScaleDownConfig *MetricBasedVerticalScaleDownConfig `mandatory:"false" json:"scaleDownConfig"`
// The type of autoscaling trigger.
TriggerType AutoScalePolicyDetailsTriggerTypeEnum `mandatory:"true" json:"triggerType"`
// The type of autoscaling action to take.
ActionType AutoScalePolicyDetailsActionTypeEnum `mandatory:"true" json:"actionType"`
}
func (m MetricBasedVerticalScalingPolicyDetails) GetActionType() AutoScalePolicyDetailsActionTypeEnum
GetActionType returns ActionType
func (m MetricBasedVerticalScalingPolicyDetails) GetTriggerType() AutoScalePolicyDetailsTriggerTypeEnum
GetTriggerType returns TriggerType
func (m MetricBasedVerticalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MetricBasedVerticalScalingPolicyDetails) String() string
func (m MetricBasedVerticalScalingPolicyDetails) 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
MetricThresholdRule An autoscale action is triggered when a performance metric exceeds a threshold.
type MetricThresholdRule struct {
// This value is the minimum period of time the metric value 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"`
}
func (m MetricThresholdRule) String() string
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
MetricThresholdRuleOperatorEnum Enum with underlying type: string
type MetricThresholdRuleOperatorEnum string
Set of constants representing the allowable values for MetricThresholdRuleOperatorEnum
const (
MetricThresholdRuleOperatorGt MetricThresholdRuleOperatorEnum = "GT"
MetricThresholdRuleOperatorLt MetricThresholdRuleOperatorEnum = "LT"
)
func GetMappingMetricThresholdRuleOperatorEnum(val string) (MetricThresholdRuleOperatorEnum, bool)
GetMappingMetricThresholdRuleOperatorEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMetricThresholdRuleOperatorEnumValues() []MetricThresholdRuleOperatorEnum
GetMetricThresholdRuleOperatorEnumValues Enumerates the set of values for MetricThresholdRuleOperatorEnum
NetworkConfig Additional configuration of the user's network.
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"`
}
func (m NetworkConfig) String() string
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
Node Details about a 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"`
// The total number of OCPUs available to the node.
Ocpus *int `mandatory:"false" json:"ocpus"`
// The total amount of memory available to the node, in gigabytes.
MemoryInGBs *int `mandatory:"false" json:"memoryInGBs"`
// The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
Nvmes *int `mandatory:"false" json:"nvmes"`
// The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null.
LocalDisksTotalSizeInGBs *float64 `mandatory:"false" json:"localDisksTotalSizeInGBs"`
// The date and time the instance is expected to be stopped / started, in the format defined by RFC3339.
TimeMaintenanceRebootDue *common.SDKTime `mandatory:"false" json:"timeMaintenanceRebootDue"`
// BDS-assigned Operating System version for the node.
OsVersion *string `mandatory:"false" json:"osVersion"`
// Indicates if the node requires a reboot to either reflect the latest os kernel or take actions for maintenance reboot.
IsRebootRequired *bool `mandatory:"false" json:"isRebootRequired"`
// Version of the ODH (Oracle Distribution including Apache Hadoop) for the node.
OdhVersion *string `mandatory:"false" json:"odhVersion"`
// The date and time the instance was replaced by a new vm with a node backup.
TimeReplaced *common.SDKTime `mandatory:"false" json:"timeReplaced"`
// The node back id that was used for replacing the node.
NodeBackupId *string `mandatory:"false" json:"nodeBackupId"`
}
func (m Node) String() string
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
NodeBackup The information about the Node's backup.
type NodeBackup struct {
// The id of the node backup.
Id *string `mandatory:"true" json:"id"`
// BDS generated name for the backup. Format is nodeHostName_timeCreated
DisplayName *string `mandatory:"true" json:"displayName"`
// The instance OCID of the node, which is the resource from which the node backup was acquired.
NodeInstanceId *string `mandatory:"true" json:"nodeInstanceId"`
// Host name of the node to which this backup belongs.
NodeHostName *string `mandatory:"true" json:"nodeHostName"`
// type based on how backup action was initiated.
BackupTriggerType NodeBackupBackupTriggerTypeEnum `mandatory:"true" json:"backupTriggerType"`
// Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created.
BackupType NodeBackupBackupTypeEnum `mandatory:"true" json:"backupType"`
// The state of the NodeBackup.
LifecycleState NodeBackupLifecycleStateEnum `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 ID of the nodeBackupConfiguration if the NodeBackup is automatically created by applying the configuration.
NodeBackupConfigId *string `mandatory:"false" json:"nodeBackupConfigId"`
}
func (m NodeBackup) String() string
func (m NodeBackup) 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
NodeBackupBackupTriggerTypeEnum Enum with underlying type: string
type NodeBackupBackupTriggerTypeEnum string
Set of constants representing the allowable values for NodeBackupBackupTriggerTypeEnum
const (
NodeBackupBackupTriggerTypeManual NodeBackupBackupTriggerTypeEnum = "MANUAL"
NodeBackupBackupTriggerTypeScheduled NodeBackupBackupTriggerTypeEnum = "SCHEDULED"
)
func GetMappingNodeBackupBackupTriggerTypeEnum(val string) (NodeBackupBackupTriggerTypeEnum, bool)
GetMappingNodeBackupBackupTriggerTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeBackupBackupTriggerTypeEnumValues() []NodeBackupBackupTriggerTypeEnum
GetNodeBackupBackupTriggerTypeEnumValues Enumerates the set of values for NodeBackupBackupTriggerTypeEnum
NodeBackupBackupTypeEnum Enum with underlying type: string
type NodeBackupBackupTypeEnum string
Set of constants representing the allowable values for NodeBackupBackupTypeEnum
const (
NodeBackupBackupTypeFull NodeBackupBackupTypeEnum = "FULL"
NodeBackupBackupTypeIncremental NodeBackupBackupTypeEnum = "INCREMENTAL"
)
func GetMappingNodeBackupBackupTypeEnum(val string) (NodeBackupBackupTypeEnum, bool)
GetMappingNodeBackupBackupTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeBackupBackupTypeEnumValues() []NodeBackupBackupTypeEnum
GetNodeBackupBackupTypeEnumValues Enumerates the set of values for NodeBackupBackupTypeEnum
NodeBackupConfiguration The information about the NodeBackupConfiguration.
type NodeBackupConfiguration struct {
// The unique identifier for the NodeBackupConfiguration.
Id *string `mandatory:"true" json:"id"`
// The OCID of the bdsInstance which is the parent resource id.
BdsInstanceId *string `mandatory:"true" json:"bdsInstanceId"`
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
LevelTypeDetails LevelTypeDetails `mandatory:"true" json:"levelTypeDetails"`
// The state of the NodeBackupConfiguration.
LifecycleState NodeBackupConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the NodeBackupConfiguration was created, shown as an RFC 3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the NodeBackupConfiguration was updated, shown as an RFC 3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The time zone of the execution schedule, in IANA time zone database name format
Timezone *string `mandatory:"true" json:"timezone"`
// Day/time recurrence (specified following RFC 5545) at which to trigger the backup process. Currently only DAILY, WEEKLY and MONTHLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR. Other fields are not supported.
Schedule *string `mandatory:"true" json:"schedule"`
// Number of backup copies to retain.
NumberOfBackupsToRetain *int `mandatory:"true" json:"numberOfBackupsToRetain"`
// Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created.
BackupType NodeBackupBackupTypeEnum `mandatory:"false" json:"backupType,omitempty"`
}
func (m NodeBackupConfiguration) String() string
func (m *NodeBackupConfiguration) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m NodeBackupConfiguration) 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
NodeBackupConfigurationLifecycleStateEnum Enum with underlying type: string
type NodeBackupConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for NodeBackupConfigurationLifecycleStateEnum
const (
NodeBackupConfigurationLifecycleStateCreating NodeBackupConfigurationLifecycleStateEnum = "CREATING"
NodeBackupConfigurationLifecycleStateActive NodeBackupConfigurationLifecycleStateEnum = "ACTIVE"
NodeBackupConfigurationLifecycleStateUpdating NodeBackupConfigurationLifecycleStateEnum = "UPDATING"
NodeBackupConfigurationLifecycleStateDeleting NodeBackupConfigurationLifecycleStateEnum = "DELETING"
NodeBackupConfigurationLifecycleStateDeleted NodeBackupConfigurationLifecycleStateEnum = "DELETED"
NodeBackupConfigurationLifecycleStateFailed NodeBackupConfigurationLifecycleStateEnum = "FAILED"
)
func GetMappingNodeBackupConfigurationLifecycleStateEnum(val string) (NodeBackupConfigurationLifecycleStateEnum, bool)
GetMappingNodeBackupConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeBackupConfigurationLifecycleStateEnumValues() []NodeBackupConfigurationLifecycleStateEnum
GetNodeBackupConfigurationLifecycleStateEnumValues Enumerates the set of values for NodeBackupConfigurationLifecycleStateEnum
NodeBackupConfigurationSummary The information about the NodeBackupConfiguration.
type NodeBackupConfigurationSummary struct {
// The id of the NodeBackupConfiguration.
Id *string `mandatory:"true" json:"id"`
// The OCID of the bdsInstance which is the parent resource id.
BdsInstanceId *string `mandatory:"true" json:"bdsInstanceId"`
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
LevelTypeDetails LevelTypeDetails `mandatory:"true" json:"levelTypeDetails"`
// The state of the NodeBackupConfiguration.
LifecycleState NodeBackupConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the NodeBackupConfiguration was created, shown as an RFC 3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the NodeBackupConfiguration was updated, shown as an RFC 3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
}
func (m NodeBackupConfigurationSummary) String() string
func (m *NodeBackupConfigurationSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m NodeBackupConfigurationSummary) 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
NodeBackupLifecycleStateEnum Enum with underlying type: string
type NodeBackupLifecycleStateEnum string
Set of constants representing the allowable values for NodeBackupLifecycleStateEnum
const (
NodeBackupLifecycleStateCreating NodeBackupLifecycleStateEnum = "CREATING"
NodeBackupLifecycleStateActive NodeBackupLifecycleStateEnum = "ACTIVE"
NodeBackupLifecycleStateUpdating NodeBackupLifecycleStateEnum = "UPDATING"
NodeBackupLifecycleStateDeleting NodeBackupLifecycleStateEnum = "DELETING"
NodeBackupLifecycleStateDeleted NodeBackupLifecycleStateEnum = "DELETED"
NodeBackupLifecycleStateFailed NodeBackupLifecycleStateEnum = "FAILED"
NodeBackupLifecycleStatePartial NodeBackupLifecycleStateEnum = "PARTIAL"
)
func GetMappingNodeBackupLifecycleStateEnum(val string) (NodeBackupLifecycleStateEnum, bool)
GetMappingNodeBackupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeBackupLifecycleStateEnumValues() []NodeBackupLifecycleStateEnum
GetNodeBackupLifecycleStateEnumValues Enumerates the set of values for NodeBackupLifecycleStateEnum
NodeBackupSummary The information about the nodeBackupSummary.
type NodeBackupSummary struct {
// The id of the node backup.
Id *string `mandatory:"true" json:"id"`
// BDS generated name for the backup. Format is nodeHostName_timeCreated.
DisplayName *string `mandatory:"true" json:"displayName"`
// The instance OCID of the node, which is the resource from which the node backup was acquired.
NodeInstanceId *string `mandatory:"true" json:"nodeInstanceId"`
// Host name of the node that the backup belongs to.
NodeHostName *string `mandatory:"true" json:"nodeHostName"`
// type based on how backup action was initiated.
BackupTriggerType NodeBackupBackupTriggerTypeEnum `mandatory:"true" json:"backupTriggerType"`
// Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created
BackupType NodeBackupBackupTypeEnum `mandatory:"true" json:"backupType"`
// The state of NodeBackup.
LifecycleState NodeBackupLifecycleStateEnum `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"`
}
func (m NodeBackupSummary) String() string
func (m NodeBackupSummary) 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
NodeLevelDetails Details of node level used to trigger the creation of a new node backup configuration and node replacement configuration.
type NodeLevelDetails struct {
// Host name of the node to create backup configuration.
NodeHostName *string `mandatory:"true" json:"nodeHostName"`
}
func (m NodeLevelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NodeLevelDetails) String() string
func (m NodeLevelDetails) 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
NodeLifecycleStateEnum Enum with underlying type: string
type NodeLifecycleStateEnum string
Set of constants representing the allowable values for NodeLifecycleStateEnum
const (
NodeLifecycleStateCreating NodeLifecycleStateEnum = "CREATING"
NodeLifecycleStateActive NodeLifecycleStateEnum = "ACTIVE"
NodeLifecycleStateInactive NodeLifecycleStateEnum = "INACTIVE"
NodeLifecycleStateUpdating NodeLifecycleStateEnum = "UPDATING"
NodeLifecycleStateDeleting NodeLifecycleStateEnum = "DELETING"
NodeLifecycleStateDeleted NodeLifecycleStateEnum = "DELETED"
NodeLifecycleStateFailed NodeLifecycleStateEnum = "FAILED"
NodeLifecycleStateStopped NodeLifecycleStateEnum = "STOPPED"
NodeLifecycleStateStopping NodeLifecycleStateEnum = "STOPPING"
NodeLifecycleStateStarting NodeLifecycleStateEnum = "STARTING"
)
func GetMappingNodeLifecycleStateEnum(val string) (NodeLifecycleStateEnum, bool)
GetMappingNodeLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeLifecycleStateEnumValues() []NodeLifecycleStateEnum
GetNodeLifecycleStateEnumValues Enumerates the set of values for NodeLifecycleStateEnum
NodeNodeTypeEnum Enum with underlying type: string
type NodeNodeTypeEnum string
Set of constants representing the allowable values for NodeNodeTypeEnum
const (
NodeNodeTypeMaster NodeNodeTypeEnum = "MASTER"
NodeNodeTypeEdge NodeNodeTypeEnum = "EDGE"
NodeNodeTypeUtility NodeNodeTypeEnum = "UTILITY"
NodeNodeTypeWorker NodeNodeTypeEnum = "WORKER"
NodeNodeTypeComputeOnlyWorker NodeNodeTypeEnum = "COMPUTE_ONLY_WORKER"
NodeNodeTypeKafkaBroker NodeNodeTypeEnum = "KAFKA_BROKER"
NodeNodeTypeBursting NodeNodeTypeEnum = "BURSTING"
NodeNodeTypeCloudSql NodeNodeTypeEnum = "CLOUD_SQL"
)
func GetMappingNodeNodeTypeEnum(val string) (NodeNodeTypeEnum, bool)
GetMappingNodeNodeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeNodeTypeEnumValues() []NodeNodeTypeEnum
GetNodeNodeTypeEnumValues Enumerates the set of values for NodeNodeTypeEnum
NodeReplaceConfiguration The information about the NodeReplaceConfiguration.
type NodeReplaceConfiguration struct {
// The unique identifier for the NodeReplaceConfiguration.
Id *string `mandatory:"true" json:"id"`
// The OCID of the bdsInstance which is the parent resource id.
BdsInstanceId *string `mandatory:"true" json:"bdsInstanceId"`
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
LevelTypeDetails LevelTypeDetails `mandatory:"true" json:"levelTypeDetails"`
// The state of the NodeReplaceConfiguration.
LifecycleState NodeReplaceConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the NodeReplaceConfiguration was created, shown as an RFC 3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the NodeReplaceConfiguration was updated, shown as an RFC 3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Type of compute instance health metric to use for node replacement
MetricType NodeReplaceConfigurationMetricTypeEnum `mandatory:"true" json:"metricType"`
// This value is the minimum period of time to wait for metric emission before triggering node replacement. The value is in minutes.
DurationInMinutes *int `mandatory:"true" json:"durationInMinutes"`
}
func (m NodeReplaceConfiguration) String() string
func (m *NodeReplaceConfiguration) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m NodeReplaceConfiguration) 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
NodeReplaceConfigurationLifecycleStateEnum Enum with underlying type: string
type NodeReplaceConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for NodeReplaceConfigurationLifecycleStateEnum
const (
NodeReplaceConfigurationLifecycleStateCreating NodeReplaceConfigurationLifecycleStateEnum = "CREATING"
NodeReplaceConfigurationLifecycleStateActive NodeReplaceConfigurationLifecycleStateEnum = "ACTIVE"
NodeReplaceConfigurationLifecycleStateUpdating NodeReplaceConfigurationLifecycleStateEnum = "UPDATING"
NodeReplaceConfigurationLifecycleStateDeleting NodeReplaceConfigurationLifecycleStateEnum = "DELETING"
NodeReplaceConfigurationLifecycleStateDeleted NodeReplaceConfigurationLifecycleStateEnum = "DELETED"
NodeReplaceConfigurationLifecycleStateFailed NodeReplaceConfigurationLifecycleStateEnum = "FAILED"
)
func GetMappingNodeReplaceConfigurationLifecycleStateEnum(val string) (NodeReplaceConfigurationLifecycleStateEnum, bool)
GetMappingNodeReplaceConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeReplaceConfigurationLifecycleStateEnumValues() []NodeReplaceConfigurationLifecycleStateEnum
GetNodeReplaceConfigurationLifecycleStateEnumValues Enumerates the set of values for NodeReplaceConfigurationLifecycleStateEnum
NodeReplaceConfigurationMetricTypeEnum Enum with underlying type: string
type NodeReplaceConfigurationMetricTypeEnum string
Set of constants representing the allowable values for NodeReplaceConfigurationMetricTypeEnum
const (
NodeReplaceConfigurationMetricTypeStatus NodeReplaceConfigurationMetricTypeEnum = "INSTANCE_STATUS"
NodeReplaceConfigurationMetricTypeAccessibilityStatus NodeReplaceConfigurationMetricTypeEnum = "INSTANCE_ACCESSIBILITY_STATUS"
)
func GetMappingNodeReplaceConfigurationMetricTypeEnum(val string) (NodeReplaceConfigurationMetricTypeEnum, bool)
GetMappingNodeReplaceConfigurationMetricTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeReplaceConfigurationMetricTypeEnumValues() []NodeReplaceConfigurationMetricTypeEnum
GetNodeReplaceConfigurationMetricTypeEnumValues Enumerates the set of values for NodeReplaceConfigurationMetricTypeEnum
NodeReplaceConfigurationSummary The information about the NodeReplaceConfigurationSummary.
type NodeReplaceConfigurationSummary struct {
// The id of the NodeReplaceConfiguration.
Id *string `mandatory:"true" json:"id"`
// The OCID of the bdsInstance which is the parent resource id.
BdsInstanceId *string `mandatory:"true" json:"bdsInstanceId"`
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
LevelTypeDetails LevelTypeDetails `mandatory:"true" json:"levelTypeDetails"`
// The state of the NodeReplaceConfiguration.
LifecycleState NodeReplaceConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the NodeReplaceConfiguration was created, shown as an RFC 3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the NodeReplaceConfiguration was updated, shown as an RFC 3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
}
func (m NodeReplaceConfigurationSummary) String() string
func (m *NodeReplaceConfigurationSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m NodeReplaceConfigurationSummary) 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
NodeTypeLevelDetails Details of node type level used to trigger the creation of a new node backup configuration and node replacement configuration.
type NodeTypeLevelDetails struct {
// Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created.
NodeType NodeNodeTypeEnum `mandatory:"true" json:"nodeType"`
}
func (m NodeTypeLevelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NodeTypeLevelDetails) String() string
func (m NodeTypeLevelDetails) 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
NodeTypeShapeConfig Shape configuration at node type level. Start cluster will start all nodes as is if no config is specified.
type NodeTypeShapeConfig struct {
// The Big Data Service cluster node type.
NodeType NodeNodeTypeEnum `mandatory:"true" json:"nodeType"`
// Shape of the node. This has to be specified when starting the cluster. Defaults to wn0 for homogeneous clusters and remains empty for heterogeneous clusters.
// If provided, all nodes in the node type will adopt the specified shape; otherwise, nodes retain their original shapes.
Shape *string `mandatory:"true" json:"shape"`
}
func (m NodeTypeShapeConfig) String() string
func (m NodeTypeShapeConfig) 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
OdhPatchingConfig Detailed configurations for defining the behavior when installing ODH patches. If not provided, nodes will be patched with down time.
type OdhPatchingConfig interface {
}
OdhPatchingConfigPatchingConfigStrategyEnum Enum with underlying type: string
type OdhPatchingConfigPatchingConfigStrategyEnum string
Set of constants representing the allowable values for OdhPatchingConfigPatchingConfigStrategyEnum
const (
OdhPatchingConfigPatchingConfigStrategyDowntimeBased OdhPatchingConfigPatchingConfigStrategyEnum = "DOWNTIME_BASED"
OdhPatchingConfigPatchingConfigStrategyBatchingBased OdhPatchingConfigPatchingConfigStrategyEnum = "BATCHING_BASED"
OdhPatchingConfigPatchingConfigStrategyDomainBased OdhPatchingConfigPatchingConfigStrategyEnum = "DOMAIN_BASED"
)
func GetMappingOdhPatchingConfigPatchingConfigStrategyEnum(val string) (OdhPatchingConfigPatchingConfigStrategyEnum, bool)
GetMappingOdhPatchingConfigPatchingConfigStrategyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdhPatchingConfigPatchingConfigStrategyEnumValues() []OdhPatchingConfigPatchingConfigStrategyEnum
GetOdhPatchingConfigPatchingConfigStrategyEnumValues Enumerates the set of values for OdhPatchingConfigPatchingConfigStrategyEnum
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypesEnum Enum with underlying type: string
type OperationTypesEnum string
Set of constants representing the allowable values for OperationTypesEnum
const (
OperationTypesCreateBds OperationTypesEnum = "CREATE_BDS"
OperationTypesUpdateBds OperationTypesEnum = "UPDATE_BDS"
OperationTypesDeleteBds OperationTypesEnum = "DELETE_BDS"
OperationTypesAddBlockStorage OperationTypesEnum = "ADD_BLOCK_STORAGE"
OperationTypesAddMasterNodes OperationTypesEnum = "ADD_MASTER_NODES"
OperationTypesAddUtilityNodes OperationTypesEnum = "ADD_UTILITY_NODES"
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"
OperationTypesRemoveNode OperationTypesEnum = "REMOVE_NODE"
OperationTypesCreateAutoscaleConfig OperationTypesEnum = "CREATE_AUTOSCALE_CONFIG"
OperationTypesUpdateAutoscaleConfig OperationTypesEnum = "UPDATE_AUTOSCALE_CONFIG"
OperationTypesDeleteAutoscaleConfig OperationTypesEnum = "DELETE_AUTOSCALE_CONFIG"
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"
OperationTypesPatchBds OperationTypesEnum = "PATCH_BDS"
OperationTypesPatchOdh OperationTypesEnum = "PATCH_ODH"
OperationTypesPatchOs OperationTypesEnum = "PATCH_OS"
OperationTypesStopBds OperationTypesEnum = "STOP_BDS"
OperationTypesStartBds OperationTypesEnum = "START_BDS"
OperationTypesAddKafka OperationTypesEnum = "ADD_KAFKA"
OperationTypesRemoveKafka OperationTypesEnum = "REMOVE_KAFKA"
OperationTypesExecuteBootstrapScript OperationTypesEnum = "EXECUTE_BOOTSTRAP_SCRIPT"
OperationTypesOdhServiceCertificateUpdate OperationTypesEnum = "ODH_SERVICE_CERTIFICATE_UPDATE"
OperationTypesCreateBackupConfig OperationTypesEnum = "CREATE_BACKUP_CONFIG"
OperationTypesUpdateBackupConfig OperationTypesEnum = "UPDATE_BACKUP_CONFIG"
OperationTypesDeleteBackupConfig OperationTypesEnum = "DELETE_BACKUP_CONFIG"
OperationTypesCreateNodeReplaceConfig OperationTypesEnum = "CREATE_NODE_REPLACE_CONFIG"
OperationTypesUpdateNodeReplaceConfig OperationTypesEnum = "UPDATE_NODE_REPLACE_CONFIG"
OperationTypesDeleteNodeReplaceConfig OperationTypesEnum = "DELETE_NODE_REPLACE_CONFIG"
OperationTypesBackupNodes OperationTypesEnum = "BACKUP_NODES"
OperationTypesDeleteNodeBackup OperationTypesEnum = "DELETE_NODE_BACKUP"
OperationTypesReplaceNode OperationTypesEnum = "REPLACE_NODE"
OperationTypesCreateResourcePrincipalConfiguration OperationTypesEnum = "CREATE_RESOURCE_PRINCIPAL_CONFIGURATION"
OperationTypesDeleteResourcePrincipalConfiguration OperationTypesEnum = "DELETE_RESOURCE_PRINCIPAL_CONFIGURATION"
OperationTypesUpdateResourcePrincipalConfiguration OperationTypesEnum = "UPDATE_RESOURCE_PRINCIPAL_CONFIGURATION"
OperationTypesRefreshResourcePrincipal OperationTypesEnum = "REFRESH_RESOURCE_PRINCIPAL"
OperationTypesCreateIdentityConfig OperationTypesEnum = "CREATE_IDENTITY_CONFIG"
OperationTypesDeleteIdentityConfig OperationTypesEnum = "DELETE_IDENTITY_CONFIG"
OperationTypesUpdateIdentityConfig OperationTypesEnum = "UPDATE_IDENTITY_CONFIG"
OperationTypesActivateUpstConfig OperationTypesEnum = "ACTIVATE_UPST_CONFIG"
OperationTypesDeactivateUpstConfig OperationTypesEnum = "DEACTIVATE_UPST_CONFIG"
OperationTypesRefreshConfidentialApplication OperationTypesEnum = "REFRESH_CONFIDENTIAL_APPLICATION"
OperationTypesRefreshTokenExchangeKeytab OperationTypesEnum = "REFRESH_TOKEN_EXCHANGE_KEYTAB"
OperationTypesActivateIamUserSyncConfig OperationTypesEnum = "ACTIVATE_IAM_USER_SYNC_CONFIG"
OperationTypesDeactivateIamUserSyncConfig OperationTypesEnum = "DEACTIVATE_IAM_USER_SYNC_CONFIG"
)
func GetMappingOperationTypesEnum(val string) (OperationTypesEnum, bool)
GetMappingOperationTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypesEnumValues() []OperationTypesEnum
GetOperationTypesEnumValues Enumerates the set of values for OperationTypesEnum
OsPatchDetails Details of an os patch.
type OsPatchDetails struct {
// Version of the os patch.
OsPatchVersion *string `mandatory:"true" json:"osPatchVersion"`
// Minimum BDS version required to install current OS patch.
MinBdsVersion *string `mandatory:"true" json:"minBdsVersion"`
// Map of major ODH version to minimum ODH version required to install current OS patch. e.g. {ODH0.9: 0.9.1}
MinCompatibleOdhVersionMap map[string]string `mandatory:"true" json:"minCompatibleOdhVersionMap"`
// List of summaries of individual target packages.
TargetPackages []OsPatchPackageSummary `mandatory:"true" json:"targetPackages"`
// Released date of the OS patch.
ReleaseDate *common.SDKTime `mandatory:"true" json:"releaseDate"`
// Type of a specific os patch.
// REGULAR means standard released os patches.
// CUSTOM means os patches with some customizations.
// EMERGENT means os patches with some emergency fixes that should be prioritized.
PatchType OsPatchDetailsPatchTypeEnum `mandatory:"true" json:"patchType"`
}
func (m OsPatchDetails) String() string
func (m OsPatchDetails) 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
OsPatchDetailsPatchTypeEnum Enum with underlying type: string
type OsPatchDetailsPatchTypeEnum string
Set of constants representing the allowable values for OsPatchDetailsPatchTypeEnum
const (
OsPatchDetailsPatchTypeRegular OsPatchDetailsPatchTypeEnum = "REGULAR"
OsPatchDetailsPatchTypeCustom OsPatchDetailsPatchTypeEnum = "CUSTOM"
OsPatchDetailsPatchTypeEmergent OsPatchDetailsPatchTypeEnum = "EMERGENT"
)
func GetMappingOsPatchDetailsPatchTypeEnum(val string) (OsPatchDetailsPatchTypeEnum, bool)
GetMappingOsPatchDetailsPatchTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOsPatchDetailsPatchTypeEnumValues() []OsPatchDetailsPatchTypeEnum
GetOsPatchDetailsPatchTypeEnumValues Enumerates the set of values for OsPatchDetailsPatchTypeEnum
OsPatchPackageSummary Summary of a package contained in a os patch.
type OsPatchPackageSummary struct {
// The package's name.
PackageName *string `mandatory:"true" json:"packageName"`
// The action that current package will be executed on the cluster.
UpdateType OsPatchPackageSummaryUpdateTypeEnum `mandatory:"true" json:"updateType"`
// Related CVEs of the package update.
RelatedCVEs []string `mandatory:"true" json:"relatedCVEs"`
// The target version of the package.
TargetVersion *string `mandatory:"false" json:"targetVersion"`
}
func (m OsPatchPackageSummary) String() string
func (m OsPatchPackageSummary) 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
OsPatchPackageSummaryUpdateTypeEnum Enum with underlying type: string
type OsPatchPackageSummaryUpdateTypeEnum string
Set of constants representing the allowable values for OsPatchPackageSummaryUpdateTypeEnum
const (
OsPatchPackageSummaryUpdateTypeInstall OsPatchPackageSummaryUpdateTypeEnum = "INSTALL"
OsPatchPackageSummaryUpdateTypeRemove OsPatchPackageSummaryUpdateTypeEnum = "REMOVE"
OsPatchPackageSummaryUpdateTypeUpdate OsPatchPackageSummaryUpdateTypeEnum = "UPDATE"
)
func GetMappingOsPatchPackageSummaryUpdateTypeEnum(val string) (OsPatchPackageSummaryUpdateTypeEnum, bool)
GetMappingOsPatchPackageSummaryUpdateTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOsPatchPackageSummaryUpdateTypeEnumValues() []OsPatchPackageSummaryUpdateTypeEnum
GetOsPatchPackageSummaryUpdateTypeEnumValues Enumerates the set of values for OsPatchPackageSummaryUpdateTypeEnum
OsPatchSummary Summary of an available os patch to a cluster.
type OsPatchSummary struct {
// Patch version of the os patch.
OsPatchVersion *string `mandatory:"true" json:"osPatchVersion"`
// The time when the OS patch was released.
ReleaseDate *common.SDKTime `mandatory:"true" json:"releaseDate"`
}
func (m OsPatchSummary) String() string
func (m OsPatchSummary) 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
PatchHistorySummary Patch history of this cluster.
type PatchHistorySummary struct {
// The version of the patch.
Version *string `mandatory:"true" json:"version"`
// The status of this patch.
LifecycleState PatchHistorySummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time when the patch history was last updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The type of current patch history.
// DP - Data Plane patch(This history type is internal available only)
// ODH - Oracle Distribution of Hadoop patch
// OS - Operating System patch
PatchType PatchHistorySummaryPatchTypeEnum `mandatory:"true" json:"patchType"`
}
func (m PatchHistorySummary) String() string
func (m PatchHistorySummary) 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
PatchHistorySummaryLifecycleStateEnum Enum with underlying type: string
type PatchHistorySummaryLifecycleStateEnum string
Set of constants representing the allowable values for PatchHistorySummaryLifecycleStateEnum
const (
PatchHistorySummaryLifecycleStateInstalling PatchHistorySummaryLifecycleStateEnum = "INSTALLING"
PatchHistorySummaryLifecycleStateInstalled PatchHistorySummaryLifecycleStateEnum = "INSTALLED"
PatchHistorySummaryLifecycleStateFailed PatchHistorySummaryLifecycleStateEnum = "FAILED"
)
func GetMappingPatchHistorySummaryLifecycleStateEnum(val string) (PatchHistorySummaryLifecycleStateEnum, bool)
GetMappingPatchHistorySummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchHistorySummaryLifecycleStateEnumValues() []PatchHistorySummaryLifecycleStateEnum
GetPatchHistorySummaryLifecycleStateEnumValues Enumerates the set of values for PatchHistorySummaryLifecycleStateEnum
PatchHistorySummaryPatchTypeEnum Enum with underlying type: string
type PatchHistorySummaryPatchTypeEnum string
Set of constants representing the allowable values for PatchHistorySummaryPatchTypeEnum
const (
PatchHistorySummaryPatchTypeOdh PatchHistorySummaryPatchTypeEnum = "ODH"
PatchHistorySummaryPatchTypeOs PatchHistorySummaryPatchTypeEnum = "OS"
)
func GetMappingPatchHistorySummaryPatchTypeEnum(val string) (PatchHistorySummaryPatchTypeEnum, bool)
GetMappingPatchHistorySummaryPatchTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchHistorySummaryPatchTypeEnumValues() []PatchHistorySummaryPatchTypeEnum
GetPatchHistorySummaryPatchTypeEnumValues Enumerates the set of values for PatchHistorySummaryPatchTypeEnum
PatchSummary The patch that is currently available for the cluster.
type PatchSummary struct {
// The version of the patch.
Version *string `mandatory:"true" json:"version"`
// The time when the patch was released.
TimeReleased *common.SDKTime `mandatory:"true" json:"timeReleased"`
}
func (m PatchSummary) String() string
func (m PatchSummary) 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
PatchingConfigs Detailed configurations for defining the behavior when installing os patches. If not provided, nodes will be patched and rebooted AD/FD by AD/FD for regular patches or will be patched with down time if the patch is an emergent patch.
type PatchingConfigs interface {
}
PatchingConfigsPatchingConfigStrategyEnum Enum with underlying type: string
type PatchingConfigsPatchingConfigStrategyEnum string
Set of constants representing the allowable values for PatchingConfigsPatchingConfigStrategyEnum
const (
PatchingConfigsPatchingConfigStrategyDowntimeBased PatchingConfigsPatchingConfigStrategyEnum = "DOWNTIME_BASED"
PatchingConfigsPatchingConfigStrategyBatchingBased PatchingConfigsPatchingConfigStrategyEnum = "BATCHING_BASED"
PatchingConfigsPatchingConfigStrategyDomainBased PatchingConfigsPatchingConfigStrategyEnum = "DOMAIN_BASED"
)
func GetMappingPatchingConfigsPatchingConfigStrategyEnum(val string) (PatchingConfigsPatchingConfigStrategyEnum, bool)
GetMappingPatchingConfigsPatchingConfigStrategyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchingConfigsPatchingConfigStrategyEnumValues() []PatchingConfigsPatchingConfigStrategyEnum
GetPatchingConfigsPatchingConfigStrategyEnumValues Enumerates the set of values for PatchingConfigsPatchingConfigStrategyEnum
RefreshConfidentialApplicationDetails Details for refreshing confidential application
type RefreshConfidentialApplicationDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m RefreshConfidentialApplicationDetails) String() string
func (m RefreshConfidentialApplicationDetails) 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
RefreshConfidentialApplicationRequest wrapper for the RefreshConfidentialApplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RefreshConfidentialApplication.go.html to see an example of how to use RefreshConfidentialApplicationRequest.
type RefreshConfidentialApplicationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The OCID of the identity configuration
IdentityConfigurationId *string `mandatory:"true" contributesTo:"path" name:"identityConfigurationId"`
// Details for refreshing confidential application
RefreshConfidentialApplicationDetails `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"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RefreshConfidentialApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RefreshConfidentialApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RefreshConfidentialApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RefreshConfidentialApplicationRequest) String() string
func (request RefreshConfidentialApplicationRequest) 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
RefreshConfidentialApplicationResponse wrapper for the RefreshConfidentialApplication operation
type RefreshConfidentialApplicationResponse 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"`
}
func (response RefreshConfidentialApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RefreshConfidentialApplicationResponse) String() string
RefreshUpstTokenExchangeKeytabDetails Details for refreshing User Principal Session (UPST) token exchange keytab
type RefreshUpstTokenExchangeKeytabDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m RefreshUpstTokenExchangeKeytabDetails) String() string
func (m RefreshUpstTokenExchangeKeytabDetails) 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
RefreshUpstTokenExchangeKeytabRequest wrapper for the RefreshUpstTokenExchangeKeytab operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RefreshUpstTokenExchangeKeytab.go.html to see an example of how to use RefreshUpstTokenExchangeKeytabRequest.
type RefreshUpstTokenExchangeKeytabRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The OCID of the identity configuration
IdentityConfigurationId *string `mandatory:"true" contributesTo:"path" name:"identityConfigurationId"`
// Details for refreshing User Principal Session (UPST) token exchange keytab
RefreshUpstTokenExchangeKeytabDetails `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"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RefreshUpstTokenExchangeKeytabRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RefreshUpstTokenExchangeKeytabRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RefreshUpstTokenExchangeKeytabRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RefreshUpstTokenExchangeKeytabRequest) String() string
func (request RefreshUpstTokenExchangeKeytabRequest) 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
RefreshUpstTokenExchangeKeytabResponse wrapper for the RefreshUpstTokenExchangeKeytab operation
type RefreshUpstTokenExchangeKeytabResponse 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"`
}
func (response RefreshUpstTokenExchangeKeytabResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RefreshUpstTokenExchangeKeytabResponse) String() string
RemoveAutoScalingConfigurationDetails The information about the removed autoscale configuration.
type RemoveAutoScalingConfigurationDetails struct {
// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m RemoveAutoScalingConfigurationDetails) String() string
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
RemoveAutoScalingConfigurationRequest wrapper for the RemoveAutoScalingConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RemoveAutoScalingConfiguration.go.html to see an example of how to use 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
}
func (request RemoveAutoScalingConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveAutoScalingConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveAutoScalingConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveAutoScalingConfigurationRequest) String() string
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
RemoveAutoScalingConfigurationResponse wrapper for the RemoveAutoScalingConfiguration operation
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"`
}
func (response RemoveAutoScalingConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveAutoScalingConfigurationResponse) String() string
RemoveCloudSqlDetails The information about the Cloud SQL installation that was removed.
type RemoveCloudSqlDetails struct {
// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m RemoveCloudSqlDetails) String() string
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
RemoveCloudSqlRequest wrapper for the RemoveCloudSql operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RemoveCloudSql.go.html to see an example of how to use 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
}
func (request RemoveCloudSqlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveCloudSqlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveCloudSqlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveCloudSqlRequest) String() string
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
RemoveCloudSqlResponse wrapper for the RemoveCloudSql operation
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"`
}
func (response RemoveCloudSqlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveCloudSqlResponse) String() string
RemoveKafkaDetails The information about the Kafka installation to be removed. All configured Kafka nodes are considered for removal.
type RemoveKafkaDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m RemoveKafkaDetails) String() string
func (m RemoveKafkaDetails) 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
RemoveKafkaRequest wrapper for the RemoveKafka operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RemoveKafka.go.html to see an example of how to use RemoveKafkaRequest.
type RemoveKafkaRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for the Kafka capability.
RemoveKafkaDetails `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
}
func (request RemoveKafkaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveKafkaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveKafkaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveKafkaRequest) String() string
func (request RemoveKafkaRequest) 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
RemoveKafkaResponse wrapper for the RemoveKafka operation
type RemoveKafkaResponse 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"`
}
func (response RemoveKafkaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveKafkaResponse) String() string
RemoveNodeDetails The information about node to be removed.
type RemoveNodeDetails struct {
// Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// OCID of the node to be removed.
NodeId *string `mandatory:"true" json:"nodeId"`
// Boolean flag specifying whether or not to force remove node if graceful
// removal fails.
IsForceRemoveEnabled *bool `mandatory:"false" json:"isForceRemoveEnabled"`
}
func (m RemoveNodeDetails) String() string
func (m RemoveNodeDetails) 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
RemoveNodeReplaceConfigurationDetails The information about the NodeReplaceConfiguration that being removed.
type RemoveNodeReplaceConfigurationDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m RemoveNodeReplaceConfigurationDetails) String() string
func (m RemoveNodeReplaceConfigurationDetails) 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
RemoveNodeReplaceConfigurationRequest wrapper for the RemoveNodeReplaceConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RemoveNodeReplaceConfiguration.go.html to see an example of how to use RemoveNodeReplaceConfigurationRequest.
type RemoveNodeReplaceConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique Oracle-assigned identifier of the NodeReplaceConfiguration.
NodeReplaceConfigurationId *string `mandatory:"true" contributesTo:"path" name:"nodeReplaceConfigurationId"`
// Details for removing NodeReplaceConfiguration
RemoveNodeReplaceConfigurationDetails `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
}
func (request RemoveNodeReplaceConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveNodeReplaceConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveNodeReplaceConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveNodeReplaceConfigurationRequest) String() string
func (request RemoveNodeReplaceConfigurationRequest) 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
RemoveNodeReplaceConfigurationResponse wrapper for the RemoveNodeReplaceConfiguration operation
type RemoveNodeReplaceConfigurationResponse 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"`
}
func (response RemoveNodeReplaceConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveNodeReplaceConfigurationResponse) String() string
RemoveNodeRequest wrapper for the RemoveNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RemoveNode.go.html to see an example of how to use RemoveNodeRequest.
type RemoveNodeRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for the node to be removed.
RemoveNodeDetails `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
}
func (request RemoveNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveNodeRequest) String() string
func (request RemoveNodeRequest) 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
RemoveNodeResponse wrapper for the RemoveNode operation
type RemoveNodeResponse 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"`
}
func (response RemoveNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveNodeResponse) String() string
RemoveResourcePrincipalConfigurationDetails Details of removing a resource principal configuration for the cluster.
type RemoveResourcePrincipalConfigurationDetails struct {
// Base-64 encoded Cluster Admin Password for cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m RemoveResourcePrincipalConfigurationDetails) String() string
func (m RemoveResourcePrincipalConfigurationDetails) 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
RemoveResourcePrincipalConfigurationRequest wrapper for the RemoveResourcePrincipalConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RemoveResourcePrincipalConfiguration.go.html to see an example of how to use RemoveResourcePrincipalConfigurationRequest.
type RemoveResourcePrincipalConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration.
ResourcePrincipalConfigurationId *string `mandatory:"true" contributesTo:"path" name:"resourcePrincipalConfigurationId"`
// Details of removing a resource principal for the bds cluster.
RemoveResourcePrincipalConfigurationDetails `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
}
func (request RemoveResourcePrincipalConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveResourcePrincipalConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveResourcePrincipalConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveResourcePrincipalConfigurationRequest) String() string
func (request RemoveResourcePrincipalConfigurationRequest) 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
RemoveResourcePrincipalConfigurationResponse wrapper for the RemoveResourcePrincipalConfiguration operation
type RemoveResourcePrincipalConfigurationResponse 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"`
}
func (response RemoveResourcePrincipalConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveResourcePrincipalConfigurationResponse) String() string
RenewCertificateDetails The request body info about renew certificate service list.
type RenewCertificateDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// List of services for which certificate needs to be renewed. If no services provided renew will happen only for default services - AMBARI,RANGER,HUE,LIVY.
Services []ServiceEnum `mandatory:"false" json:"services"`
// Plain text certificate/s in order, separated by new line character. If not provided in request a self-signed root certificate is generated inside the cluster. In case hostCertDetails is provided, root certificate is mandatory.
RootCertificate *string `mandatory:"false" json:"rootCertificate"`
// List of leaf certificates to use for services on each host. If custom host certificate is provided the root certificate becomes required.
HostCertDetails []HostCertDetails `mandatory:"false" json:"hostCertDetails"`
// Base-64 encoded password for CA certificate's private key. This value can be empty.
ServerKeyPassword *string `mandatory:"false" json:"serverKeyPassword"`
}
func (m RenewCertificateDetails) String() string
func (m RenewCertificateDetails) 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
RenewCertificateRequest wrapper for the RenewCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RenewCertificate.go.html to see an example of how to use RenewCertificateRequest.
type RenewCertificateRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for renewing certificate.
RenewCertificateDetails `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
}
func (request RenewCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RenewCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RenewCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RenewCertificateRequest) String() string
func (request RenewCertificateRequest) 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
RenewCertificateResponse wrapper for the RenewCertificate operation
type RenewCertificateResponse 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"`
}
func (response RenewCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RenewCertificateResponse) String() string
ReplaceNodeDetails The information about the node to be replaced.
type ReplaceNodeDetails struct {
// Host name of the node to replace. MASTER, UTILITY and EDGE node are only supported types
NodeHostName *string `mandatory:"true" json:"nodeHostName"`
// The id of the nodeBackup to use for replacing the node.
NodeBackupId *string `mandatory:"true" json:"nodeBackupId"`
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// Shape of the new vm when replacing the node. If not provided, BDS will attempt to replace the node with the shape of current node.
Shape *string `mandatory:"false" json:"shape"`
}
func (m ReplaceNodeDetails) String() string
func (m ReplaceNodeDetails) 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
ReplaceNodeRequest wrapper for the ReplaceNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/ReplaceNode.go.html to see an example of how to use ReplaceNodeRequest.
type ReplaceNodeRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Details for Replacing the node.
ReplaceNodeDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// This if-match is for the BdsInstance. 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
}
func (request ReplaceNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ReplaceNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ReplaceNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ReplaceNodeRequest) String() string
func (request ReplaceNodeRequest) 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
ReplaceNodeResponse wrapper for the ReplaceNode operation
type ReplaceNodeResponse 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"`
}
func (response ReplaceNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ReplaceNodeResponse) String() string
ResourcePrincipalConfiguration Resource Principal Session Token Details.
type ResourcePrincipalConfiguration struct {
// The id of the ResourcePrincipalConfiguration.
Id *string `mandatory:"true" json:"id"`
// The OCID of the bdsInstance which is the parent resource id.
BdsInstanceId *string `mandatory:"true" json:"bdsInstanceId"`
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Life span in hours of each resource principal session token.
SessionTokenLifeSpanDurationInHours *int `mandatory:"true" json:"sessionTokenLifeSpanDurationInHours"`
// The state of the ResourcePrincipalConfiguration.
LifecycleState ResourcePrincipalConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the ResourcePrincipalConfiguration was created, shown as an RFC 3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the ResourcePrincipalConfiguration was updated, shown as an RFC 3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// the time the resource principal session token was refreshed, shown as an rfc 3339 formatted datetime string.
TimeTokenRefreshed *common.SDKTime `mandatory:"false" json:"timeTokenRefreshed"`
// the time the resource principal session token will expired, shown as an rfc 3339 formatted datetime string.
TimeTokenExpiry *common.SDKTime `mandatory:"false" json:"timeTokenExpiry"`
}
func (m ResourcePrincipalConfiguration) String() string
func (m ResourcePrincipalConfiguration) 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
ResourcePrincipalConfigurationLifecycleStateEnum Enum with underlying type: string
type ResourcePrincipalConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for ResourcePrincipalConfigurationLifecycleStateEnum
const (
ResourcePrincipalConfigurationLifecycleStateCreating ResourcePrincipalConfigurationLifecycleStateEnum = "CREATING"
ResourcePrincipalConfigurationLifecycleStateActive ResourcePrincipalConfigurationLifecycleStateEnum = "ACTIVE"
ResourcePrincipalConfigurationLifecycleStateUpdating ResourcePrincipalConfigurationLifecycleStateEnum = "UPDATING"
ResourcePrincipalConfigurationLifecycleStateDeleting ResourcePrincipalConfigurationLifecycleStateEnum = "DELETING"
ResourcePrincipalConfigurationLifecycleStateDeleted ResourcePrincipalConfigurationLifecycleStateEnum = "DELETED"
ResourcePrincipalConfigurationLifecycleStateFailed ResourcePrincipalConfigurationLifecycleStateEnum = "FAILED"
)
func GetMappingResourcePrincipalConfigurationLifecycleStateEnum(val string) (ResourcePrincipalConfigurationLifecycleStateEnum, bool)
GetMappingResourcePrincipalConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResourcePrincipalConfigurationLifecycleStateEnumValues() []ResourcePrincipalConfigurationLifecycleStateEnum
GetResourcePrincipalConfigurationLifecycleStateEnumValues Enumerates the set of values for ResourcePrincipalConfigurationLifecycleStateEnum
ResourcePrincipalConfigurationSummary Resource Principal Session Token Details.
type ResourcePrincipalConfigurationSummary struct {
// the ID of the ResourcePrincipalConfiguration.
Id *string `mandatory:"true" json:"id"`
// the OCID of the bdsInstance which is the parent resource id.
BdsInstanceId *string `mandatory:"true" json:"bdsInstanceId"`
// a user-friendly name. only ascii alphanumeric characters with no spaces allowed. 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 ResourcePrincipalConfiguration.
LifecycleState ResourcePrincipalConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// the time the ResourcePrincipalConfiguration was created, shown as an rfc 3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// the time the ResourcePrincipalConfiguration was updated, shown as an rfc 3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// the time the resource principal session token was refreshed, shown as an rfc 3339 formatted datetime string.
TimeTokenRefreshed *common.SDKTime `mandatory:"false" json:"timeTokenRefreshed"`
// the time the resource principal session token will expired, shown as an rfc 3339 formatted datetime string.
TimeTokenExpiry *common.SDKTime `mandatory:"false" json:"timeTokenExpiry"`
}
func (m ResourcePrincipalConfigurationSummary) String() string
func (m ResourcePrincipalConfigurationSummary) 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
RestartNodeDetails The information about restarted node.
type RestartNodeDetails struct {
// OCID of the node to be restarted.
NodeId *string `mandatory:"true" json:"nodeId"`
}
func (m RestartNodeDetails) String() string
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
RestartNodeRequest wrapper for the RestartNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/RestartNode.go.html to see an example of how to use 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
}
func (request RestartNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestartNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestartNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestartNodeRequest) String() string
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
RestartNodeResponse wrapper for the RestartNode operation
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"`
}
func (response RestartNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestartNodeResponse) String() string
ScheduleBasedHorizontalScalingPolicyDetails Details of a schedule based horizontal autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.
type ScheduleBasedHorizontalScalingPolicyDetails struct {
// The time zone of the execution schedule, in IANA time zone database name format
Timezone *string `mandatory:"false" json:"timezone"`
// Details of a horizontal scaling schedule.
ScheduleDetails []HorizontalScalingScheduleDetails `mandatory:"false" json:"scheduleDetails"`
// The type of autoscaling trigger.
TriggerType AutoScalePolicyDetailsTriggerTypeEnum `mandatory:"true" json:"triggerType"`
// The type of autoscaling action to take.
ActionType AutoScalePolicyDetailsActionTypeEnum `mandatory:"true" json:"actionType"`
}
func (m ScheduleBasedHorizontalScalingPolicyDetails) GetActionType() AutoScalePolicyDetailsActionTypeEnum
GetActionType returns ActionType
func (m ScheduleBasedHorizontalScalingPolicyDetails) GetTriggerType() AutoScalePolicyDetailsTriggerTypeEnum
GetTriggerType returns TriggerType
func (m ScheduleBasedHorizontalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ScheduleBasedHorizontalScalingPolicyDetails) String() string
func (m *ScheduleBasedHorizontalScalingPolicyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ScheduleBasedHorizontalScalingPolicyDetails) 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
ScheduleBasedVerticalScalingPolicyDetails Details of a schedule based vertical autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.
type ScheduleBasedVerticalScalingPolicyDetails struct {
// The time zone of the execution schedule, in IANA time zone database name format
Timezone *string `mandatory:"false" json:"timezone"`
// Details of a vertical scaling schedule.
ScheduleDetails []VerticalScalingScheduleDetails `mandatory:"false" json:"scheduleDetails"`
// The type of autoscaling trigger.
TriggerType AutoScalePolicyDetailsTriggerTypeEnum `mandatory:"true" json:"triggerType"`
// The type of autoscaling action to take.
ActionType AutoScalePolicyDetailsActionTypeEnum `mandatory:"true" json:"actionType"`
}
func (m ScheduleBasedVerticalScalingPolicyDetails) GetActionType() AutoScalePolicyDetailsActionTypeEnum
GetActionType returns ActionType
func (m ScheduleBasedVerticalScalingPolicyDetails) GetTriggerType() AutoScalePolicyDetailsTriggerTypeEnum
GetTriggerType returns TriggerType
func (m ScheduleBasedVerticalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ScheduleBasedVerticalScalingPolicyDetails) String() string
func (m *ScheduleBasedVerticalScalingPolicyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ScheduleBasedVerticalScalingPolicyDetails) 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
ScheduleTypeEnum Enum with underlying type: string
type ScheduleTypeEnum string
Set of constants representing the allowable values for ScheduleTypeEnum
const (
ScheduleTypeDayBased ScheduleTypeEnum = "DAY_BASED"
)
func GetMappingScheduleTypeEnum(val string) (ScheduleTypeEnum, bool)
GetMappingScheduleTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleTypeEnumValues() []ScheduleTypeEnum
GetScheduleTypeEnumValues Enumerates the set of values for ScheduleTypeEnum
ServiceEnum Enum with underlying type: string
type ServiceEnum string
Set of constants representing the allowable values for ServiceEnum
const (
ServiceZookeeper ServiceEnum = "ZOOKEEPER"
ServiceAms ServiceEnum = "AMS"
ServiceHdfs ServiceEnum = "HDFS"
ServiceYarn ServiceEnum = "YARN"
ServiceMapreduce ServiceEnum = "MAPREDUCE"
ServiceOozie ServiceEnum = "OOZIE"
ServiceHbase ServiceEnum = "HBASE"
ServiceSpark ServiceEnum = "SPARK"
ServiceHive ServiceEnum = "HIVE"
ServiceKafka ServiceEnum = "KAFKA"
ServiceFlink ServiceEnum = "FLINK"
ServiceRegistry ServiceEnum = "REGISTRY"
)
func GetMappingServiceEnum(val string) (ServiceEnum, bool)
GetMappingServiceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetServiceEnumValues() []ServiceEnum
GetServiceEnumValues Enumerates the set of values for ServiceEnum
ShapeConfigDetails The shape configuration requested for the node.
type ShapeConfigDetails struct {
// The total number of OCPUs available to the node.
Ocpus *int `mandatory:"false" json:"ocpus"`
// The total amount of memory available to the node, in gigabytes.
MemoryInGBs *int `mandatory:"false" json:"memoryInGBs"`
// The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
Nvmes *int `mandatory:"false" json:"nvmes"`
}
func (m ShapeConfigDetails) String() string
func (m ShapeConfigDetails) 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
SortOrdersEnum Enum with underlying type: string
type SortOrdersEnum string
Set of constants representing the allowable values for SortOrdersEnum
const (
SortOrdersAsc SortOrdersEnum = "ASC"
SortOrdersDesc SortOrdersEnum = "DESC"
)
func GetMappingSortOrdersEnum(val string) (SortOrdersEnum, bool)
GetMappingSortOrdersEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrdersEnumValues() []SortOrdersEnum
GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum
StartBdsInstanceDetails The request body for starting a BDS cluster.
type StartBdsInstanceDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
StartClusterShapeConfigs *StartClusterShapeConfigs `mandatory:"false" json:"startClusterShapeConfigs"`
}
func (m StartBdsInstanceDetails) String() string
func (m StartBdsInstanceDetails) 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
StartBdsInstanceRequest wrapper for the StartBdsInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/StartBdsInstance.go.html to see an example of how to use StartBdsInstanceRequest.
type StartBdsInstanceRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Parameters for starting a cluster
StartBdsInstanceDetails `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
}
func (request StartBdsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartBdsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartBdsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartBdsInstanceRequest) String() string
func (request StartBdsInstanceRequest) 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
StartBdsInstanceResponse wrapper for the StartBdsInstance operation
type StartBdsInstanceResponse 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"`
}
func (response StartBdsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartBdsInstanceResponse) String() string
StartClusterShapeConfigs The shape configuration to be used to start the cluster. If the value is not set, the start cluster operation will try to start the cluster as is.
type StartClusterShapeConfigs struct {
// Shape configurations for each node type.
NodeTypeShapeConfigs []NodeTypeShapeConfig `mandatory:"true" json:"nodeTypeShapeConfigs"`
}
func (m StartClusterShapeConfigs) String() string
func (m StartClusterShapeConfigs) 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
StopBdsInstanceDetails The request body for stopping a BDS cluster.
type StopBdsInstanceDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
// Boolean indicating whether to force stop jobs while stopping cluster. Defaults to false.
IsForceStopJobs *bool `mandatory:"false" json:"isForceStopJobs"`
}
func (m StopBdsInstanceDetails) String() string
func (m StopBdsInstanceDetails) 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
StopBdsInstanceRequest wrapper for the StopBdsInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/StopBdsInstance.go.html to see an example of how to use StopBdsInstanceRequest.
type StopBdsInstanceRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Parameters for stopping a cluster
StopBdsInstanceDetails `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
}
func (request StopBdsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopBdsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopBdsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopBdsInstanceRequest) String() string
func (request StopBdsInstanceRequest) 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
StopBdsInstanceResponse wrapper for the StopBdsInstance operation
type StopBdsInstanceResponse 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"`
}
func (response StopBdsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopBdsInstanceResponse) String() string
TestBdsMetastoreConfigurationDetails The reqeust body when testing a BDS metastore configuration
type TestBdsMetastoreConfigurationDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
}
func (m TestBdsMetastoreConfigurationDetails) String() string
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
TestBdsMetastoreConfigurationRequest wrapper for the TestBdsMetastoreConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/TestBdsMetastoreConfiguration.go.html to see an example of how to use 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
}
func (request TestBdsMetastoreConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request TestBdsMetastoreConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request TestBdsMetastoreConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request TestBdsMetastoreConfigurationRequest) String() string
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
TestBdsMetastoreConfigurationResponse wrapper for the TestBdsMetastoreConfiguration operation
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"`
}
func (response TestBdsMetastoreConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response TestBdsMetastoreConfigurationResponse) String() string
TestBdsObjectStorageConnectionDetails Test access to specified Object Storage bucket using the API key.
type TestBdsObjectStorageConnectionDetails struct {
// An Oracle Cloud Infrastructure URI to which this connection must be attempted. See https://docs.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"`
}
func (m TestBdsObjectStorageConnectionDetails) String() string
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
TestBdsObjectStorageConnectionRequest wrapper for the TestBdsObjectStorageConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/TestBdsObjectStorageConnection.go.html to see an example of how to use 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
}
func (request TestBdsObjectStorageConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request TestBdsObjectStorageConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request TestBdsObjectStorageConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request TestBdsObjectStorageConnectionRequest) String() string
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
TestBdsObjectStorageConnectionResponse wrapper for the TestBdsObjectStorageConnection operation
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"`
}
func (response TestBdsObjectStorageConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response TestBdsObjectStorageConnectionResponse) String() string
TimeAndHorizontalScalingConfig Time of day and horizontal scaling configuration.
type TimeAndHorizontalScalingConfig struct {
// Day/time recurrence (specified following RFC 5545) at which to trigger autoscaling action. Currently only WEEKLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR and BYMINUTE fields. Other fields are not supported.
TimeRecurrence *string `mandatory:"false" json:"timeRecurrence"`
// This value is the desired number of nodes in the cluster.
TargetNodeCount *int `mandatory:"false" json:"targetNodeCount"`
}
func (m TimeAndHorizontalScalingConfig) String() string
func (m TimeAndHorizontalScalingConfig) 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
TimeAndVerticalScalingConfig Time of day and vertical scaling configuration.
type TimeAndVerticalScalingConfig struct {
// Day/time recurrence (specified following RFC 5545) at which to trigger autoscaling action. Currently only WEEKLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR and BYMINUTE fields. Other fields are not supported.
TimeRecurrence *string `mandatory:"false" json:"timeRecurrence"`
// For nodes with fixed compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the desired shape of each node. This value is not used for nodes with flexible compute shapes.
TargetShape *string `mandatory:"false" json:"targetShape"`
// For nodes with flexible compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the desired OCPUs count on each node. This value is not used for nodes with fixed compute shapes.
TargetOcpusPerNode *int `mandatory:"false" json:"targetOcpusPerNode"`
// For nodes with flexible compute shapes (https://docs.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the desired memory in GBs on each node. This value is not used for nodes with fixed compute shapes.
TargetMemoryPerNode *int `mandatory:"false" json:"targetMemoryPerNode"`
}
func (m TimeAndVerticalScalingConfig) String() string
func (m TimeAndVerticalScalingConfig) 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
UpdateAutoScalePolicyDetails Update details of an autoscaling policy.
type UpdateAutoScalePolicyDetails interface {
}
UpdateAutoScalingConfigurationDetails The information about the autoscale configuration.
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"`
PolicyDetails UpdateAutoScalePolicyDetails `mandatory:"false" json:"policyDetails"`
}
func (m UpdateAutoScalingConfigurationDetails) String() string
func (m *UpdateAutoScalingConfigurationDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
UpdateAutoScalingConfigurationRequest wrapper for the UpdateAutoScalingConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateAutoScalingConfiguration.go.html to see an example of how to use 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
}
func (request UpdateAutoScalingConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAutoScalingConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAutoScalingConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAutoScalingConfigurationRequest) String() string
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
UpdateAutoScalingConfigurationResponse wrapper for the UpdateAutoScalingConfiguration operation
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"`
}
func (response UpdateAutoScalingConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAutoScalingConfigurationResponse) String() string
UpdateBdsInstanceDetails The information about to-be-updated Big Data Service cluster.
type UpdateBdsInstanceDetails struct {
// Name of the cluster.
DisplayName *string `mandatory:"false" json:"displayName"`
// Pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed..
BootstrapScriptUrl *string `mandatory:"false" json:"bootstrapScriptUrl"`
// 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"`
// The OCID of the Key Management master encryption key.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
NetworkConfig *NetworkConfig `mandatory:"false" json:"networkConfig"`
}
func (m UpdateBdsInstanceDetails) String() string
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
UpdateBdsInstanceRequest wrapper for the UpdateBdsInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateBdsInstance.go.html to see an example of how to use 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
}
func (request UpdateBdsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBdsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBdsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBdsInstanceRequest) String() string
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
UpdateBdsInstanceResponse wrapper for the UpdateBdsInstance operation
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"`
}
func (response UpdateBdsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBdsInstanceResponse) String() string
UpdateBdsMetastoreConfigurationDetails The request body when updating BDS metastore configuration.
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"`
}
func (m UpdateBdsMetastoreConfigurationDetails) String() string
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
UpdateBdsMetastoreConfigurationRequest wrapper for the UpdateBdsMetastoreConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateBdsMetastoreConfiguration.go.html to see an example of how to use 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
}
func (request UpdateBdsMetastoreConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBdsMetastoreConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBdsMetastoreConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBdsMetastoreConfigurationRequest) String() string
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
UpdateBdsMetastoreConfigurationResponse wrapper for the UpdateBdsMetastoreConfiguration operation
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"`
}
func (response UpdateBdsMetastoreConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBdsMetastoreConfigurationResponse) String() string
UpdateIdentityConfigurationDetails Details for updating identity config on the cluster
type UpdateIdentityConfigurationDetails struct {
// Base-64 encoded password for the cluster admin user.
ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`
UpstConfigurationDetails *UpstConfigurationDetails `mandatory:"false" json:"upstConfigurationDetails"`
IamUserSyncConfigurationDetails *IamUserSyncConfigurationDetails `mandatory:"false" json:"iamUserSyncConfigurationDetails"`
}
func (m UpdateIdentityConfigurationDetails) String() string
func (m UpdateIdentityConfigurationDetails) 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
UpdateIdentityConfigurationRequest wrapper for the UpdateIdentityConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateIdentityConfiguration.go.html to see an example of how to use UpdateIdentityConfigurationRequest.
type UpdateIdentityConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// The OCID of the identity configuration
IdentityConfigurationId *string `mandatory:"true" contributesTo:"path" name:"identityConfigurationId"`
// Details for updating an identity configuration
UpdateIdentityConfigurationDetails `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"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateIdentityConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateIdentityConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateIdentityConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateIdentityConfigurationRequest) String() string
func (request UpdateIdentityConfigurationRequest) 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
UpdateIdentityConfigurationResponse wrapper for the UpdateIdentityConfiguration operation
type UpdateIdentityConfigurationResponse 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"`
}
func (response UpdateIdentityConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateIdentityConfigurationResponse) String() string
UpdateMetricBasedHorizontalScalingPolicyDetails Update details of a metric based horizontal autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.
type UpdateMetricBasedHorizontalScalingPolicyDetails struct {
ScaleOutConfig *MetricBasedHorizontalScaleOutConfig `mandatory:"false" json:"scaleOutConfig"`
ScaleInConfig *MetricBasedHorizontalScaleInConfig `mandatory:"false" json:"scaleInConfig"`
}
func (m UpdateMetricBasedHorizontalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateMetricBasedHorizontalScalingPolicyDetails) String() string
func (m UpdateMetricBasedHorizontalScalingPolicyDetails) 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
UpdateMetricBasedVerticalScalingPolicyDetails Update details of a metric based vertical autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.
type UpdateMetricBasedVerticalScalingPolicyDetails struct {
ScaleUpConfig *MetricBasedVerticalScaleUpConfig `mandatory:"false" json:"scaleUpConfig"`
ScaleDownConfig *MetricBasedVerticalScaleDownConfig `mandatory:"false" json:"scaleDownConfig"`
}
func (m UpdateMetricBasedVerticalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateMetricBasedVerticalScalingPolicyDetails) String() string
func (m UpdateMetricBasedVerticalScalingPolicyDetails) 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
UpdateNodeBackupConfigurationDetails The information about the NodeBackupConfiguration that is being updated.
type UpdateNodeBackupConfigurationDetails struct {
LevelTypeDetails LevelTypeDetails `mandatory:"false" json:"levelTypeDetails"`
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The time zone of the execution schedule, in IANA time zone database name format
Timezone *string `mandatory:"false" json:"timezone"`
// Day/time recurrence (specified following RFC 5545) at which to trigger the backup process. Currently only DAILY, WEEKLY and MONTHLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR. Other fields are not supported.
Schedule *string `mandatory:"false" json:"schedule"`
// Number of backup copies to retain.
NumberOfBackupsToRetain *int `mandatory:"false" json:"numberOfBackupsToRetain"`
// Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created.
BackupType NodeBackupBackupTypeEnum `mandatory:"false" json:"backupType,omitempty"`
}
func (m UpdateNodeBackupConfigurationDetails) String() string
func (m *UpdateNodeBackupConfigurationDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateNodeBackupConfigurationDetails) 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
UpdateNodeBackupConfigurationRequest wrapper for the UpdateNodeBackupConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateNodeBackupConfiguration.go.html to see an example of how to use UpdateNodeBackupConfigurationRequest.
type UpdateNodeBackupConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique Oracle-assigned identifier of the NodeBackupConfiguration.
NodeBackupConfigurationId *string `mandatory:"true" contributesTo:"path" name:"nodeBackupConfigurationId"`
// Details for updating the NodeBackupConfiguration.
UpdateNodeBackupConfigurationDetails `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
}
func (request UpdateNodeBackupConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateNodeBackupConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateNodeBackupConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateNodeBackupConfigurationRequest) String() string
func (request UpdateNodeBackupConfigurationRequest) 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
UpdateNodeBackupConfigurationResponse wrapper for the UpdateNodeBackupConfiguration operation
type UpdateNodeBackupConfigurationResponse 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"`
}
func (response UpdateNodeBackupConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateNodeBackupConfigurationResponse) String() string
UpdateNodeReplaceConfigurationDetails The information about the NodeReplaceConfiguration
type UpdateNodeReplaceConfigurationDetails struct {
LevelTypeDetails LevelTypeDetails `mandatory:"false" json:"levelTypeDetails"`
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Type of compute instance health metric to use for node replacement
MetricType NodeReplaceConfigurationMetricTypeEnum `mandatory:"false" json:"metricType,omitempty"`
// This value is the pending duration time to wait for metric emission before triggering node replacement. The value is in minutes.
DurationInMinutes *int `mandatory:"false" json:"durationInMinutes"`
}
func (m UpdateNodeReplaceConfigurationDetails) String() string
func (m *UpdateNodeReplaceConfigurationDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateNodeReplaceConfigurationDetails) 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
UpdateNodeReplaceConfigurationRequest wrapper for the UpdateNodeReplaceConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateNodeReplaceConfiguration.go.html to see an example of how to use UpdateNodeReplaceConfigurationRequest.
type UpdateNodeReplaceConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique Oracle-assigned identifier of the NodeReplaceConfiguration.
NodeReplaceConfigurationId *string `mandatory:"true" contributesTo:"path" name:"nodeReplaceConfigurationId"`
// Details for updating the nodeReplaceConfiguration.
UpdateNodeReplaceConfigurationDetails `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
}
func (request UpdateNodeReplaceConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateNodeReplaceConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateNodeReplaceConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateNodeReplaceConfigurationRequest) String() string
func (request UpdateNodeReplaceConfigurationRequest) 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
UpdateNodeReplaceConfigurationResponse wrapper for the UpdateNodeReplaceConfiguration operation
type UpdateNodeReplaceConfigurationResponse 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"`
}
func (response UpdateNodeReplaceConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateNodeReplaceConfigurationResponse) String() string
UpdateResourcePrincipalConfigurationDetails Details of updating the resource principal configuration for the cluster.
type UpdateResourcePrincipalConfigurationDetails struct {
// A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Life span in hours for the resource principal session token.
SessionTokenLifeSpanDurationInHours *int `mandatory:"false" json:"sessionTokenLifeSpanDurationInHours"`
}
func (m UpdateResourcePrincipalConfigurationDetails) String() string
func (m UpdateResourcePrincipalConfigurationDetails) 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
UpdateResourcePrincipalConfigurationRequest wrapper for the UpdateResourcePrincipalConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bds/UpdateResourcePrincipalConfiguration.go.html to see an example of how to use UpdateResourcePrincipalConfigurationRequest.
type UpdateResourcePrincipalConfigurationRequest struct {
// The OCID of the cluster.
BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`
// Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration.
ResourcePrincipalConfigurationId *string `mandatory:"true" contributesTo:"path" name:"resourcePrincipalConfigurationId"`
// Details for updating the resourcePrincipalConfiguration.
UpdateResourcePrincipalConfigurationDetails `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
}
func (request UpdateResourcePrincipalConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateResourcePrincipalConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateResourcePrincipalConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateResourcePrincipalConfigurationRequest) String() string
func (request UpdateResourcePrincipalConfigurationRequest) 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
UpdateResourcePrincipalConfigurationResponse wrapper for the UpdateResourcePrincipalConfiguration operation
type UpdateResourcePrincipalConfigurationResponse 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"`
}
func (response UpdateResourcePrincipalConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateResourcePrincipalConfigurationResponse) String() string
UpdateScheduleBasedHorizontalScalingPolicyDetails Update details of a schedule based horizontal autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.
type UpdateScheduleBasedHorizontalScalingPolicyDetails struct {
// The time zone of the execution schedule, in IANA time zone database name format
Timezone *string `mandatory:"false" json:"timezone"`
// Details of a horizontal scaling schedule.
ScheduleDetails []HorizontalScalingScheduleDetails `mandatory:"false" json:"scheduleDetails"`
}
func (m UpdateScheduleBasedHorizontalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateScheduleBasedHorizontalScalingPolicyDetails) String() string
func (m *UpdateScheduleBasedHorizontalScalingPolicyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateScheduleBasedHorizontalScalingPolicyDetails) 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
UpdateScheduleBasedVerticalScalingPolicyDetails Update details of a schedule based vertical autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.
type UpdateScheduleBasedVerticalScalingPolicyDetails struct {
// The time zone of the execution schedule, in IANA time zone database name format
Timezone *string `mandatory:"false" json:"timezone"`
// Details of a vertical scaling schedule.
ScheduleDetails []VerticalScalingScheduleDetails `mandatory:"false" json:"scheduleDetails"`
}
func (m UpdateScheduleBasedVerticalScalingPolicyDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateScheduleBasedVerticalScalingPolicyDetails) String() string
func (m *UpdateScheduleBasedVerticalScalingPolicyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateScheduleBasedVerticalScalingPolicyDetails) 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
UpstConfiguration Information about the UPST configuration.
type UpstConfiguration struct {
// The instance OCID of the node, which is the resource from which the node backup was acquired.
VaultId *string `mandatory:"true" json:"vaultId"`
// Master Encryption key used for encrypting token exchange keytab.
MasterEncryptionKeyId *string `mandatory:"true" json:"masterEncryptionKeyId"`
// Secret ID for token exchange keytab
SecretId *string `mandatory:"true" json:"secretId"`
// Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string.
TimeTokenExchangeKeytabLastRefreshed *common.SDKTime `mandatory:"true" json:"timeTokenExchangeKeytabLastRefreshed"`
// Lifecycle state of the UPST config
LifecycleState UpstConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Time when this UPST config was created, shown as an RFC 3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The kerberos keytab content used for creating identity propagation trust config, in base64 format
KeytabContent *string `mandatory:"true" json:"keytabContent"`
// Token exchange kerberos Principal name in cluster
TokenExchangePrincipalName *string `mandatory:"false" json:"tokenExchangePrincipalName"`
}
func (m UpstConfiguration) String() string
func (m UpstConfiguration) 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
UpstConfigurationDetails Details for activating/updating UPST config on the cluster
type UpstConfigurationDetails struct {
// OCID of the vault to store token exchange service principal keyta, required for activating UPST config
VaultId *string `mandatory:"false" json:"vaultId"`
// OCID of the master encryption key in vault for encrypting token exchange service principal keytab, required for activating UPST config
MasterEncryptionKeyId *string `mandatory:"false" json:"masterEncryptionKeyId"`
}
func (m UpstConfigurationDetails) String() string
func (m UpstConfigurationDetails) 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
UpstConfigurationLifecycleStateEnum Enum with underlying type: string
type UpstConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for UpstConfigurationLifecycleStateEnum
const (
UpstConfigurationLifecycleStateCreating UpstConfigurationLifecycleStateEnum = "CREATING"
UpstConfigurationLifecycleStateActive UpstConfigurationLifecycleStateEnum = "ACTIVE"
UpstConfigurationLifecycleStateDeleting UpstConfigurationLifecycleStateEnum = "DELETING"
UpstConfigurationLifecycleStateInactive UpstConfigurationLifecycleStateEnum = "INACTIVE"
UpstConfigurationLifecycleStateUpdating UpstConfigurationLifecycleStateEnum = "UPDATING"
UpstConfigurationLifecycleStateFailed UpstConfigurationLifecycleStateEnum = "FAILED"
)
func GetMappingUpstConfigurationLifecycleStateEnum(val string) (UpstConfigurationLifecycleStateEnum, bool)
GetMappingUpstConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpstConfigurationLifecycleStateEnumValues() []UpstConfigurationLifecycleStateEnum
GetUpstConfigurationLifecycleStateEnumValues Enumerates the set of values for UpstConfigurationLifecycleStateEnum
VerticalScalingScheduleDetails Details of a vertical scaling schedule.
type VerticalScalingScheduleDetails interface {
}
VolumeAttachmentDetail A detail of the attached block volume.
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"`
}
func (m VolumeAttachmentDetail) String() string
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
WorkRequest Description of the work request status.
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"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. 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 occurred, shown as an RFC 3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from the execution of a work request.
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"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted 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"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly