func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetKafkaClusterClusterTypeEnumStringValues() []string
GetKafkaClusterClusterTypeEnumStringValues Enumerates the set of values in String for KafkaClusterClusterTypeEnum
func GetKafkaClusterConfigLifecycleStateEnumStringValues() []string
GetKafkaClusterConfigLifecycleStateEnumStringValues Enumerates the set of values in String for KafkaClusterConfigLifecycleStateEnum
func GetKafkaClusterCoordinationTypeEnumStringValues() []string
GetKafkaClusterCoordinationTypeEnumStringValues Enumerates the set of values in String for KafkaClusterCoordinationTypeEnum
func GetKafkaClusterLifecycleStateEnumStringValues() []string
GetKafkaClusterLifecycleStateEnumStringValues Enumerates the set of values in String for KafkaClusterLifecycleStateEnum
func GetListKafkaClusterConfigVersionsSortByEnumStringValues() []string
GetListKafkaClusterConfigVersionsSortByEnumStringValues Enumerates the set of values in String for ListKafkaClusterConfigVersionsSortByEnum
func GetListKafkaClusterConfigVersionsSortOrderEnumStringValues() []string
GetListKafkaClusterConfigVersionsSortOrderEnumStringValues Enumerates the set of values in String for ListKafkaClusterConfigVersionsSortOrderEnum
func GetListKafkaClusterConfigsSortByEnumStringValues() []string
GetListKafkaClusterConfigsSortByEnumStringValues Enumerates the set of values in String for ListKafkaClusterConfigsSortByEnum
func GetListKafkaClusterConfigsSortOrderEnumStringValues() []string
GetListKafkaClusterConfigsSortOrderEnumStringValues Enumerates the set of values in String for ListKafkaClusterConfigsSortOrderEnum
func GetListKafkaClustersSortByEnumStringValues() []string
GetListKafkaClustersSortByEnumStringValues Enumerates the set of values in String for ListKafkaClustersSortByEnum
func GetListKafkaClustersSortOrderEnumStringValues() []string
GetListKafkaClustersSortOrderEnumStringValues Enumerates the set of values in String for ListKafkaClustersSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BootstrapUrl Kafka bootstrap URL
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"`
}
func (m BootstrapUrl) String() string
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
BrokerShape Configuration of the broker node.
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"`
}
func (m BrokerShape) String() string
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
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
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.
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
}
func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
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
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
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"`
}
func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
ChangeKafkaClusterCompartmentDetails The configuration details for the move operation.
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"`
}
func (m ChangeKafkaClusterCompartmentDetails) String() string
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
ChangeKafkaClusterCompartmentRequest wrapper for the ChangeKafkaClusterCompartment operation
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.
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
}
func (request ChangeKafkaClusterCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeKafkaClusterCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeKafkaClusterCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeKafkaClusterCompartmentRequest) String() string
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
ChangeKafkaClusterCompartmentResponse wrapper for the ChangeKafkaClusterCompartment operation
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"`
}
func (response ChangeKafkaClusterCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeKafkaClusterCompartmentResponse) String() string
ChangeKafkaClusterConfigCompartmentDetails The configuration details for the move operation.
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"`
}
func (m ChangeKafkaClusterConfigCompartmentDetails) String() string
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
ChangeKafkaClusterConfigCompartmentRequest wrapper for the ChangeKafkaClusterConfigCompartment operation
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.
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
}
func (request ChangeKafkaClusterConfigCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeKafkaClusterConfigCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeKafkaClusterConfigCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeKafkaClusterConfigCompartmentRequest) String() string
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
ChangeKafkaClusterConfigCompartmentResponse wrapper for the ChangeKafkaClusterConfigCompartment operation
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"`
}
func (response ChangeKafkaClusterConfigCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeKafkaClusterConfigCompartmentResponse) String() string
CreateKafkaClusterConfigDetails The data to create a KafkaClusterConfig.
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"`
}
func (m CreateKafkaClusterConfigDetails) String() string
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
CreateKafkaClusterConfigRequest wrapper for the CreateKafkaClusterConfig operation
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.
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
}
func (request CreateKafkaClusterConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateKafkaClusterConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateKafkaClusterConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateKafkaClusterConfigRequest) String() string
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
CreateKafkaClusterConfigResponse wrapper for the CreateKafkaClusterConfig operation
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"`
}
func (response CreateKafkaClusterConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateKafkaClusterConfigResponse) String() string
CreateKafkaClusterDetails The data to create a KafkaCluster.
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"`
}
func (m CreateKafkaClusterDetails) String() string
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
CreateKafkaClusterRequest wrapper for the CreateKafkaCluster operation
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.
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
}
func (request CreateKafkaClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateKafkaClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateKafkaClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateKafkaClusterRequest) String() string
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
CreateKafkaClusterResponse wrapper for the CreateKafkaCluster operation
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"`
}
func (response CreateKafkaClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateKafkaClusterResponse) String() string
DeleteKafkaClusterConfigRequest wrapper for the DeleteKafkaClusterConfig operation
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.
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
}
func (request DeleteKafkaClusterConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteKafkaClusterConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteKafkaClusterConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteKafkaClusterConfigRequest) String() string
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
DeleteKafkaClusterConfigResponse wrapper for the DeleteKafkaClusterConfig operation
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"`
}
func (response DeleteKafkaClusterConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteKafkaClusterConfigResponse) String() string
DeleteKafkaClusterConfigVersionRequest wrapper for the DeleteKafkaClusterConfigVersion operation
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.
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
}
func (request DeleteKafkaClusterConfigVersionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteKafkaClusterConfigVersionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteKafkaClusterConfigVersionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteKafkaClusterConfigVersionRequest) String() string
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
DeleteKafkaClusterConfigVersionResponse wrapper for the DeleteKafkaClusterConfigVersion operation
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"`
}
func (response DeleteKafkaClusterConfigVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteKafkaClusterConfigVersionResponse) String() string
DeleteKafkaClusterRequest wrapper for the DeleteKafkaCluster operation
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.
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
}
func (request DeleteKafkaClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteKafkaClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteKafkaClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteKafkaClusterRequest) String() string
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
DeleteKafkaClusterResponse wrapper for the DeleteKafkaCluster operation
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"`
}
func (response DeleteKafkaClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteKafkaClusterResponse) String() string
DisableSuperuserRequest wrapper for the DisableSuperuser operation
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.
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
}
func (request DisableSuperuserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DisableSuperuserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DisableSuperuserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DisableSuperuserRequest) String() string
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
DisableSuperuserResponse wrapper for the DisableSuperuser operation
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"`
}
func (response DisableSuperuserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DisableSuperuserResponse) String() string
EnableSuperuserDetails The configuration details for the enable superuser operation.
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"`
}
func (m EnableSuperuserDetails) String() string
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
EnableSuperuserRequest wrapper for the EnableSuperuser operation
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.
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
}
func (request EnableSuperuserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request EnableSuperuserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request EnableSuperuserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request EnableSuperuserRequest) String() string
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
EnableSuperuserResponse wrapper for the EnableSuperuser operation
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"`
}
func (response EnableSuperuserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response EnableSuperuserResponse) String() string
GetKafkaClusterConfigRequest wrapper for the GetKafkaClusterConfig operation
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.
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
}
func (request GetKafkaClusterConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetKafkaClusterConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetKafkaClusterConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetKafkaClusterConfigRequest) String() string
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
GetKafkaClusterConfigResponse wrapper for the GetKafkaClusterConfig operation
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"`
}
func (response GetKafkaClusterConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetKafkaClusterConfigResponse) String() string
GetKafkaClusterConfigVersionRequest wrapper for the GetKafkaClusterConfigVersion operation
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.
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
}
func (request GetKafkaClusterConfigVersionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetKafkaClusterConfigVersionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetKafkaClusterConfigVersionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetKafkaClusterConfigVersionRequest) String() string
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
GetKafkaClusterConfigVersionResponse wrapper for the GetKafkaClusterConfigVersion operation
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"`
}
func (response GetKafkaClusterConfigVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetKafkaClusterConfigVersionResponse) String() string
GetKafkaClusterRequest wrapper for the GetKafkaCluster operation
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.
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
}
func (request GetKafkaClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetKafkaClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetKafkaClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetKafkaClusterRequest) String() string
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
GetKafkaClusterResponse wrapper for the GetKafkaCluster operation
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"`
}
func (response GetKafkaClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetKafkaClusterResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
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.
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
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// 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"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
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).
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"`
}
func (m KafkaCluster) String() string
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
KafkaClusterClient a client for KafkaCluster
type KafkaClusterClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client KafkaClusterClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels a work request.
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 (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).
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 (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).
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 (client *KafkaClusterClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client KafkaClusterClient) CreateKafkaCluster(ctx context.Context, request CreateKafkaClusterRequest) (response CreateKafkaClusterResponse, err error)
CreateKafkaCluster Creates a KafkaCluster.
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 (client KafkaClusterClient) CreateKafkaClusterConfig(ctx context.Context, request CreateKafkaClusterConfigRequest) (response CreateKafkaClusterConfigResponse, err error)
CreateKafkaClusterConfig Creates a KafkaClusterConfig.
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 (client KafkaClusterClient) DeleteKafkaCluster(ctx context.Context, request DeleteKafkaClusterRequest) (response DeleteKafkaClusterResponse, err error)
DeleteKafkaCluster Deletes a KafkaCluster.
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 (client KafkaClusterClient) DeleteKafkaClusterConfig(ctx context.Context, request DeleteKafkaClusterConfigRequest) (response DeleteKafkaClusterConfigResponse, err error)
DeleteKafkaClusterConfig Deletes a KafkaClusterConfig.
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 (client KafkaClusterClient) DeleteKafkaClusterConfigVersion(ctx context.Context, request DeleteKafkaClusterConfigVersionRequest) (response DeleteKafkaClusterConfigVersionResponse, err error)
DeleteKafkaClusterConfigVersion Deletes a KafkaClusterConfig version.
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 (client KafkaClusterClient) DisableSuperuser(ctx context.Context, request DisableSuperuserRequest) (response DisableSuperuserResponse, err error)
DisableSuperuser Removes the SASL superuser to the Kafka cluster.
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 (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.
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 (client KafkaClusterClient) GetKafkaCluster(ctx context.Context, request GetKafkaClusterRequest) (response GetKafkaClusterResponse, err error)
GetKafkaCluster Gets information about a KafkaCluster.
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 (client KafkaClusterClient) GetKafkaClusterConfig(ctx context.Context, request GetKafkaClusterConfigRequest) (response GetKafkaClusterConfigResponse, err error)
GetKafkaClusterConfig Gets information about a KafkaClusterConfig.
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 (client KafkaClusterClient) GetKafkaClusterConfigVersion(ctx context.Context, request GetKafkaClusterConfigVersionRequest) (response GetKafkaClusterConfigVersionResponse, err error)
GetKafkaClusterConfigVersion Gets information about a KafkaClusterConfig version.
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 (client KafkaClusterClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of a work request.
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 (client KafkaClusterClient) ListKafkaClusterConfigVersions(ctx context.Context, request ListKafkaClusterConfigVersionsRequest) (response ListKafkaClusterConfigVersionsResponse, err error)
ListKafkaClusterConfigVersions Gets a list of KafkaClusterConfig Versions.
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 (client KafkaClusterClient) ListKafkaClusterConfigs(ctx context.Context, request ListKafkaClusterConfigsRequest) (response ListKafkaClusterConfigsResponse, err error)
ListKafkaClusterConfigs Gets a list of KafkaClusterConfigs.
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 (client KafkaClusterClient) ListKafkaClusters(ctx context.Context, request ListKafkaClustersRequest) (response ListKafkaClustersResponse, err error)
ListKafkaClusters Gets a list of KafkaClusters.
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 (client KafkaClusterClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists the errors for a work request.
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 (client KafkaClusterClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for a work request.
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 (client KafkaClusterClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *KafkaClusterClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client KafkaClusterClient) UpdateKafkaCluster(ctx context.Context, request UpdateKafkaClusterRequest) (response UpdateKafkaClusterResponse, err error)
UpdateKafkaCluster Updates a KafkaCluster.
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 (client KafkaClusterClient) UpdateKafkaClusterConfig(ctx context.Context, request UpdateKafkaClusterConfigRequest) (response UpdateKafkaClusterConfigResponse, err error)
UpdateKafkaClusterConfig Updates a KafkaClusterConfig.
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()
KafkaClusterClusterTypeEnum Enum with underlying type: string
type KafkaClusterClusterTypeEnum string
Set of constants representing the allowable values for KafkaClusterClusterTypeEnum
const (
KafkaClusterClusterTypeDevelopment KafkaClusterClusterTypeEnum = "DEVELOPMENT"
KafkaClusterClusterTypeProduction KafkaClusterClusterTypeEnum = "PRODUCTION"
)
func GetKafkaClusterClusterTypeEnumValues() []KafkaClusterClusterTypeEnum
GetKafkaClusterClusterTypeEnumValues Enumerates the set of values for KafkaClusterClusterTypeEnum
func GetMappingKafkaClusterClusterTypeEnum(val string) (KafkaClusterClusterTypeEnum, bool)
GetMappingKafkaClusterClusterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
KafkaClusterCollection Results of a kafkaCluster search. Contains both KafkaClusterSummary items and other information, such as metadata.
type KafkaClusterCollection struct {
// List of kafkaClusters.
Items []KafkaClusterSummary `mandatory:"true" json:"items"`
}
func (m KafkaClusterCollection) String() string
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
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).
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"`
}
func (m KafkaClusterConfig) String() string
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
KafkaClusterConfigCollection Results of a kafkaClusterConfig search. Contains both KafkaClusterConfigSummary items and other information, such as metadata.
type KafkaClusterConfigCollection struct {
// List of kafkaClustersConfig.
Items []KafkaClusterConfigSummary `mandatory:"true" json:"items"`
}
func (m KafkaClusterConfigCollection) String() string
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
KafkaClusterConfigLifecycleStateEnum Enum with underlying type: string
type KafkaClusterConfigLifecycleStateEnum string
Set of constants representing the allowable values for KafkaClusterConfigLifecycleStateEnum
const (
KafkaClusterConfigLifecycleStateCreating KafkaClusterConfigLifecycleStateEnum = "CREATING"
KafkaClusterConfigLifecycleStateActive KafkaClusterConfigLifecycleStateEnum = "ACTIVE"
KafkaClusterConfigLifecycleStateUpdating KafkaClusterConfigLifecycleStateEnum = "UPDATING"
KafkaClusterConfigLifecycleStateDeleted KafkaClusterConfigLifecycleStateEnum = "DELETED"
)
func GetKafkaClusterConfigLifecycleStateEnumValues() []KafkaClusterConfigLifecycleStateEnum
GetKafkaClusterConfigLifecycleStateEnumValues Enumerates the set of values for KafkaClusterConfigLifecycleStateEnum
func GetMappingKafkaClusterConfigLifecycleStateEnum(val string) (KafkaClusterConfigLifecycleStateEnum, bool)
GetMappingKafkaClusterConfigLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
KafkaClusterConfigSummary Summary information about a KafkaClusterConfig.
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"`
}
func (m KafkaClusterConfigSummary) String() string
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
KafkaClusterConfigVersion A shared configuration object used by 0 or more kafka clusters.
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"`
}
func (m KafkaClusterConfigVersion) String() string
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
KafkaClusterConfigVersionCollection Results of a kafkaClusterConfigVersion search. Contains both KafkaClusterConfigVersionSummary items.
type KafkaClusterConfigVersionCollection struct {
// List of kafkaClustersConfigVersion.
Items []KafkaClusterConfigVersionSummary `mandatory:"true" json:"items"`
}
func (m KafkaClusterConfigVersionCollection) String() string
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
KafkaClusterConfigVersionSummary Summary information about a KafkaClusterConfigVersion.
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"`
}
func (m KafkaClusterConfigVersionSummary) String() string
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
KafkaClusterCoordinationTypeEnum Enum with underlying type: string
type KafkaClusterCoordinationTypeEnum string
Set of constants representing the allowable values for KafkaClusterCoordinationTypeEnum
const (
KafkaClusterCoordinationTypeZookeeper KafkaClusterCoordinationTypeEnum = "ZOOKEEPER"
KafkaClusterCoordinationTypeKraft KafkaClusterCoordinationTypeEnum = "KRAFT"
)
func GetKafkaClusterCoordinationTypeEnumValues() []KafkaClusterCoordinationTypeEnum
GetKafkaClusterCoordinationTypeEnumValues Enumerates the set of values for KafkaClusterCoordinationTypeEnum
func GetMappingKafkaClusterCoordinationTypeEnum(val string) (KafkaClusterCoordinationTypeEnum, bool)
GetMappingKafkaClusterCoordinationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
KafkaClusterLifecycleStateEnum Enum with underlying type: string
type KafkaClusterLifecycleStateEnum string
Set of constants representing the allowable values for KafkaClusterLifecycleStateEnum
const (
KafkaClusterLifecycleStateCreating KafkaClusterLifecycleStateEnum = "CREATING"
KafkaClusterLifecycleStateUpdating KafkaClusterLifecycleStateEnum = "UPDATING"
KafkaClusterLifecycleStateActive KafkaClusterLifecycleStateEnum = "ACTIVE"
KafkaClusterLifecycleStateDeleting KafkaClusterLifecycleStateEnum = "DELETING"
KafkaClusterLifecycleStateDeleted KafkaClusterLifecycleStateEnum = "DELETED"
KafkaClusterLifecycleStateFailed KafkaClusterLifecycleStateEnum = "FAILED"
)
func GetKafkaClusterLifecycleStateEnumValues() []KafkaClusterLifecycleStateEnum
GetKafkaClusterLifecycleStateEnumValues Enumerates the set of values for KafkaClusterLifecycleStateEnum
func GetMappingKafkaClusterLifecycleStateEnum(val string) (KafkaClusterLifecycleStateEnum, bool)
GetMappingKafkaClusterLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
KafkaClusterSummary Summary information about a KafkaCluster.
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"`
}
func (m KafkaClusterSummary) String() string
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
ListKafkaClusterConfigVersionsRequest wrapper for the ListKafkaClusterConfigVersions operation
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.
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
}
func (request ListKafkaClusterConfigVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListKafkaClusterConfigVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListKafkaClusterConfigVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListKafkaClusterConfigVersionsRequest) String() string
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
ListKafkaClusterConfigVersionsResponse wrapper for the ListKafkaClusterConfigVersions operation
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"`
}
func (response ListKafkaClusterConfigVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListKafkaClusterConfigVersionsResponse) String() string
ListKafkaClusterConfigVersionsSortByEnum Enum with underlying type: string
type ListKafkaClusterConfigVersionsSortByEnum string
Set of constants representing the allowable values for ListKafkaClusterConfigVersionsSortByEnum
const (
ListKafkaClusterConfigVersionsSortByVersionnumber ListKafkaClusterConfigVersionsSortByEnum = "versionNumber"
)
func GetListKafkaClusterConfigVersionsSortByEnumValues() []ListKafkaClusterConfigVersionsSortByEnum
GetListKafkaClusterConfigVersionsSortByEnumValues Enumerates the set of values for ListKafkaClusterConfigVersionsSortByEnum
func GetMappingListKafkaClusterConfigVersionsSortByEnum(val string) (ListKafkaClusterConfigVersionsSortByEnum, bool)
GetMappingListKafkaClusterConfigVersionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListKafkaClusterConfigVersionsSortOrderEnum Enum with underlying type: string
type ListKafkaClusterConfigVersionsSortOrderEnum string
Set of constants representing the allowable values for ListKafkaClusterConfigVersionsSortOrderEnum
const (
ListKafkaClusterConfigVersionsSortOrderAsc ListKafkaClusterConfigVersionsSortOrderEnum = "ASC"
ListKafkaClusterConfigVersionsSortOrderDesc ListKafkaClusterConfigVersionsSortOrderEnum = "DESC"
)
func GetListKafkaClusterConfigVersionsSortOrderEnumValues() []ListKafkaClusterConfigVersionsSortOrderEnum
GetListKafkaClusterConfigVersionsSortOrderEnumValues Enumerates the set of values for ListKafkaClusterConfigVersionsSortOrderEnum
func GetMappingListKafkaClusterConfigVersionsSortOrderEnum(val string) (ListKafkaClusterConfigVersionsSortOrderEnum, bool)
GetMappingListKafkaClusterConfigVersionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListKafkaClusterConfigsRequest wrapper for the ListKafkaClusterConfigs operation
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.
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
}
func (request ListKafkaClusterConfigsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListKafkaClusterConfigsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListKafkaClusterConfigsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListKafkaClusterConfigsRequest) String() string
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
ListKafkaClusterConfigsResponse wrapper for the ListKafkaClusterConfigs operation
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"`
}
func (response ListKafkaClusterConfigsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListKafkaClusterConfigsResponse) String() string
ListKafkaClusterConfigsSortByEnum Enum with underlying type: string
type ListKafkaClusterConfigsSortByEnum string
Set of constants representing the allowable values for ListKafkaClusterConfigsSortByEnum
const (
ListKafkaClusterConfigsSortByTimecreated ListKafkaClusterConfigsSortByEnum = "timeCreated"
ListKafkaClusterConfigsSortByDisplayname ListKafkaClusterConfigsSortByEnum = "displayName"
)
func GetListKafkaClusterConfigsSortByEnumValues() []ListKafkaClusterConfigsSortByEnum
GetListKafkaClusterConfigsSortByEnumValues Enumerates the set of values for ListKafkaClusterConfigsSortByEnum
func GetMappingListKafkaClusterConfigsSortByEnum(val string) (ListKafkaClusterConfigsSortByEnum, bool)
GetMappingListKafkaClusterConfigsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListKafkaClusterConfigsSortOrderEnum Enum with underlying type: string
type ListKafkaClusterConfigsSortOrderEnum string
Set of constants representing the allowable values for ListKafkaClusterConfigsSortOrderEnum
const (
ListKafkaClusterConfigsSortOrderAsc ListKafkaClusterConfigsSortOrderEnum = "ASC"
ListKafkaClusterConfigsSortOrderDesc ListKafkaClusterConfigsSortOrderEnum = "DESC"
)
func GetListKafkaClusterConfigsSortOrderEnumValues() []ListKafkaClusterConfigsSortOrderEnum
GetListKafkaClusterConfigsSortOrderEnumValues Enumerates the set of values for ListKafkaClusterConfigsSortOrderEnum
func GetMappingListKafkaClusterConfigsSortOrderEnum(val string) (ListKafkaClusterConfigsSortOrderEnum, bool)
GetMappingListKafkaClusterConfigsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListKafkaClustersRequest wrapper for the ListKafkaClusters operation
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.
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
}
func (request ListKafkaClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListKafkaClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListKafkaClustersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListKafkaClustersRequest) String() string
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
ListKafkaClustersResponse wrapper for the ListKafkaClusters operation
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"`
}
func (response ListKafkaClustersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListKafkaClustersResponse) String() string
ListKafkaClustersSortByEnum Enum with underlying type: string
type ListKafkaClustersSortByEnum string
Set of constants representing the allowable values for ListKafkaClustersSortByEnum
const (
ListKafkaClustersSortByTimecreated ListKafkaClustersSortByEnum = "timeCreated"
ListKafkaClustersSortByDisplayname ListKafkaClustersSortByEnum = "displayName"
)
func GetListKafkaClustersSortByEnumValues() []ListKafkaClustersSortByEnum
GetListKafkaClustersSortByEnumValues Enumerates the set of values for ListKafkaClustersSortByEnum
func GetMappingListKafkaClustersSortByEnum(val string) (ListKafkaClustersSortByEnum, bool)
GetMappingListKafkaClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListKafkaClustersSortOrderEnum Enum with underlying type: string
type ListKafkaClustersSortOrderEnum string
Set of constants representing the allowable values for ListKafkaClustersSortOrderEnum
const (
ListKafkaClustersSortOrderAsc ListKafkaClustersSortOrderEnum = "ASC"
ListKafkaClustersSortOrderDesc ListKafkaClustersSortOrderEnum = "DESC"
)
func GetListKafkaClustersSortOrderEnumValues() []ListKafkaClustersSortOrderEnum
GetListKafkaClustersSortOrderEnumValues Enumerates the set of values for ListKafkaClustersSortOrderEnum
func GetMappingListKafkaClustersSortOrderEnum(val string) (ListKafkaClustersSortOrderEnum, bool)
GetMappingListKafkaClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListWorkRequestErrors.go.html to see an example of how to use 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
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of 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"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListWorkRequestLogs.go.html to see an example of how to use 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
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of 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"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managedkafka/ListWorkRequests.go.html to see an example of how to use 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
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of 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"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
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"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
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"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
SubnetSet Summary information about a KafkaCluster.
type SubnetSet struct {
// Subnets OCIDs
Subnets []string `mandatory:"true" json:"subnets"`
}
func (m SubnetSet) String() string
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
UpdateKafkaClusterConfigDetails The data to update a KafkaClusterConfig.
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"`
}
func (m UpdateKafkaClusterConfigDetails) String() string
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
UpdateKafkaClusterConfigRequest wrapper for the UpdateKafkaClusterConfig operation
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.
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
}
func (request UpdateKafkaClusterConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateKafkaClusterConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateKafkaClusterConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateKafkaClusterConfigRequest) String() string
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
UpdateKafkaClusterConfigResponse wrapper for the UpdateKafkaClusterConfig operation
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"`
}
func (response UpdateKafkaClusterConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateKafkaClusterConfigResponse) String() string
UpdateKafkaClusterDetails The data to update a KafkaCluster.
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"`
}
func (m UpdateKafkaClusterDetails) String() string
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
UpdateKafkaClusterRequest wrapper for the UpdateKafkaCluster operation
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.
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
}
func (request UpdateKafkaClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateKafkaClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateKafkaClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateKafkaClusterRequest) String() string
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
UpdateKafkaClusterResponse wrapper for the UpdateKafkaCluster operation
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"`
}
func (response UpdateKafkaClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateKafkaClusterResponse) String() string
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.
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"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while performing an operation that is tracked by a work request.
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"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.
type WorkRequestErrorCollection struct {
// A list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
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
WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.
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"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// A list of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
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
WorkRequestResource A resource created or operated on by a work request.
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"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
WorkRequestSummary Summary information about an asynchronous work request.
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"`
}
func (m WorkRequestSummary) String() string
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
WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// A list of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
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