...

Package bds

import "github.com/oracle/oci-go-sdk/bds"
Overview
Index

Overview ▾

Index ▾

type ActionTypesEnum
    func GetActionTypesEnumValues() []ActionTypesEnum
type AddBlockStorageDetails
    func (m AddBlockStorageDetails) String() string
type AddBlockStorageRequest
    func (request AddBlockStorageRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request AddBlockStorageRequest) RetryPolicy() *common.RetryPolicy
    func (request AddBlockStorageRequest) String() string
type AddBlockStorageResponse
    func (response AddBlockStorageResponse) HTTPResponse() *http.Response
    func (response AddBlockStorageResponse) String() string
type AddCloudSqlDetails
    func (m AddCloudSqlDetails) String() string
type AddCloudSqlRequest
    func (request AddCloudSqlRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request AddCloudSqlRequest) RetryPolicy() *common.RetryPolicy
    func (request AddCloudSqlRequest) String() string
type AddCloudSqlResponse
    func (response AddCloudSqlResponse) HTTPResponse() *http.Response
    func (response AddCloudSqlResponse) String() string
type AddWorkerNodesDetails
    func (m AddWorkerNodesDetails) String() string
type AddWorkerNodesRequest
    func (request AddWorkerNodesRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request AddWorkerNodesRequest) RetryPolicy() *common.RetryPolicy
    func (request AddWorkerNodesRequest) String() string
type AddWorkerNodesResponse
    func (response AddWorkerNodesResponse) HTTPResponse() *http.Response
    func (response AddWorkerNodesResponse) String() string
