managedkafka

package
v65.101.0 Latest Latest
Warning

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

Go to latest
Published: Sep 23, 2025 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetKafkaClusterClusterTypeEnumStringValues

func GetKafkaClusterClusterTypeEnumStringValues() []string

GetKafkaClusterClusterTypeEnumStringValues Enumerates the set of values in String for KafkaClusterClusterTypeEnum

func GetKafkaClusterConfigLifecycleStateEnumStringValues

func GetKafkaClusterConfigLifecycleStateEnumStringValues() []string

GetKafkaClusterConfigLifecycleStateEnumStringValues Enumerates the set of values in String for KafkaClusterConfigLifecycleStateEnum

func GetKafkaClusterCoordinationTypeEnumStringValues

func GetKafkaClusterCoordinationTypeEnumStringValues() []string

GetKafkaClusterCoordinationTypeEnumStringValues Enumerates the set of values in String for KafkaClusterCoordinationTypeEnum

func GetKafkaClusterLifecycleStateEnumStringValues

func GetKafkaClusterLifecycleStateEnumStringValues() []string

GetKafkaClusterLifecycleStateEnumStringValues Enumerates the set of values in String for KafkaClusterLifecycleStateEnum

func GetListKafkaClusterConfigVersionsSortByEnumStringValues

func GetListKafkaClusterConfigVersionsSortByEnumStringValues() []string

GetListKafkaClusterConfigVersionsSortByEnumStringValues Enumerates the set of values in String for ListKafkaClusterConfigVersionsSortByEnum

func GetListKafkaClusterConfigVersionsSortOrderEnumStringValues

func GetListKafkaClusterConfigVersionsSortOrderEnumStringValues() []string

GetListKafkaClusterConfigVersionsSortOrderEnumStringValues Enumerates the set of values in String for ListKafkaClusterConfigVersionsSortOrderEnum

func GetListKafkaClusterConfigsSortByEnumStringValues

func GetListKafkaClusterConfigsSortByEnumStringValues() []string

GetListKafkaClusterConfigsSortByEnumStringValues Enumerates the set of values in String for ListKafkaClusterConfigsSortByEnum

func GetListKafkaClusterConfigsSortOrderEnumStringValues

func GetListKafkaClusterConfigsSortOrderEnumStringValues() []string

GetListKafkaClusterConfigsSortOrderEnumStringValues Enumerates the set of values in String for ListKafkaClusterConfigsSortOrderEnum

func GetListKafkaClustersSortByEnumStringValues

func GetListKafkaClustersSortByEnumStringValues() []string

GetListKafkaClustersSortByEnumStringValues Enumerates the set of values in String for ListKafkaClustersSortByEnum

func GetListKafkaClustersSortOrderEnumStringValues

func GetListKafkaClustersSortOrderEnumStringValues() []string

GetListKafkaClustersSortOrderEnumStringValues Enumerates the set of values in String for ListKafkaClustersSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

Types

type ActionTypeEnum

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type BootstrapUrl

type BootstrapUrl struct {

	// Name of the Kafka listener providing this bootstrap URL
	Name *string `mandatory:"true" json:"name"`

	// Bootstrap URL
	Url *string `mandatory:"true" json:"url"`
}

BootstrapUrl Kafka bootstrap URL

func (BootstrapUrl) String

func (m BootstrapUrl) String() string

func (BootstrapUrl) ValidateEnumValue

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

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

type BrokerShape

type BrokerShape struct {

	// Number of Kafka broker nodes
	NodeCount *int `mandatory:"true" json:"nodeCount"`

	// Number of OCPUs per nodes
	OcpuCount *int `mandatory:"true" json:"ocpuCount"`

	// Size of the storage per nodes.
	StorageSizeInGbs *int `mandatory:"false" json:"storageSizeInGbs"`
}

BrokerShape Configuration of the broker node.

func (BrokerShape) String

func (m BrokerShape) String() string

func (BrokerShape) ValidateEnumValue

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

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

type CancelWorkRequestRequest

type CancelWorkRequestRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

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

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.

func (CancelWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy

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

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

func (CancelWorkRequestRequest) String

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue

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

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

type CancelWorkRequestResponse

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

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String

func (response CancelWorkRequestResponse) String() string

type ChangeKafkaClusterCompartmentDetails

type ChangeKafkaClusterCompartmentDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the KafkaCluster to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeKafkaClusterCompartmentDetails The configuration details for the move operation.

func (ChangeKafkaClusterCompartmentDetails) String

func (ChangeKafkaClusterCompartmentDetails) ValidateEnumValue

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

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

type ChangeKafkaClusterCompartmentRequest

type ChangeKafkaClusterCompartmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster.
	KafkaClusterId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterId"`

	// The information to be updated.
	ChangeKafkaClusterCompartmentDetails `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"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

ChangeKafkaClusterCompartmentRequest wrapper for the ChangeKafkaClusterCompartment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ChangeKafkaClusterCompartment.go.html to see an example of how to use ChangeKafkaClusterCompartmentRequest.

func (ChangeKafkaClusterCompartmentRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeKafkaClusterCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeKafkaClusterCompartmentRequest) RetryPolicy

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

func (ChangeKafkaClusterCompartmentRequest) String

func (ChangeKafkaClusterCompartmentRequest) ValidateEnumValue

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

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

type ChangeKafkaClusterCompartmentResponse

type ChangeKafkaClusterCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	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"`
}

ChangeKafkaClusterCompartmentResponse wrapper for the ChangeKafkaClusterCompartment operation

func (ChangeKafkaClusterCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeKafkaClusterCompartmentResponse) String

type ChangeKafkaClusterConfigCompartmentDetails

type ChangeKafkaClusterConfigCompartmentDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the KafkaClusterConfig to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeKafkaClusterConfigCompartmentDetails The configuration details for the move operation.

func (ChangeKafkaClusterConfigCompartmentDetails) String

func (ChangeKafkaClusterConfigCompartmentDetails) ValidateEnumValue

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

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

type ChangeKafkaClusterConfigCompartmentRequest

type ChangeKafkaClusterConfigCompartmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	KafkaClusterConfigId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterConfigId"`

	// The information to be updated.
	ChangeKafkaClusterConfigCompartmentDetails `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"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

ChangeKafkaClusterConfigCompartmentRequest wrapper for the ChangeKafkaClusterConfigCompartment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ChangeKafkaClusterConfigCompartment.go.html to see an example of how to use ChangeKafkaClusterConfigCompartmentRequest.

func (ChangeKafkaClusterConfigCompartmentRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ChangeKafkaClusterConfigCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeKafkaClusterConfigCompartmentRequest) RetryPolicy

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

func (ChangeKafkaClusterConfigCompartmentRequest) String

func (ChangeKafkaClusterConfigCompartmentRequest) ValidateEnumValue

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

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

type ChangeKafkaClusterConfigCompartmentResponse

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

ChangeKafkaClusterConfigCompartmentResponse wrapper for the ChangeKafkaClusterConfigCompartment operation

func (ChangeKafkaClusterConfigCompartmentResponse) HTTPResponse

HTTPResponse implements the OCIResponse interface

func (ChangeKafkaClusterConfigCompartmentResponse) String

type CreateKafkaClusterConfigDetails

type CreateKafkaClusterConfigDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the KafkaClusterConfig in.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	LatestConfig *KafkaClusterConfigVersion `mandatory:"true" json:"latestConfig"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateKafkaClusterConfigDetails The data to create a KafkaClusterConfig.