type BdsClient
    func NewBdsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client BdsClient, err error)
    func NewBdsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client BdsClient, err error)
    func (client BdsClient) AddBlockStorage(ctx context.Context, request AddBlockStorageRequest) (response AddBlockStorageResponse, err error)
    func (client BdsClient) AddCloudSql(ctx context.Context, request AddCloudSqlRequest) (response AddCloudSqlResponse, err error)
    func (client BdsClient) AddWorkerNodes(ctx context.Context, request AddWorkerNodesRequest) (response AddWorkerNodesResponse, err error)
    func (client BdsClient) ChangeBdsInstanceCompartment(ctx context.Context, request ChangeBdsInstanceCompartmentRequest) (response ChangeBdsInstanceCompartmentResponse, err error)
    func (client BdsClient) ChangeShape(ctx context.Context, request ChangeShapeRequest) (response ChangeShapeResponse, err error)
    func (client *BdsClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client BdsClient) CreateBdsInstance(ctx context.Context, request CreateBdsInstanceRequest) (response CreateBdsInstanceResponse, err error)
    func (client BdsClient) DeleteBdsInstance(ctx context.Context, request DeleteBdsInstanceRequest) (response DeleteBdsInstanceResponse, err error)
    func (client BdsClient) GetBdsInstance(ctx context.Context, request GetBdsInstanceRequest) (response GetBdsInstanceResponse, err error)
    func (client BdsClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
    func (client BdsClient) ListBdsInstances(ctx context.Context, request ListBdsInstancesRequest) (response ListBdsInstancesResponse, err error)
    func (client BdsClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
    func (client BdsClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
    func (client BdsClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
    func (client BdsClient) RemoveCloudSql(ctx context.Context, request RemoveCloudSqlRequest) (response RemoveCloudSqlResponse, err error)
    func (client BdsClient) RestartNode(ctx context.Context, request RestartNodeRequest) (response RestartNodeResponse, err error)
    func (client *BdsClient) SetRegion(region string)
    func (client BdsClient) UpdateBdsInstance(ctx context.Context, request UpdateBdsInstanceRequest) (response UpdateBdsInstanceResponse, err error)
type BdsInstance
    func (m BdsInstance) String() string
type BdsInstanceClusterVersionEnum
    func GetBdsInstanceClusterVersionEnumValues() []BdsInstanceClusterVersionEnum
type BdsInstanceLifecycleStateEnum
    func GetBdsInstanceLifecycleStateEnumValues() []BdsInstanceLifecycleStateEnum
type BdsInstanceSummary
    func (m BdsInstanceSummary) String() string
type ChangeBdsInstanceCompartmentDetails
    func (m ChangeBdsInstanceCompartmentDetails) String() string
type ChangeBdsInstanceCompartmentRequest
    func (request ChangeBdsInstanceCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeBdsInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeBdsInstanceCompartmentRequest) String() string
type ChangeBdsInstanceCompartmentResponse
    func (response ChangeBdsInstanceCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeBdsInstanceCompartmentResponse) String() string
type ChangeShapeDetails
    func (m ChangeShapeDetails) String() string
type ChangeShapeNodes
    func (m ChangeShapeNodes) String() string
type ChangeShapeRequest
    func (request ChangeShapeRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeShapeRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeShapeRequest) String() string
type ChangeShapeResponse
    func (response ChangeShapeResponse) HTTPResponse() *http.Response
    func (response ChangeShapeResponse) String() string
type CloudSqlDetails
    func (m CloudSqlDetails) String() string
type ClusterDetails
    func (m ClusterDetails) String() string
type CreateBdsInstanceDetails
    func (m CreateBdsInstanceDetails) String() string
type CreateBdsInstanceRequest
    func (request CreateBdsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateBdsInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateBdsInstanceRequest) String() string
type CreateBdsInstanceResponse
    func (response CreateBdsInstanceResponse) HTTPResponse() *http.Response
    func (response CreateBdsInstanceResponse) String() string
type CreateNodeDetails
    func (m CreateNodeDetails) String() string
type DefaultError
    func (m DefaultError) String() string
type DeleteBdsInstanceRequest
    func (request DeleteBdsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteBdsInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteBdsInstanceRequest) String() string
type DeleteBdsInstanceResponse
    func (response DeleteBdsInstanceResponse) HTTPResponse() *http.Response
    func (response DeleteBdsInstanceResponse) String() string
type GetBdsInstanceRequest
    func (request GetBdsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetBdsInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request GetBdsInstanceRequest) String() string
type GetBdsInstanceResponse
    func (response GetBdsInstanceResponse) HTTPResponse() *http.Response
    func (response GetBdsInstanceResponse) String() string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type KerberosDetails
    func (m KerberosDetails) String() string
type ListBdsInstancesRequest
    func (request ListBdsInstancesRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListBdsInstancesRequest) RetryPolicy() *common.RetryPolicy
    func (request ListBdsInstancesRequest) String() string
type ListBdsInstancesResponse
    func (response ListBdsInstancesResponse) HTTPResponse() *http.Response
    func (response ListBdsInstancesResponse) String() string
type ListBdsInstancesSortByEnum
    func GetListBdsInstancesSortByEnumValues() []ListBdsInstancesSortByEnum
type ListBdsInstancesSortOrderEnum
    func GetListBdsInstancesSortOrderEnumValues() []ListBdsInstancesSortOrderEnum
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestErrorsSortByEnum
    func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
type ListWorkRequestErrorsSortOrderEnum
    func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestLogsSortByEnum
    func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
type ListWorkRequestLogsSortOrderEnum
    func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type ListWorkRequestsSortByEnum
    func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
type ListWorkRequestsSortOrderEnum
    func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
type NetworkConfig
    func (m NetworkConfig) String() string
type Node
    func (m Node) String() string
type NodeLifecycleStateEnum
    func GetNodeLifecycleStateEnumValues() []NodeLifecycleStateEnum
type NodeNodeTypeEnum
    func GetNodeNodeTypeEnumValues() []NodeNodeTypeEnum
type OperationStatusEnum
    func GetOperationStatusEnumValues() []OperationStatusEnum
type OperationTypesEnum
    func GetOperationTypesEnumValues() []OperationTypesEnum
type RemoveCloudSqlDetails
    func (m RemoveCloudSqlDetails) String() string
type RemoveCloudSqlRequest
    func (request RemoveCloudSqlRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request RemoveCloudSqlRequest) RetryPolicy() *common.RetryPolicy
    func (request RemoveCloudSqlRequest) String() string
type RemoveCloudSqlResponse
    func (response RemoveCloudSqlResponse) HTTPResponse() *http.Response
    func (response RemoveCloudSqlResponse) String() string
type RestartNodeDetails
    func (m RestartNodeDetails) String() string
type RestartNodeRequest
    func (request RestartNodeRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request RestartNodeRequest) RetryPolicy() *common.RetryPolicy
    func (request RestartNodeRequest) String() string
type RestartNodeResponse
    func (response RestartNodeResponse) HTTPResponse() *http.Response
    func (response RestartNodeResponse) String() string
type SortOrdersEnum
    func GetSortOrdersEnumValues() []SortOrdersEnum
type UpdateBdsInstanceDetails
    func (m UpdateBdsInstanceDetails) String() string
type UpdateBdsInstanceRequest
    func (request UpdateBdsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateBdsInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateBdsInstanceRequest) String() string
type UpdateBdsInstanceResponse
    func (response UpdateBdsInstanceResponse) HTTPResponse() *http.Response
    func (response UpdateBdsInstanceResponse) String() string
type VolumeAttachmentDetail
    func (m VolumeAttachmentDetail) String() string
type WorkRequest
    func (m WorkRequest) String() string
type WorkRequestError
    func (m WorkRequestError) String() string
type WorkRequestLogEntry
    func (m WorkRequestLogEntry) String() string
type WorkRequestResource
    func (m WorkRequestResource) String() string

Package files

action_types.go add_block_storage_details.go add_block_storage_request_response.go add_cloud_sql_details.go add_cloud_sql_request_response.go add_worker_nodes_details.go add_worker_nodes_request_response.go bds_client.go bds_instance.go bds_instance_summary.go change_bds_instance_compartment_details.go change_bds_instance_compartment_request_response.go change_shape_details.go change_shape_nodes.go change_shape_request_response.go cloud_sql_details.go cluster_details.go create_bds_instance_details.go create_bds_instance_request_response.go create_node_details.go default_error.go delete_bds_instance_request_response.go get_bds_instance_request_response.go get_work_request_request_response.go kerberos_details.go list_bds_instances_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go network_config.go node.go operation_status.go operation_types.go remove_cloud_sql_details.go remove_cloud_sql_request_response.go restart_node_details.go restart_node_request_response.go sort_orders.go update_bds_instance_details.go update_bds_instance_request_response.go volume_attachment_detail.go work_request.go work_request_error.go work_request_log_entry.go work_request_resource.go

type ActionTypesEnum

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

func GetActionTypesEnumValues() []ActionTypesEnum

GetActionTypesEnumValues Enumerates the set of values for ActionTypesEnum

type AddBlockStorageDetails

AddBlockStorageDetails The information about additionally added block volumes

type AddBlockStorageDetails struct {

    // Base-64 encoded password for Cloudera Manager admin user
    ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

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

func (AddBlockStorageDetails) String

func (m AddBlockStorageDetails) String() string

type AddBlockStorageRequest

AddBlockStorageRequest wrapper for the AddBlockStorage operation

type AddBlockStorageRequest struct {

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

    // Details for the newly 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 (AddBlockStorageRequest) HTTPRequest

func (request AddBlockStorageRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AddBlockStorageRequest) RetryPolicy

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

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

func (AddBlockStorageRequest) String

func (request AddBlockStorageRequest) String() string

type AddBlockStorageResponse

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 particular request, please provide the 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 (AddBlockStorageResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (AddBlockStorageResponse) String

func (response AddBlockStorageResponse) String() string

type AddCloudSqlDetails

AddCloudSqlDetails The information about added Cloud SQL capability

type AddCloudSqlDetails struct {

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

    // Base-64 encoded password for Cloudera Manager admin user
    ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

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

func (AddCloudSqlDetails) String

func (m AddCloudSqlDetails) String() string

type AddCloudSqlRequest

AddCloudSqlRequest wrapper for the AddCloudSql operation

type AddCloudSqlRequest struct {

    // The OCID of the BDS instance
    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 (AddCloudSqlRequest) HTTPRequest

func (request AddCloudSqlRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AddCloudSqlRequest) RetryPolicy

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

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

func (AddCloudSqlRequest) String

func (request AddCloudSqlRequest) String() string

type AddCloudSqlResponse

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 particular request, please provide the 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 (AddCloudSqlResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (AddCloudSqlResponse) String

func (response AddCloudSqlResponse) String() string

type AddWorkerNodesDetails

AddWorkerNodesDetails The information about additionaly added nodes

type AddWorkerNodesDetails struct {

    // Base-64 encoded password for Cloudera Manager admin user
    ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

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

func (AddWorkerNodesDetails) String

func (m AddWorkerNodesDetails) String() string

type AddWorkerNodesRequest

AddWorkerNodesRequest wrapper for the AddWorkerNodes operation

type AddWorkerNodesRequest struct {

    // The OCID of the BDS instance
    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 (AddWorkerNodesRequest) HTTPRequest

func (request AddWorkerNodesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AddWorkerNodesRequest) RetryPolicy

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

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

func (AddWorkerNodesRequest) String

func (request AddWorkerNodesRequest) String() string

type AddWorkerNodesResponse

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 particular request, please provide the 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 (AddWorkerNodesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (AddWorkerNodesResponse) String

func (response AddWorkerNodesResponse) String() string

type BdsClient

BdsClient a client for Bds

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

func NewBdsClientWithConfigurationProvider

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

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

func NewBdsClientWithOboToken

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

NewBdsClientWithOboToken Creates a new default Bds client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (BdsClient) AddBlockStorage

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

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

func (BdsClient) AddCloudSql

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

AddCloudSql Adds Cloud SQL to your cluster. This will add a query server node to the cluster and create cell servers on all your worker nodes.

func (BdsClient) AddWorkerNodes

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

AddWorkerNodes Add worker nodes to an existing cluster. The worker nodes added will be based on an identical shape and have the same amount of attached block storage as other worker nodes in the cluster.

func (BdsClient) ChangeBdsInstanceCompartment

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

ChangeBdsInstanceCompartment Moves a BDS instance into a different compartment.

func (BdsClient) ChangeShape

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

ChangeShape Scale-up/down individial nodes (per role type) in the cluster. Customer can choose arbitrarty VM_STANDARD shape to scale-up/down the instance. Only VM_STANDARD nodes can be re-shaped.

func (*BdsClient) ConfigurationProvider

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

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

func (BdsClient) CreateBdsInstance

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

CreateBdsInstance Creates a new BDS instance.

func (BdsClient) DeleteBdsInstance

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

DeleteBdsInstance Deletes a BDS instance by identifier

func (BdsClient) GetBdsInstance

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

GetBdsInstance Gets a BDS instance by identifier

func (BdsClient) GetWorkRequest

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

GetWorkRequest Gets the status of the work request with the given ID.

func (BdsClient) ListBdsInstances

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

ListBdsInstances Returns a list of BDS instances.

func (BdsClient) ListWorkRequestErrors

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

ListWorkRequestErrors Return a (paginated) list of errors for a given work request.

func (BdsClient) ListWorkRequestLogs

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

ListWorkRequestLogs Return a (paginated) list of logs for a given work request.

func (BdsClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in a compartment.

func (BdsClient) RemoveCloudSql

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

RemoveCloudSql Remove Cloud SQL capability.

func (BdsClient) RestartNode

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

RestartNode Restarts a single node of a BDS instance.

func (*BdsClient) SetRegion

func (client *BdsClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (BdsClient) UpdateBdsInstance

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

UpdateBdsInstance Update the BDS instance identified by the id

type BdsInstance

BdsInstance Description of the BDS instance

type BdsInstance struct {

    // The OCID of the BDS resource
    Id *string `mandatory:"true" json:"id"`

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

    // Name of the BDS instance
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The state of the BDS instance
    LifecycleState BdsInstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

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

    // Boolean flag specifying whether we configure Cloud SQL or not
    IsCloudSqlConfigured *bool `mandatory:"true" json:"isCloudSqlConfigured"`

    // The list of nodes in the BDS instance
    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"`

    // Additional configuration of customer's network.
    NetworkConfig *NetworkConfig `mandatory:"false" json:"networkConfig"`

    // Specific info about a Hadoop cluster
    ClusterDetails *ClusterDetails `mandatory:"false" json:"clusterDetails"`

    // The information about added Cloud SQL capability
    CloudSqlDetails *CloudSqlDetails `mandatory:"false" json:"cloudSqlDetails"`

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

    // The time the BDS instance was created. An RFC3339 formatted datetime string
    TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

    // The time the BDS instance was updated. An RFC3339 formatted datetime string
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (BdsInstance) String

func (m BdsInstance) String() string

type BdsInstanceClusterVersionEnum

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

func GetBdsInstanceClusterVersionEnumValues

func GetBdsInstanceClusterVersionEnumValues() []BdsInstanceClusterVersionEnum

GetBdsInstanceClusterVersionEnumValues Enumerates the set of values for BdsInstanceClusterVersionEnum

type BdsInstanceLifecycleStateEnum

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"
    BdsInstanceLifecycleStateUpdatingInfra BdsInstanceLifecycleStateEnum = "UPDATING_INFRA"
    BdsInstanceLifecycleStateSuspending    BdsInstanceLifecycleStateEnum = "SUSPENDING"
    BdsInstanceLifecycleStateSuspended     BdsInstanceLifecycleStateEnum = "SUSPENDED"
    BdsInstanceLifecycleStateResuming      BdsInstanceLifecycleStateEnum = "RESUMING"
    BdsInstanceLifecycleStateDeleting      BdsInstanceLifecycleStateEnum = "DELETING"
    BdsInstanceLifecycleStateDeleted       BdsInstanceLifecycleStateEnum = "DELETED"
    BdsInstanceLifecycleStateFailed        BdsInstanceLifecycleStateEnum = "FAILED"
)

func GetBdsInstanceLifecycleStateEnumValues

func GetBdsInstanceLifecycleStateEnumValues() []BdsInstanceLifecycleStateEnum

GetBdsInstanceLifecycleStateEnumValues Enumerates the set of values for BdsInstanceLifecycleStateEnum

type BdsInstanceSummary

BdsInstanceSummary Summary of the BDS instance

type BdsInstanceSummary struct {

    // The OCID of the BDS resource
    Id *string `mandatory:"true" json:"id"`

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

    // Name of the BDS instance
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The state of the BDS instance
    LifecycleState BdsInstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

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

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

    // Boolean flag specifying whether we configure Cloud SQL or not
    IsCloudSqlConfigured *bool `mandatory:"true" json:"isCloudSqlConfigured"`

    // The time the BDS instance was created. An RFC3339 formatted datetime string
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

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

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (BdsInstanceSummary) String

func (m BdsInstanceSummary) String() string

type ChangeBdsInstanceCompartmentDetails

ChangeBdsInstanceCompartmentDetails Moves a BDS instance into a different compartment.

type ChangeBdsInstanceCompartmentDetails struct {

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

func (ChangeBdsInstanceCompartmentDetails) String

func (m ChangeBdsInstanceCompartmentDetails) String() string

type ChangeBdsInstanceCompartmentRequest

ChangeBdsInstanceCompartmentRequest wrapper for the ChangeBdsInstanceCompartment operation

type ChangeBdsInstanceCompartmentRequest struct {

    // The OCID of the BDS instance
    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 (ChangeBdsInstanceCompartmentRequest) HTTPRequest

func (request ChangeBdsInstanceCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeBdsInstanceCompartmentRequest) RetryPolicy

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

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

func (ChangeBdsInstanceCompartmentRequest) String

func (request ChangeBdsInstanceCompartmentRequest) String() string

type ChangeBdsInstanceCompartmentResponse

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

func (ChangeBdsInstanceCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeBdsInstanceCompartmentResponse) String

func (response ChangeBdsInstanceCompartmentResponse) String() string

type ChangeShapeDetails

ChangeShapeDetails The information about additionaly added nodes

type ChangeShapeDetails struct {

    // Base-64 encoded password for Cloudera Manager admin user
    ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

    // Inidividial worker nodes groups details
    Nodes *ChangeShapeNodes `mandatory:"true" json:"nodes"`
}

func (ChangeShapeDetails) String

func (m ChangeShapeDetails) String() string

type ChangeShapeNodes

ChangeShapeNodes The representation of ChangeShapeNodes

type ChangeShapeNodes struct {

    // worker nodes shape
    Worker *string `mandatory:"false" json:"worker"`

    // master nodes shape
    Master *string `mandatory:"false" json:"master"`

    // utility nodes shape
    Utility *string `mandatory:"false" json:"utility"`

    // cloudsql node shape
    Cloudsql *string `mandatory:"false" json:"cloudsql"`
}

func (ChangeShapeNodes) String

func (m ChangeShapeNodes) String() string

type ChangeShapeRequest

ChangeShapeRequest wrapper for the ChangeShape operation

type ChangeShapeRequest struct {

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

    // Details for the changed nodes 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 (ChangeShapeRequest) HTTPRequest

func (request ChangeShapeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeShapeRequest) RetryPolicy

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

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

func (ChangeShapeRequest) String

func (request ChangeShapeRequest) String() string

type ChangeShapeResponse

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 particular request, please provide the 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 (ChangeShapeResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeShapeResponse) String

func (response ChangeShapeResponse) String() string

type CloudSqlDetails

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 are Kerberos principals mapped
    // to database users.
    IsKerberosMappedToDatabaseUsers *bool `mandatory:"false" json:"isKerberosMappedToDatabaseUsers"`

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

func (CloudSqlDetails) String

func (m CloudSqlDetails) String() string

type ClusterDetails

ClusterDetails Specific info about a Hadoop cluster

type ClusterDetails struct {

    // The time the cluster was created. An RFC3339 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"`

    // 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 BDS instance was automatically, or manually refreshed.
    // An RFC3339 formatted datetime string
    TimeRefreshed *common.SDKTime `mandatory:"false" json:"timeRefreshed"`

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

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

    // The URL of a Hue Server
    HueServerUrl *string `mandatory:"false" json:"hueServerUrl"`
}

func (ClusterDetails) String

func (m ClusterDetails) String() string

type CreateBdsInstanceDetails

CreateBdsInstanceDetails The information about new BDS instance

type CreateBdsInstanceDetails struct {

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

    // Name of the BDS instance
    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 Cloudera Manager admin user
    ClusterAdminPassword *string `mandatory:"true" json:"clusterAdminPassword"`

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

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

    // The list of nodes in the BDS instance
    Nodes []CreateNodeDetails `mandatory:"true" json:"nodes"`

    // Additional configuration of customer's network.
    NetworkConfig *NetworkConfig `mandatory:"false" json:"networkConfig"`

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateBdsInstanceDetails) String

func (m CreateBdsInstanceDetails) String() string

type CreateBdsInstanceRequest

CreateBdsInstanceRequest wrapper for the CreateBdsInstance operation

type CreateBdsInstanceRequest struct {

    // Details for the new BDS instace.
    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 (CreateBdsInstanceRequest) HTTPRequest

func (request CreateBdsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBdsInstanceRequest) RetryPolicy

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

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

func (CreateBdsInstanceRequest) String

func (request CreateBdsInstanceRequest) String() string

type CreateBdsInstanceResponse

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 particular request, please provide the 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 (CreateBdsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateBdsInstanceResponse) String

func (response CreateBdsInstanceResponse) String() string

type CreateNodeDetails

CreateNodeDetails The information about new node

type CreateNodeDetails struct {

    // BDS instance 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 that needs to be attached to a given node.
    // All the necessary details needed for attachment are managed by service itself.
    BlockVolumeSizeInGBs *int64 `mandatory:"true" json:"blockVolumeSizeInGBs"`

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

func (CreateNodeDetails) String

func (m CreateNodeDetails) String() string

type DefaultError

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 (DefaultError) String

func (m DefaultError) String() string

type DeleteBdsInstanceRequest

DeleteBdsInstanceRequest wrapper for the DeleteBdsInstance operation

type DeleteBdsInstanceRequest struct {

    // The OCID of the BDS instance
    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 (DeleteBdsInstanceRequest) HTTPRequest

func (request DeleteBdsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBdsInstanceRequest) RetryPolicy

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

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

func (DeleteBdsInstanceRequest) String

func (request DeleteBdsInstanceRequest) String() string

type DeleteBdsInstanceResponse

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 particular request, please provide the 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 (DeleteBdsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteBdsInstanceResponse) String

func (response DeleteBdsInstanceResponse) String() string

type GetBdsInstanceRequest

GetBdsInstanceRequest wrapper for the GetBdsInstance operation

type GetBdsInstanceRequest struct {

    // The OCID of the BDS instance
    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 (GetBdsInstanceRequest) HTTPRequest

func (request GetBdsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBdsInstanceRequest) RetryPolicy

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

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

func (GetBdsInstanceRequest) String

func (request GetBdsInstanceRequest) String() string

type GetBdsInstanceResponse

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 particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

func (GetBdsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetBdsInstanceResponse) String

func (response GetBdsInstanceResponse) String() string

type GetWorkRequestRequest

GetWorkRequestRequest wrapper for the GetWorkRequest operation

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 (GetWorkRequestRequest) HTTPRequest

func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse

GetWorkRequestResponse wrapper for the GetWorkRequest operation

type GetWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

    // A 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 (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type KerberosDetails

KerberosDetails Details about 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 (KerberosDetails) String

func (m KerberosDetails) String() string

type ListBdsInstancesRequest

ListBdsInstancesRequest wrapper for the ListBdsInstances operation

type ListBdsInstancesRequest struct {

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

    // The state of the BDS instance.
    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 (ListBdsInstancesRequest) HTTPRequest

func (request ListBdsInstancesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBdsInstancesRequest) RetryPolicy

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

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

func (ListBdsInstancesRequest) String

func (request ListBdsInstancesRequest) String() string

type ListBdsInstancesResponse

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 particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then a partial list might have been returned. Include this value as the `page` parameter for the
    // subsequent GET request to get the next batch of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListBdsInstancesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListBdsInstancesResponse) String

func (response ListBdsInstancesResponse) String() string

type ListBdsInstancesSortByEnum

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

func GetListBdsInstancesSortByEnumValues() []ListBdsInstancesSortByEnum

GetListBdsInstancesSortByEnumValues Enumerates the set of values for ListBdsInstancesSortByEnum

type ListBdsInstancesSortOrderEnum

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

func GetListBdsInstancesSortOrderEnumValues() []ListBdsInstancesSortOrderEnum

GetListBdsInstancesSortOrderEnumValues Enumerates the set of values for ListBdsInstancesSortOrderEnum

type ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

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 (ListWorkRequestErrorsRequest) HTTPRequest

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse

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

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

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

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortOrderEnum

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

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

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 (ListWorkRequestLogsRequest) HTTPRequest

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse

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

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

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

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortOrderEnum

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

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

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 (ListWorkRequestsRequest) HTTPRequest

func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse

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 particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then a partial list might have been returned. Include this value as the `page` parameter for the
    // subsequent GET request to get the next batch of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

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

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

type ListWorkRequestsSortOrderEnum

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

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

type NetworkConfig

NetworkConfig Additional configuration of customer'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 (NetworkConfig) String

func (m NetworkConfig) String() string

type Node

Node Specific info about a node

type Node struct {

    // The OCID of the underlying 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"`

    // BDS instance 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 should 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 the node is running in
    AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

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

    // The time the node was created. An RFC3339 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 BDS instance was updated. An RFC3339 formatted datetime string
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

func (Node) String

func (m Node) String() string

type NodeLifecycleStateEnum

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"
    NodeLifecycleStateStopping NodeLifecycleStateEnum = "STOPPING"
    NodeLifecycleStateStarting NodeLifecycleStateEnum = "STARTING"
)

func GetNodeLifecycleStateEnumValues

func GetNodeLifecycleStateEnumValues() []NodeLifecycleStateEnum

GetNodeLifecycleStateEnumValues Enumerates the set of values for NodeLifecycleStateEnum

type NodeNodeTypeEnum

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"
    NodeNodeTypeBursting NodeNodeTypeEnum = "BURSTING"
    NodeNodeTypeCloudSql NodeNodeTypeEnum = "CLOUD_SQL"
)

func GetNodeNodeTypeEnumValues

func GetNodeNodeTypeEnumValues() []NodeNodeTypeEnum

GetNodeNodeTypeEnumValues Enumerates the set of values for NodeNodeTypeEnum

type OperationStatusEnum

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 GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypesEnum

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

func GetOperationTypesEnumValues

func GetOperationTypesEnumValues() []OperationTypesEnum

GetOperationTypesEnumValues Enumerates the set of values for OperationTypesEnum

type RemoveCloudSqlDetails

RemoveCloudSqlDetails The information about removed Cloud SQL capability

type RemoveCloudSqlDetails struct {

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

func (RemoveCloudSqlDetails) String

func (m RemoveCloudSqlDetails) String() string

type RemoveCloudSqlRequest

RemoveCloudSqlRequest wrapper for the RemoveCloudSql operation

type RemoveCloudSqlRequest struct {

    // The OCID of the BDS instance
    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"`

    // 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 (RemoveCloudSqlRequest) HTTPRequest

func (request RemoveCloudSqlRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RemoveCloudSqlRequest) RetryPolicy

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

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

func (RemoveCloudSqlRequest) String

func (request RemoveCloudSqlRequest) String() string

type RemoveCloudSqlResponse

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 particular request, please provide the 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 (RemoveCloudSqlResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (RemoveCloudSqlResponse) String

func (response RemoveCloudSqlResponse) String() string

type RestartNodeDetails

RestartNodeDetails The information about restarted node

type RestartNodeDetails struct {

    // OCID of the BDS node which should be restarted
    NodeId *string `mandatory:"true" json:"nodeId"`
}

func (RestartNodeDetails) String

func (m RestartNodeDetails) String() string

type RestartNodeRequest

RestartNodeRequest wrapper for the RestartNode operation

type RestartNodeRequest struct {

    // The OCID of the BDS instance
    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 (RestartNodeRequest) HTTPRequest

func (request RestartNodeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestartNodeRequest) RetryPolicy

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

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

func (RestartNodeRequest) String

func (request RestartNodeRequest) String() string

type RestartNodeResponse

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 particular request, please provide the 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 (RestartNodeResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (RestartNodeResponse) String

func (response RestartNodeResponse) String() string

type SortOrdersEnum

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 GetSortOrdersEnumValues

func GetSortOrdersEnumValues() []SortOrdersEnum

GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum

type UpdateBdsInstanceDetails

UpdateBdsInstanceDetails The information about to-be-updated BDS instance

type UpdateBdsInstanceDetails struct {

    // Name of the BDS instance
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateBdsInstanceDetails) String

func (m UpdateBdsInstanceDetails) String() string

type UpdateBdsInstanceRequest

UpdateBdsInstanceRequest wrapper for the UpdateBdsInstance operation

type UpdateBdsInstanceRequest struct {

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

    // Details for the to-be-updated BDS instace.
    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 (UpdateBdsInstanceRequest) HTTPRequest

func (request UpdateBdsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBdsInstanceRequest) RetryPolicy

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

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

func (UpdateBdsInstanceRequest) String

func (request UpdateBdsInstanceRequest) String() string

type UpdateBdsInstanceResponse

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

func (UpdateBdsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateBdsInstanceResponse) String

func (response UpdateBdsInstanceResponse) String() string

type VolumeAttachmentDetail

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 (VolumeAttachmentDetail) String

func (m VolumeAttachmentDetail) String() string

type WorkRequest

WorkRequest A description of workrequest 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"`

    // Type of the work request
    OperationType OperationTypesEnum `mandatory:"true" json:"operationType"`

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

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

    // Percentage of the request completed.
    PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

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

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

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

func (WorkRequest) String

func (m WorkRequest) String() string

type WorkRequestError

WorkRequestError An error encountered while executing a work request.

type WorkRequestError struct {

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

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

    // The time the error occured. An RFC3339 formatted datetime string.
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestError) String

func (m WorkRequestError) String() string

type WorkRequestLogEntry

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. An RFC3339 formatted datetime string
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

type WorkRequestResource

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 will remain in the IN_PROGRESS state until
    // work is complete for that resource at which point it will transition to CREATED, UPDATED,
    // or DELETED, respectively.
    ActionType 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 (WorkRequestResource) String

func (m WorkRequestResource) String() string