func (CreateKafkaClusterConfigDetails) String

func (CreateKafkaClusterConfigDetails) ValidateEnumValue

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

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

type CreateKafkaClusterConfigRequest

type CreateKafkaClusterConfigRequest struct {

	// Details for the new KafkaClusterConfig.
	CreateKafkaClusterConfigDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of running 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 removed from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

CreateKafkaClusterConfigRequest wrapper for the CreateKafkaClusterConfig operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/CreateKafkaClusterConfig.go.html to see an example of how to use CreateKafkaClusterConfigRequest.

func (CreateKafkaClusterConfigRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateKafkaClusterConfigRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateKafkaClusterConfigRequest) RetryPolicy

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

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

func (CreateKafkaClusterConfigRequest) String

func (request CreateKafkaClusterConfigRequest) String() string

func (CreateKafkaClusterConfigRequest) ValidateEnumValue

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

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

type CreateKafkaClusterConfigResponse

type CreateKafkaClusterConfigResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

	// URL for the created kafkaCluster. The kafkaCluster OCID is generated after this request is sent.
	Location *string `presentIn:"header" name:"location"`

	// Same as location.
	ContentLocation *string `presentIn:"header" name:"content-location"`
}

CreateKafkaClusterConfigResponse wrapper for the CreateKafkaClusterConfig operation

func (CreateKafkaClusterConfigResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateKafkaClusterConfigResponse) String

func (response CreateKafkaClusterConfigResponse) String() string

type CreateKafkaClusterDetails

type CreateKafkaClusterDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the KafkaCluster in.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Subnets where broker/coordinator VNICs will be created.
	AccessSubnets []SubnetSet `mandatory:"true" json:"accessSubnets"`

	// Version of Kafka to use to spin up the cluster
	KafkaVersion *string `mandatory:"true" json:"kafkaVersion"`

	// Type of the cluster to spin up.
	// DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on single node
	// PRODUCTION - Minimum allowed broker count is 3
	ClusterType KafkaClusterClusterTypeEnum `mandatory:"true" json:"clusterType"`

	BrokerShape *BrokerShape `mandatory:"true" json:"brokerShape"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object
	ClusterConfigId *string `mandatory:"true" json:"clusterConfigId"`

	// The version of configuration object
	ClusterConfigVersion *int `mandatory:"true" json:"clusterConfigVersion"`

	// Kafka coordination type. Set of available types depends on Kafka version
	CoordinationType KafkaClusterCoordinationTypeEnum `mandatory:"true" json:"coordinationType"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// CA certificate bundle for mTLS broker authentication.
	ClientCertificateBundle *string `mandatory:"false" json:"clientCertificateBundle"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateKafkaClusterDetails The data to create a KafkaCluster.

func (CreateKafkaClusterDetails) String

func (m CreateKafkaClusterDetails) String() string

func (CreateKafkaClusterDetails) ValidateEnumValue

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

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

type CreateKafkaClusterRequest

type CreateKafkaClusterRequest struct {

	// Details for the new KafkaCluster.
	CreateKafkaClusterDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of running 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 removed from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

CreateKafkaClusterRequest wrapper for the CreateKafkaCluster operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/CreateKafkaCluster.go.html to see an example of how to use CreateKafkaClusterRequest.

func (CreateKafkaClusterRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateKafkaClusterRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateKafkaClusterRequest) RetryPolicy

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

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

func (CreateKafkaClusterRequest) String

func (request CreateKafkaClusterRequest) String() string

func (CreateKafkaClusterRequest) ValidateEnumValue

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

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

type CreateKafkaClusterResponse

type CreateKafkaClusterResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// URL for the created kafkaCluster. The kafkaCluster OCID is generated after this request is sent.
	Location *string `presentIn:"header" name:"location"`

	// Same as location.
	ContentLocation *string `presentIn:"header" name:"content-location"`

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	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"`
}

CreateKafkaClusterResponse wrapper for the CreateKafkaCluster operation

func (CreateKafkaClusterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateKafkaClusterResponse) String

func (response CreateKafkaClusterResponse) String() string

type DeleteKafkaClusterConfigRequest

type DeleteKafkaClusterConfigRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	KafkaClusterConfigId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterConfigId"`

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

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

DeleteKafkaClusterConfigRequest wrapper for the DeleteKafkaClusterConfig operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/DeleteKafkaClusterConfig.go.html to see an example of how to use DeleteKafkaClusterConfigRequest.

func (DeleteKafkaClusterConfigRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteKafkaClusterConfigRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteKafkaClusterConfigRequest) RetryPolicy

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

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

func (DeleteKafkaClusterConfigRequest) String

func (request DeleteKafkaClusterConfigRequest) String() string

func (DeleteKafkaClusterConfigRequest) ValidateEnumValue

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

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

type DeleteKafkaClusterConfigResponse

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

DeleteKafkaClusterConfigResponse wrapper for the DeleteKafkaClusterConfig operation

func (DeleteKafkaClusterConfigResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteKafkaClusterConfigResponse) String

func (response DeleteKafkaClusterConfigResponse) String() string

type DeleteKafkaClusterConfigVersionRequest

type DeleteKafkaClusterConfigVersionRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	KafkaClusterConfigId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterConfigId"`

	// The versionNumber of the KafkaClusterConfig.
	VersionNumber *int `mandatory:"true" contributesTo:"path" name:"versionNumber"`

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

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

DeleteKafkaClusterConfigVersionRequest wrapper for the DeleteKafkaClusterConfigVersion operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/DeleteKafkaClusterConfigVersion.go.html to see an example of how to use DeleteKafkaClusterConfigVersionRequest.

func (DeleteKafkaClusterConfigVersionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteKafkaClusterConfigVersionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteKafkaClusterConfigVersionRequest) RetryPolicy

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

func (DeleteKafkaClusterConfigVersionRequest) String

func (DeleteKafkaClusterConfigVersionRequest) ValidateEnumValue

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

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

type DeleteKafkaClusterConfigVersionResponse

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

DeleteKafkaClusterConfigVersionResponse wrapper for the DeleteKafkaClusterConfigVersion operation

func (DeleteKafkaClusterConfigVersionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteKafkaClusterConfigVersionResponse) String

type DeleteKafkaClusterRequest

type DeleteKafkaClusterRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster.
	KafkaClusterId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterId"`

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

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

DeleteKafkaClusterRequest wrapper for the DeleteKafkaCluster operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/DeleteKafkaCluster.go.html to see an example of how to use DeleteKafkaClusterRequest.

func (DeleteKafkaClusterRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteKafkaClusterRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteKafkaClusterRequest) RetryPolicy

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

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

func (DeleteKafkaClusterRequest) String

func (request DeleteKafkaClusterRequest) String() string

func (DeleteKafkaClusterRequest) ValidateEnumValue

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

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

type DeleteKafkaClusterResponse

type DeleteKafkaClusterResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	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"`
}

DeleteKafkaClusterResponse wrapper for the DeleteKafkaCluster operation

func (DeleteKafkaClusterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteKafkaClusterResponse) String

func (response DeleteKafkaClusterResponse) String() string

type DisableSuperuserRequest

type DisableSuperuserRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster.
	KafkaClusterId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterId"`

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

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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 running 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 removed 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
}

DisableSuperuserRequest wrapper for the DisableSuperuser operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/DisableSuperuser.go.html to see an example of how to use DisableSuperuserRequest.

func (DisableSuperuserRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DisableSuperuserRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DisableSuperuserRequest) RetryPolicy

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

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

func (DisableSuperuserRequest) String

func (request DisableSuperuserRequest) String() string

func (DisableSuperuserRequest) ValidateEnumValue

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

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

type DisableSuperuserResponse

type DisableSuperuserResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	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"`
}

DisableSuperuserResponse wrapper for the DisableSuperuser operation

func (DisableSuperuserResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DisableSuperuserResponse) String

func (response DisableSuperuserResponse) String() string

type EnableSuperuserDetails

type EnableSuperuserDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the superuser secret.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret that will be populated with the generated superuser password.
	SecretId *string `mandatory:"true" json:"secretId"`
}

EnableSuperuserDetails The configuration details for the enable superuser operation.

func (EnableSuperuserDetails) String

func (m EnableSuperuserDetails) String() string

func (EnableSuperuserDetails) ValidateEnumValue

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

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

type EnableSuperuserRequest

type EnableSuperuserRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster.
	KafkaClusterId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterId"`

	// The information to be updated.
	EnableSuperuserDetails `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"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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 running 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 removed 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
}

EnableSuperuserRequest wrapper for the EnableSuperuser operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/EnableSuperuser.go.html to see an example of how to use EnableSuperuserRequest.

func (EnableSuperuserRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (EnableSuperuserRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (EnableSuperuserRequest) RetryPolicy

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

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

func (EnableSuperuserRequest) String

func (request EnableSuperuserRequest) String() string

func (EnableSuperuserRequest) ValidateEnumValue

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

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

type EnableSuperuserResponse

type EnableSuperuserResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	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"`
}

EnableSuperuserResponse wrapper for the EnableSuperuser operation

func (EnableSuperuserResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (EnableSuperuserResponse) String

func (response EnableSuperuserResponse) String() string

type GetKafkaClusterConfigRequest

type GetKafkaClusterConfigRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	KafkaClusterConfigId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterConfigId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

GetKafkaClusterConfigRequest wrapper for the GetKafkaClusterConfig operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/GetKafkaClusterConfig.go.html to see an example of how to use GetKafkaClusterConfigRequest.

func (GetKafkaClusterConfigRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetKafkaClusterConfigRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetKafkaClusterConfigRequest) RetryPolicy

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

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

func (GetKafkaClusterConfigRequest) String

func (request GetKafkaClusterConfigRequest) String() string

func (GetKafkaClusterConfigRequest) ValidateEnumValue

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

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

type GetKafkaClusterConfigResponse

type GetKafkaClusterConfigResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetKafkaClusterConfigResponse wrapper for the GetKafkaClusterConfig operation

func (GetKafkaClusterConfigResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetKafkaClusterConfigResponse) String

func (response GetKafkaClusterConfigResponse) String() string

type GetKafkaClusterConfigVersionRequest

type GetKafkaClusterConfigVersionRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	KafkaClusterConfigId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterConfigId"`

	// The versionNumber of the KafkaClusterConfig.
	VersionNumber *int `mandatory:"true" contributesTo:"path" name:"versionNumber"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

GetKafkaClusterConfigVersionRequest wrapper for the GetKafkaClusterConfigVersion operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/GetKafkaClusterConfigVersion.go.html to see an example of how to use GetKafkaClusterConfigVersionRequest.

func (GetKafkaClusterConfigVersionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetKafkaClusterConfigVersionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetKafkaClusterConfigVersionRequest) RetryPolicy

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

func (GetKafkaClusterConfigVersionRequest) String

func (GetKafkaClusterConfigVersionRequest) ValidateEnumValue

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

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

type GetKafkaClusterConfigVersionResponse

type GetKafkaClusterConfigVersionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetKafkaClusterConfigVersionResponse wrapper for the GetKafkaClusterConfigVersion operation

func (GetKafkaClusterConfigVersionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetKafkaClusterConfigVersionResponse) String

func (response GetKafkaClusterConfigVersionResponse) String() string

type GetKafkaClusterRequest

type GetKafkaClusterRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster.
	KafkaClusterId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

GetKafkaClusterRequest wrapper for the GetKafkaCluster operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/GetKafkaCluster.go.html to see an example of how to use GetKafkaClusterRequest.

func (GetKafkaClusterRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetKafkaClusterRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetKafkaClusterRequest) RetryPolicy

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

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

func (GetKafkaClusterRequest) String

func (request GetKafkaClusterRequest) String() string

func (GetKafkaClusterRequest) ValidateEnumValue

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

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

type GetKafkaClusterResponse

type GetKafkaClusterResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetKafkaClusterResponse wrapper for the GetKafkaCluster operation

func (GetKafkaClusterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetKafkaClusterResponse) String

func (response GetKafkaClusterResponse) String() string

type GetWorkRequestRequest

type GetWorkRequestRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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

func (GetWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

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

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

type GetWorkRequestResponse

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type KafkaCluster

type KafkaCluster struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The date and time the KafkaCluster was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the KafkaCluster.
	LifecycleState KafkaClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Subnets where broker/coordinator VNICs will be created.
	AccessSubnets []SubnetSet `mandatory:"true" json:"accessSubnets"`

	// Version of Kafka to use to spin up the cluster
	KafkaVersion *string `mandatory:"true" json:"kafkaVersion"`

	// Type of the cluster to spin up.
	// DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on a single node
	// PRODUCTION - Minimum allowed broker count is 3
	ClusterType KafkaClusterClusterTypeEnum `mandatory:"true" json:"clusterType"`

	BrokerShape *BrokerShape `mandatory:"true" json:"brokerShape"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object
	ClusterConfigId *string `mandatory:"true" json:"clusterConfigId"`

	// The version of configuration object
	ClusterConfigVersion *int `mandatory:"true" json:"clusterConfigVersion"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// The date and time the KafkaCluster was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message that describes the current state of the KafkaCluster in more detail. For example,
	// can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// CA certificate bundle for mTLS broker authentication.
	ClientCertificateBundle *string `mandatory:"false" json:"clientCertificateBundle"`

	// Bootstrap URL that can be used to connect to Kafka
	KafkaBootstrapUrls []BootstrapUrl `mandatory:"false" json:"kafkaBootstrapUrls"`

	// Kafka coordination type. Set of available types depends on Kafka version
	CoordinationType KafkaClusterCoordinationTypeEnum `mandatory:"false" json:"coordinationType,omitempty"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret that contains superuser password.
	SecretId *string `mandatory:"false" json:"secretId"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

KafkaCluster A KafkaCluster is a description of a KafkaCluster. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

func (KafkaCluster) String

func (m KafkaCluster) String() string

func (KafkaCluster) ValidateEnumValue

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

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

type KafkaClusterClient

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

KafkaClusterClient a client for KafkaCluster

func NewKafkaClusterClientWithConfigurationProvider

func NewKafkaClusterClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client KafkaClusterClient, err error)

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

func NewKafkaClusterClientWithOboToken

func NewKafkaClusterClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client KafkaClusterClient, err error)

NewKafkaClusterClientWithOboToken Creates a new default KafkaCluster 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 (KafkaClusterClient) CancelWorkRequest

func (client KafkaClusterClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)

CancelWorkRequest Cancels a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()

func (KafkaClusterClient) ChangeKafkaClusterCompartment

func (client KafkaClusterClient) ChangeKafkaClusterCompartment(ctx context.Context, request ChangeKafkaClusterCompartmentRequest) (response ChangeKafkaClusterCompartmentResponse, err error)

ChangeKafkaClusterCompartment Moves a KafkaCluster into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ChangeKafkaClusterCompartment.go.html to see an example of how to use ChangeKafkaClusterCompartment API. A default retry strategy applies to this operation ChangeKafkaClusterCompartment()

func (KafkaClusterClient) ChangeKafkaClusterConfigCompartment

func (client KafkaClusterClient) ChangeKafkaClusterConfigCompartment(ctx context.Context, request ChangeKafkaClusterConfigCompartmentRequest) (response ChangeKafkaClusterConfigCompartmentResponse, err error)

ChangeKafkaClusterConfigCompartment Moves a KafkaClusterConfig into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ChangeKafkaClusterConfigCompartment.go.html to see an example of how to use ChangeKafkaClusterConfigCompartment API. A default retry strategy applies to this operation ChangeKafkaClusterConfigCompartment()

func (*KafkaClusterClient) ConfigurationProvider

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

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

func (KafkaClusterClient) CreateKafkaCluster

func (client KafkaClusterClient) CreateKafkaCluster(ctx context.Context, request CreateKafkaClusterRequest) (response CreateKafkaClusterResponse, err error)

CreateKafkaCluster Creates a KafkaCluster.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/CreateKafkaCluster.go.html to see an example of how to use CreateKafkaCluster API. A default retry strategy applies to this operation CreateKafkaCluster()

func (KafkaClusterClient) CreateKafkaClusterConfig

func (client KafkaClusterClient) CreateKafkaClusterConfig(ctx context.Context, request CreateKafkaClusterConfigRequest) (response CreateKafkaClusterConfigResponse, err error)

CreateKafkaClusterConfig Creates a KafkaClusterConfig.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/CreateKafkaClusterConfig.go.html to see an example of how to use CreateKafkaClusterConfig API. A default retry strategy applies to this operation CreateKafkaClusterConfig()

func (KafkaClusterClient) DeleteKafkaCluster

func (client KafkaClusterClient) DeleteKafkaCluster(ctx context.Context, request DeleteKafkaClusterRequest) (response DeleteKafkaClusterResponse, err error)

DeleteKafkaCluster Deletes a KafkaCluster.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/DeleteKafkaCluster.go.html to see an example of how to use DeleteKafkaCluster API. A default retry strategy applies to this operation DeleteKafkaCluster()

func (KafkaClusterClient) DeleteKafkaClusterConfig

func (client KafkaClusterClient) DeleteKafkaClusterConfig(ctx context.Context, request DeleteKafkaClusterConfigRequest) (response DeleteKafkaClusterConfigResponse, err error)

DeleteKafkaClusterConfig Deletes a KafkaClusterConfig.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/DeleteKafkaClusterConfig.go.html to see an example of how to use DeleteKafkaClusterConfig API. A default retry strategy applies to this operation DeleteKafkaClusterConfig()

func (KafkaClusterClient) DeleteKafkaClusterConfigVersion

func (client KafkaClusterClient) DeleteKafkaClusterConfigVersion(ctx context.Context, request DeleteKafkaClusterConfigVersionRequest) (response DeleteKafkaClusterConfigVersionResponse, err error)

DeleteKafkaClusterConfigVersion Deletes a KafkaClusterConfig version.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/DeleteKafkaClusterConfigVersion.go.html to see an example of how to use DeleteKafkaClusterConfigVersion API. A default retry strategy applies to this operation DeleteKafkaClusterConfigVersion()

func (KafkaClusterClient) DisableSuperuser

func (client KafkaClusterClient) DisableSuperuser(ctx context.Context, request DisableSuperuserRequest) (response DisableSuperuserResponse, err error)

DisableSuperuser Removes the SASL superuser to the Kafka cluster.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/DisableSuperuser.go.html to see an example of how to use DisableSuperuser API. A default retry strategy applies to this operation DisableSuperuser()

func (KafkaClusterClient) EnableSuperuser

func (client KafkaClusterClient) EnableSuperuser(ctx context.Context, request EnableSuperuserRequest) (response EnableSuperuserResponse, err error)

EnableSuperuser Adds a SASL superuser to the Kafka cluster. A generated password will be updated to the specified vault.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/EnableSuperuser.go.html to see an example of how to use EnableSuperuser API. A default retry strategy applies to this operation EnableSuperuser()

func (KafkaClusterClient) GetKafkaCluster

func (client KafkaClusterClient) GetKafkaCluster(ctx context.Context, request GetKafkaClusterRequest) (response GetKafkaClusterResponse, err error)

GetKafkaCluster Gets information about a KafkaCluster.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/GetKafkaCluster.go.html to see an example of how to use GetKafkaCluster API. A default retry strategy applies to this operation GetKafkaCluster()

func (KafkaClusterClient) GetKafkaClusterConfig

func (client KafkaClusterClient) GetKafkaClusterConfig(ctx context.Context, request GetKafkaClusterConfigRequest) (response GetKafkaClusterConfigResponse, err error)

GetKafkaClusterConfig Gets information about a KafkaClusterConfig.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/GetKafkaClusterConfig.go.html to see an example of how to use GetKafkaClusterConfig API. A default retry strategy applies to this operation GetKafkaClusterConfig()

func (KafkaClusterClient) GetKafkaClusterConfigVersion

func (client KafkaClusterClient) GetKafkaClusterConfigVersion(ctx context.Context, request GetKafkaClusterConfigVersionRequest) (response GetKafkaClusterConfigVersionResponse, err error)

GetKafkaClusterConfigVersion Gets information about a KafkaClusterConfig version.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/GetKafkaClusterConfigVersion.go.html to see an example of how to use GetKafkaClusterConfigVersion API. A default retry strategy applies to this operation GetKafkaClusterConfigVersion()

func (KafkaClusterClient) GetWorkRequest

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

GetWorkRequest Gets the details of a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

func (KafkaClusterClient) ListKafkaClusterConfigVersions

func (client KafkaClusterClient) ListKafkaClusterConfigVersions(ctx context.Context, request ListKafkaClusterConfigVersionsRequest) (response ListKafkaClusterConfigVersionsResponse, err error)

ListKafkaClusterConfigVersions Gets a list of KafkaClusterConfig Versions.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListKafkaClusterConfigVersions.go.html to see an example of how to use ListKafkaClusterConfigVersions API. A default retry strategy applies to this operation ListKafkaClusterConfigVersions()

func (KafkaClusterClient) ListKafkaClusterConfigs

func (client KafkaClusterClient) ListKafkaClusterConfigs(ctx context.Context, request ListKafkaClusterConfigsRequest) (response ListKafkaClusterConfigsResponse, err error)

ListKafkaClusterConfigs Gets a list of KafkaClusterConfigs.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListKafkaClusterConfigs.go.html to see an example of how to use ListKafkaClusterConfigs API. A default retry strategy applies to this operation ListKafkaClusterConfigs()

func (KafkaClusterClient) ListKafkaClusters

func (client KafkaClusterClient) ListKafkaClusters(ctx context.Context, request ListKafkaClustersRequest) (response ListKafkaClustersResponse, err error)

ListKafkaClusters Gets a list of KafkaClusters.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListKafkaClusters.go.html to see an example of how to use ListKafkaClusters API. A default retry strategy applies to this operation ListKafkaClusters()

func (KafkaClusterClient) ListWorkRequestErrors

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

ListWorkRequestErrors Lists the errors for a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()

func (KafkaClusterClient) ListWorkRequestLogs

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

ListWorkRequestLogs Lists the logs for a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()

func (KafkaClusterClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in a compartment.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (*KafkaClusterClient) SetRegion

func (client *KafkaClusterClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (KafkaClusterClient) UpdateKafkaCluster

func (client KafkaClusterClient) UpdateKafkaCluster(ctx context.Context, request UpdateKafkaClusterRequest) (response UpdateKafkaClusterResponse, err error)

UpdateKafkaCluster Updates a KafkaCluster.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/UpdateKafkaCluster.go.html to see an example of how to use UpdateKafkaCluster API. A default retry strategy applies to this operation UpdateKafkaCluster()

func (KafkaClusterClient) UpdateKafkaClusterConfig

func (client KafkaClusterClient) UpdateKafkaClusterConfig(ctx context.Context, request UpdateKafkaClusterConfigRequest) (response UpdateKafkaClusterConfigResponse, err error)

UpdateKafkaClusterConfig Updates a KafkaClusterConfig.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/UpdateKafkaClusterConfig.go.html to see an example of how to use UpdateKafkaClusterConfig API. A default retry strategy applies to this operation UpdateKafkaClusterConfig()

type KafkaClusterClusterTypeEnum

type KafkaClusterClusterTypeEnum string

KafkaClusterClusterTypeEnum Enum with underlying type: string

const (
	KafkaClusterClusterTypeDevelopment KafkaClusterClusterTypeEnum = "DEVELOPMENT"
	KafkaClusterClusterTypeProduction  KafkaClusterClusterTypeEnum = "PRODUCTION"
)

Set of constants representing the allowable values for KafkaClusterClusterTypeEnum

func GetKafkaClusterClusterTypeEnumValues

func GetKafkaClusterClusterTypeEnumValues() []KafkaClusterClusterTypeEnum

GetKafkaClusterClusterTypeEnumValues Enumerates the set of values for KafkaClusterClusterTypeEnum

func GetMappingKafkaClusterClusterTypeEnum

func GetMappingKafkaClusterClusterTypeEnum(val string) (KafkaClusterClusterTypeEnum, bool)

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

type KafkaClusterCollection

type KafkaClusterCollection struct {

	// List of kafkaClusters.
	Items []KafkaClusterSummary `mandatory:"true" json:"items"`
}

KafkaClusterCollection Results of a kafkaCluster search. Contains both KafkaClusterSummary items and other information, such as metadata.

func (KafkaClusterCollection) String

func (m KafkaClusterCollection) String() string

func (KafkaClusterCollection) ValidateEnumValue

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

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

type KafkaClusterConfig

type KafkaClusterConfig struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The date and time the KafkaClusterConfig was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the KafkaClusterConfig.
	LifecycleState KafkaClusterConfigLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	LatestConfig *KafkaClusterConfigVersion `mandatory:"true" json:"latestConfig"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// The date and time the KafkaClusterConfig was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message that describes the current state of the KafkaClusterConfig in more detail. For example,
	// can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

KafkaClusterConfig A shared configuration object used by 0 or more kafka clusters. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

func (KafkaClusterConfig) String

func (m KafkaClusterConfig) String() string

func (KafkaClusterConfig) ValidateEnumValue

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

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

type KafkaClusterConfigCollection

type KafkaClusterConfigCollection struct {

	// List of kafkaClustersConfig.
	Items []KafkaClusterConfigSummary `mandatory:"true" json:"items"`
}

KafkaClusterConfigCollection Results of a kafkaClusterConfig search. Contains both KafkaClusterConfigSummary items and other information, such as metadata.

func (KafkaClusterConfigCollection) String

func (KafkaClusterConfigCollection) ValidateEnumValue

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

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

type KafkaClusterConfigLifecycleStateEnum

type KafkaClusterConfigLifecycleStateEnum string

KafkaClusterConfigLifecycleStateEnum Enum with underlying type: string

const (
	KafkaClusterConfigLifecycleStateCreating KafkaClusterConfigLifecycleStateEnum = "CREATING"
	KafkaClusterConfigLifecycleStateActive   KafkaClusterConfigLifecycleStateEnum = "ACTIVE"
	KafkaClusterConfigLifecycleStateUpdating KafkaClusterConfigLifecycleStateEnum = "UPDATING"
	KafkaClusterConfigLifecycleStateDeleted  KafkaClusterConfigLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for KafkaClusterConfigLifecycleStateEnum

func GetKafkaClusterConfigLifecycleStateEnumValues

func GetKafkaClusterConfigLifecycleStateEnumValues() []KafkaClusterConfigLifecycleStateEnum

GetKafkaClusterConfigLifecycleStateEnumValues Enumerates the set of values for KafkaClusterConfigLifecycleStateEnum

func GetMappingKafkaClusterConfigLifecycleStateEnum

func GetMappingKafkaClusterConfigLifecycleStateEnum(val string) (KafkaClusterConfigLifecycleStateEnum, bool)

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

type KafkaClusterConfigSummary

type KafkaClusterConfigSummary struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The date and time the KafkaClusterConfig was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the KafkaClusterConfig.
	LifecycleState KafkaClusterConfigLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// The date and time the KafkaClusterConfig was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message that describes the current state of the KafkaClusterConfig in more detail. For example,
	// can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

KafkaClusterConfigSummary Summary information about a KafkaClusterConfig.

func (KafkaClusterConfigSummary) String

func (m KafkaClusterConfigSummary) String() string

func (KafkaClusterConfigSummary) ValidateEnumValue

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

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

type KafkaClusterConfigVersion

type KafkaClusterConfigVersion struct {

	// Cluster configuration key-value pairs
	Properties map[string]string `mandatory:"true" json:"properties"`

	// ID cluster configuration
	ConfigId *string `mandatory:"false" json:"configId"`

	// Version of the cluster configuration
	VersionNumber *int `mandatory:"false" json:"versionNumber"`

	// The date and time the KafkaClusterConfigVersion was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

KafkaClusterConfigVersion A shared configuration object used by 0 or more kafka clusters.

func (KafkaClusterConfigVersion) String

func (m KafkaClusterConfigVersion) String() string

func (KafkaClusterConfigVersion) ValidateEnumValue

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

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

type KafkaClusterConfigVersionCollection

type KafkaClusterConfigVersionCollection struct {

	// List of kafkaClustersConfigVersion.
	Items []KafkaClusterConfigVersionSummary `mandatory:"true" json:"items"`
}

KafkaClusterConfigVersionCollection Results of a kafkaClusterConfigVersion search. Contains both KafkaClusterConfigVersionSummary items.

func (KafkaClusterConfigVersionCollection) String

func (KafkaClusterConfigVersionCollection) ValidateEnumValue

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

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

type KafkaClusterConfigVersionSummary

type KafkaClusterConfigVersionSummary struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	ConfigId *string `mandatory:"true" json:"configId"`

	// Version of the cluster configuration
	VersionNumber *int `mandatory:"true" json:"versionNumber"`

	// The date and time the KafkaClusterConfigVersion was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}

KafkaClusterConfigVersionSummary Summary information about a KafkaClusterConfigVersion.

func (KafkaClusterConfigVersionSummary) String

func (KafkaClusterConfigVersionSummary) ValidateEnumValue

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

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

type KafkaClusterCoordinationTypeEnum

type KafkaClusterCoordinationTypeEnum string

KafkaClusterCoordinationTypeEnum Enum with underlying type: string

const (
	KafkaClusterCoordinationTypeZookeeper KafkaClusterCoordinationTypeEnum = "ZOOKEEPER"
	KafkaClusterCoordinationTypeKraft     KafkaClusterCoordinationTypeEnum = "KRAFT"
)

Set of constants representing the allowable values for KafkaClusterCoordinationTypeEnum

func GetKafkaClusterCoordinationTypeEnumValues

func GetKafkaClusterCoordinationTypeEnumValues() []KafkaClusterCoordinationTypeEnum

GetKafkaClusterCoordinationTypeEnumValues Enumerates the set of values for KafkaClusterCoordinationTypeEnum

func GetMappingKafkaClusterCoordinationTypeEnum

func GetMappingKafkaClusterCoordinationTypeEnum(val string) (KafkaClusterCoordinationTypeEnum, bool)

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

type KafkaClusterLifecycleStateEnum

type KafkaClusterLifecycleStateEnum string

KafkaClusterLifecycleStateEnum Enum with underlying type: string

const (
	KafkaClusterLifecycleStateCreating KafkaClusterLifecycleStateEnum = "CREATING"
	KafkaClusterLifecycleStateUpdating KafkaClusterLifecycleStateEnum = "UPDATING"
	KafkaClusterLifecycleStateActive   KafkaClusterLifecycleStateEnum = "ACTIVE"
	KafkaClusterLifecycleStateDeleting KafkaClusterLifecycleStateEnum = "DELETING"
	KafkaClusterLifecycleStateDeleted  KafkaClusterLifecycleStateEnum = "DELETED"
	KafkaClusterLifecycleStateFailed   KafkaClusterLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for KafkaClusterLifecycleStateEnum

func GetKafkaClusterLifecycleStateEnumValues

func GetKafkaClusterLifecycleStateEnumValues() []KafkaClusterLifecycleStateEnum

GetKafkaClusterLifecycleStateEnumValues Enumerates the set of values for KafkaClusterLifecycleStateEnum

func GetMappingKafkaClusterLifecycleStateEnum

func GetMappingKafkaClusterLifecycleStateEnum(val string) (KafkaClusterLifecycleStateEnum, bool)

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

type KafkaClusterSummary

type KafkaClusterSummary struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The date and time the KafkaCluster was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the KafkaCluster.
	LifecycleState KafkaClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Subnets where broker/coordinator VNICs will be created.
	AccessSubnets []SubnetSet `mandatory:"true" json:"accessSubnets"`

	// Version of Kafka to use to spin up the cluster
	KafkaVersion *string `mandatory:"true" json:"kafkaVersion"`

	// Type of the cluster to spin up.
	// DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on single node
	// PRODUCTION - Minimum allowed broker count is 3
	ClusterType KafkaClusterClusterTypeEnum `mandatory:"true" json:"clusterType"`

	BrokerShape *BrokerShape `mandatory:"true" json:"brokerShape"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object
	ClusterConfigId *string `mandatory:"true" json:"clusterConfigId"`

	// The version of configuration object
	ClusterConfigVersion *int `mandatory:"true" json:"clusterConfigVersion"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// The date and time the KafkaCluster was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message that describes the current state of the KafkaCluster in more detail. For example,
	// can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// Kafka coordination type. Set of available types depends on Kafka version
	CoordinationType KafkaClusterCoordinationTypeEnum `mandatory:"false" json:"coordinationType,omitempty"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

KafkaClusterSummary Summary information about a KafkaCluster.

func (KafkaClusterSummary) String

func (m KafkaClusterSummary) String() string

func (KafkaClusterSummary) ValidateEnumValue

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

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

type ListKafkaClusterConfigVersionsRequest

type ListKafkaClusterConfigVersionsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	KafkaClusterConfigId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterConfigId"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListKafkaClusterConfigVersionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `versionNumber`
	// is descending.
	SortBy ListKafkaClusterConfigVersionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

ListKafkaClusterConfigVersionsRequest wrapper for the ListKafkaClusterConfigVersions operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListKafkaClusterConfigVersions.go.html to see an example of how to use ListKafkaClusterConfigVersionsRequest.

func (ListKafkaClusterConfigVersionsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListKafkaClusterConfigVersionsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListKafkaClusterConfigVersionsRequest) RetryPolicy

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

func (ListKafkaClusterConfigVersionsRequest) String

func (ListKafkaClusterConfigVersionsRequest) ValidateEnumValue

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

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

type ListKafkaClusterConfigVersionsResponse

type ListKafkaClusterConfigVersionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of KafkaClusterConfigVersionCollection instances
	KafkaClusterConfigVersionCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListKafkaClusterConfigVersionsResponse wrapper for the ListKafkaClusterConfigVersions operation

func (ListKafkaClusterConfigVersionsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListKafkaClusterConfigVersionsResponse) String

type ListKafkaClusterConfigVersionsSortByEnum

type ListKafkaClusterConfigVersionsSortByEnum string

ListKafkaClusterConfigVersionsSortByEnum Enum with underlying type: string

const (
	ListKafkaClusterConfigVersionsSortByVersionnumber ListKafkaClusterConfigVersionsSortByEnum = "versionNumber"
)

Set of constants representing the allowable values for ListKafkaClusterConfigVersionsSortByEnum

func GetListKafkaClusterConfigVersionsSortByEnumValues

func GetListKafkaClusterConfigVersionsSortByEnumValues() []ListKafkaClusterConfigVersionsSortByEnum

GetListKafkaClusterConfigVersionsSortByEnumValues Enumerates the set of values for ListKafkaClusterConfigVersionsSortByEnum

func GetMappingListKafkaClusterConfigVersionsSortByEnum

func GetMappingListKafkaClusterConfigVersionsSortByEnum(val string) (ListKafkaClusterConfigVersionsSortByEnum, bool)

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

type ListKafkaClusterConfigVersionsSortOrderEnum

type ListKafkaClusterConfigVersionsSortOrderEnum string

ListKafkaClusterConfigVersionsSortOrderEnum Enum with underlying type: string

const (
	ListKafkaClusterConfigVersionsSortOrderAsc  ListKafkaClusterConfigVersionsSortOrderEnum = "ASC"
	ListKafkaClusterConfigVersionsSortOrderDesc ListKafkaClusterConfigVersionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListKafkaClusterConfigVersionsSortOrderEnum

func GetListKafkaClusterConfigVersionsSortOrderEnumValues

func GetListKafkaClusterConfigVersionsSortOrderEnumValues() []ListKafkaClusterConfigVersionsSortOrderEnum

GetListKafkaClusterConfigVersionsSortOrderEnumValues Enumerates the set of values for ListKafkaClusterConfigVersionsSortOrderEnum

func GetMappingListKafkaClusterConfigVersionsSortOrderEnum

func GetMappingListKafkaClusterConfigVersionsSortOrderEnum(val string) (ListKafkaClusterConfigVersionsSortOrderEnum, bool)

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

type ListKafkaClusterConfigsRequest

type ListKafkaClusterConfigsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given lifecycle state. The
	// state value is case-insensitive.
	LifecycleState KafkaClusterConfigLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListKafkaClusterConfigsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
	// is descending. Default order for `displayName` is ascending.
	SortBy ListKafkaClusterConfigsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

ListKafkaClusterConfigsRequest wrapper for the ListKafkaClusterConfigs operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListKafkaClusterConfigs.go.html to see an example of how to use ListKafkaClusterConfigsRequest.

func (ListKafkaClusterConfigsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListKafkaClusterConfigsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListKafkaClusterConfigsRequest) RetryPolicy

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

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

func (ListKafkaClusterConfigsRequest) String

func (request ListKafkaClusterConfigsRequest) String() string

func (ListKafkaClusterConfigsRequest) ValidateEnumValue

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

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

type ListKafkaClusterConfigsResponse

type ListKafkaClusterConfigsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of KafkaClusterConfigCollection instances
	KafkaClusterConfigCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListKafkaClusterConfigsResponse wrapper for the ListKafkaClusterConfigs operation

func (ListKafkaClusterConfigsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListKafkaClusterConfigsResponse) String

func (response ListKafkaClusterConfigsResponse) String() string

type ListKafkaClusterConfigsSortByEnum

type ListKafkaClusterConfigsSortByEnum string

ListKafkaClusterConfigsSortByEnum Enum with underlying type: string

const (
	ListKafkaClusterConfigsSortByTimecreated ListKafkaClusterConfigsSortByEnum = "timeCreated"
	ListKafkaClusterConfigsSortByDisplayname ListKafkaClusterConfigsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListKafkaClusterConfigsSortByEnum

func GetListKafkaClusterConfigsSortByEnumValues

func GetListKafkaClusterConfigsSortByEnumValues() []ListKafkaClusterConfigsSortByEnum

GetListKafkaClusterConfigsSortByEnumValues Enumerates the set of values for ListKafkaClusterConfigsSortByEnum

func GetMappingListKafkaClusterConfigsSortByEnum

func GetMappingListKafkaClusterConfigsSortByEnum(val string) (ListKafkaClusterConfigsSortByEnum, bool)

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

type ListKafkaClusterConfigsSortOrderEnum

type ListKafkaClusterConfigsSortOrderEnum string

ListKafkaClusterConfigsSortOrderEnum Enum with underlying type: string

const (
	ListKafkaClusterConfigsSortOrderAsc  ListKafkaClusterConfigsSortOrderEnum = "ASC"
	ListKafkaClusterConfigsSortOrderDesc ListKafkaClusterConfigsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListKafkaClusterConfigsSortOrderEnum

func GetListKafkaClusterConfigsSortOrderEnumValues

func GetListKafkaClusterConfigsSortOrderEnumValues() []ListKafkaClusterConfigsSortOrderEnum

GetListKafkaClusterConfigsSortOrderEnumValues Enumerates the set of values for ListKafkaClusterConfigsSortOrderEnum

func GetMappingListKafkaClusterConfigsSortOrderEnum

func GetMappingListKafkaClusterConfigsSortOrderEnum(val string) (ListKafkaClusterConfigsSortOrderEnum, bool)

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

type ListKafkaClustersRequest

type ListKafkaClustersRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given lifecycle state. The
	// state value is case-insensitive.
	LifecycleState KafkaClusterLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListKafkaClustersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
	// is descending. Default order for `displayName` is ascending.
	SortBy ListKafkaClustersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

ListKafkaClustersRequest wrapper for the ListKafkaClusters operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListKafkaClusters.go.html to see an example of how to use ListKafkaClustersRequest.

func (ListKafkaClustersRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListKafkaClustersRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListKafkaClustersRequest) RetryPolicy

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

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

func (ListKafkaClustersRequest) String

func (request ListKafkaClustersRequest) String() string

func (ListKafkaClustersRequest) ValidateEnumValue

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

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

type ListKafkaClustersResponse

type ListKafkaClustersResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of KafkaClusterCollection instances
	KafkaClusterCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListKafkaClustersResponse wrapper for the ListKafkaClusters operation

func (ListKafkaClustersResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListKafkaClustersResponse) String

func (response ListKafkaClustersResponse) String() string

type ListKafkaClustersSortByEnum

type ListKafkaClustersSortByEnum string

ListKafkaClustersSortByEnum Enum with underlying type: string

const (
	ListKafkaClustersSortByTimecreated ListKafkaClustersSortByEnum = "timeCreated"
	ListKafkaClustersSortByDisplayname ListKafkaClustersSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListKafkaClustersSortByEnum

func GetListKafkaClustersSortByEnumValues

func GetListKafkaClustersSortByEnumValues() []ListKafkaClustersSortByEnum

GetListKafkaClustersSortByEnumValues Enumerates the set of values for ListKafkaClustersSortByEnum

func GetMappingListKafkaClustersSortByEnum

func GetMappingListKafkaClustersSortByEnum(val string) (ListKafkaClustersSortByEnum, bool)

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

type ListKafkaClustersSortOrderEnum

type ListKafkaClustersSortOrderEnum string

ListKafkaClustersSortOrderEnum Enum with underlying type: string

const (
	ListKafkaClustersSortOrderAsc  ListKafkaClustersSortOrderEnum = "ASC"
	ListKafkaClustersSortOrderDesc ListKafkaClustersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListKafkaClustersSortOrderEnum

func GetListKafkaClustersSortOrderEnumValues

func GetListKafkaClustersSortOrderEnumValues() []ListKafkaClustersSortOrderEnum

GetListKafkaClustersSortOrderEnumValues Enumerates the set of values for ListKafkaClustersSortOrderEnum

func GetMappingListKafkaClustersSortOrderEnum

func GetMappingListKafkaClustersSortOrderEnum(val string) (ListKafkaClustersSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest

type ListWorkRequestErrorsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
	SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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

func (ListWorkRequestErrorsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

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

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

type ListWorkRequestErrorsResponse

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest

type ListWorkRequestLogsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
	SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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

func (ListWorkRequestLogsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

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

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

type ListWorkRequestLogsResponse

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest

type ListWorkRequestsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`

	// A filter to return only the resources that match the given lifecycle state.
	Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
	ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.
	SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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

func (ListWorkRequestsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

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

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

type ListWorkRequestsResponse

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestSummaryCollection instances
	WorkRequestSummaryCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type ListWorkRequestsStatusEnum

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string

const (
	ListWorkRequestsStatusAccepted       ListWorkRequestsStatusEnum = "ACCEPTED"
	ListWorkRequestsStatusInProgress     ListWorkRequestsStatusEnum = "IN_PROGRESS"
	ListWorkRequestsStatusWaiting        ListWorkRequestsStatusEnum = "WAITING"
	ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
	ListWorkRequestsStatusFailed         ListWorkRequestsStatusEnum = "FAILED"
	ListWorkRequestsStatusSucceeded      ListWorkRequestsStatusEnum = "SUCCEEDED"
	ListWorkRequestsStatusCanceling      ListWorkRequestsStatusEnum = "CANCELING"
	ListWorkRequestsStatusCanceled       ListWorkRequestsStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

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

type OperationStatusEnum

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string

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

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string

const (
	OperationTypeCreateKafkaCluster OperationTypeEnum = "CREATE_KAFKA_CLUSTER"
	OperationTypeUpdateKafkaCluster OperationTypeEnum = "UPDATE_KAFKA_CLUSTER"
	OperationTypeDeleteKafkaCluster OperationTypeEnum = "DELETE_KAFKA_CLUSTER"
	OperationTypeMoveKafkaCluster   OperationTypeEnum = "MOVE_KAFKA_CLUSTER"
	OperationTypeEnableSuperuser    OperationTypeEnum = "ENABLE_SUPERUSER"
	OperationTypeDisableSuperuser   OperationTypeEnum = "DISABLE_SUPERUSER"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type SubnetSet

type SubnetSet struct {

	// Subnets OCIDs
	Subnets []string `mandatory:"true" json:"subnets"`
}

SubnetSet Summary information about a KafkaCluster.

func (SubnetSet) String

func (m SubnetSet) String() string

func (SubnetSet) ValidateEnumValue

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

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

type UpdateKafkaClusterConfigDetails

type UpdateKafkaClusterConfigDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	LatestConfig *KafkaClusterConfigVersion `mandatory:"false" json:"latestConfig"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateKafkaClusterConfigDetails The data to update a KafkaClusterConfig.

func (UpdateKafkaClusterConfigDetails) String

func (UpdateKafkaClusterConfigDetails) ValidateEnumValue

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

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

type UpdateKafkaClusterConfigRequest

type UpdateKafkaClusterConfigRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig.
	KafkaClusterConfigId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterConfigId"`

	// The information to be updated.
	UpdateKafkaClusterConfigDetails `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"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

UpdateKafkaClusterConfigRequest wrapper for the UpdateKafkaClusterConfig operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/UpdateKafkaClusterConfig.go.html to see an example of how to use UpdateKafkaClusterConfigRequest.

func (UpdateKafkaClusterConfigRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateKafkaClusterConfigRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateKafkaClusterConfigRequest) RetryPolicy

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

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

func (UpdateKafkaClusterConfigRequest) String

func (request UpdateKafkaClusterConfigRequest) String() string

func (UpdateKafkaClusterConfigRequest) ValidateEnumValue

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

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

type UpdateKafkaClusterConfigResponse

type UpdateKafkaClusterConfigResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateKafkaClusterConfigResponse wrapper for the UpdateKafkaClusterConfig operation

func (UpdateKafkaClusterConfigResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateKafkaClusterConfigResponse) String

func (response UpdateKafkaClusterConfigResponse) String() string

type UpdateKafkaClusterDetails

type UpdateKafkaClusterDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// CA certificate bundle for mTLS broker authentication.
	ClientCertificateBundle *string `mandatory:"false" json:"clientCertificateBundle"`

	BrokerShape *BrokerShape `mandatory:"false" json:"brokerShape"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object
	ClusterConfigId *string `mandatory:"false" json:"clusterConfigId"`

	// The version of configuration object
	ClusterConfigVersion *int `mandatory:"false" json:"clusterConfigVersion"`

	// Subnets where broker/coordinator VNICs will be created.
	AccessSubnets []SubnetSet `mandatory:"false" json:"accessSubnets"`

	// Kafka coordination type. Set of available types depends on Kafka version
	CoordinationType KafkaClusterCoordinationTypeEnum `mandatory:"false" json:"coordinationType,omitempty"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateKafkaClusterDetails The data to update a KafkaCluster.

func (UpdateKafkaClusterDetails) String

func (m UpdateKafkaClusterDetails) String() string

func (UpdateKafkaClusterDetails) ValidateEnumValue

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

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

type UpdateKafkaClusterRequest

type UpdateKafkaClusterRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster.
	KafkaClusterId *string `mandatory:"true" contributesTo:"path" name:"kafkaClusterId"`

	// The information to be updated.
	UpdateKafkaClusterDetails `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"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

UpdateKafkaClusterRequest wrapper for the UpdateKafkaCluster operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/UpdateKafkaCluster.go.html to see an example of how to use UpdateKafkaClusterRequest.

func (UpdateKafkaClusterRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateKafkaClusterRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateKafkaClusterRequest) RetryPolicy

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

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

func (UpdateKafkaClusterRequest) String

func (request UpdateKafkaClusterRequest) String() string

func (UpdateKafkaClusterRequest) ValidateEnumValue

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

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

type UpdateKafkaClusterResponse

type UpdateKafkaClusterResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	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"`
}

UpdateKafkaClusterResponse wrapper for the UpdateKafkaCluster operation

func (UpdateKafkaClusterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateKafkaClusterResponse) String

func (response UpdateKafkaClusterResponse) String() string

type WorkRequest

type WorkRequest struct {

	// The asynchronous operation tracked by this work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

	// Shows the progress of the operation tracked by the work request, as a percentage of the total work
	// that must be performed.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the work request was created, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the work request was started, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the work request was finished, in the format defined by
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// The date and time the work request was updated, in the format defined by
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

WorkRequest An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

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

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

type WorkRequestError

type WorkRequestError struct {

	// A machine-usable code for the error that occurred. For a list of error codes, see
	// API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
	Code *string `mandatory:"true" json:"code"`

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

	// The date and time the error occurred, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

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

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

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

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

type WorkRequestErrorCollection

type WorkRequestErrorCollection struct {

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

WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.

func (WorkRequestErrorCollection) String

func (WorkRequestErrorCollection) ValidateEnumValue

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

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

type WorkRequestLogEntry

type WorkRequestLogEntry struct {

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

	// The date and time the log message was written, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

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

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

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

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

type WorkRequestLogEntryCollection

type WorkRequestLogEntryCollection struct {

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

WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.

func (WorkRequestLogEntryCollection) String

func (WorkRequestLogEntryCollection) ValidateEnumValue

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

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

type WorkRequestResource

type WorkRequestResource struct {

	// The resource type that the work request affects.
	EntityType *string `mandatory:"true" json:"entityType"`

	// The way in which this resource is affected by the operation tracked in the work request.
	// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
	// work is complete for that resource, at which point it transitions to CREATED, UPDATED,
	// or DELETED, respectively.
	ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`

	// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The URI path that you can use for a GET request to access the resource metadata.
	EntityUri *string `mandatory:"false" json:"entityUri"`

	// Additional information that helps to explain the resource.
	Metadata map[string]string `mandatory:"false" json:"metadata"`
}

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

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

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

type WorkRequestResourceMetadataKeyEnum

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string

const (
	WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

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

func GetWorkRequestResourceMetadataKeyEnumValues

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary

type WorkRequestSummary struct {

	// The asynchronous operation tracked by this work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

	// Shows the progress of the operation tracked by the work request, as a percentage of the total work
	// that must be performed.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the work request was created, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the work request was started, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the work request was finished, in the format defined by
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// The date and time the work request was updated, in the format defined by
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

WorkRequestSummary Summary information about an asynchronous work request.

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

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

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

type WorkRequestSummaryCollection

type WorkRequestSummaryCollection struct {

	// A list of work requests.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.

func (WorkRequestSummaryCollection) String

func (WorkRequestSummaryCollection) ValidateEnumValue

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

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

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL