redis

package
v65.101.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetAuthenticationModeAuthenticationTypeEnumStringValues added in v65.93.2

func GetAuthenticationModeAuthenticationTypeEnumStringValues() []string

GetAuthenticationModeAuthenticationTypeEnumStringValues Enumerates the set of values in String for AuthenticationModeAuthenticationTypeEnum

func GetListAssociatedOciCacheClustersSortByEnumStringValues added in v65.98.0

func GetListAssociatedOciCacheClustersSortByEnumStringValues() []string

GetListAssociatedOciCacheClustersSortByEnumStringValues Enumerates the set of values in String for ListAssociatedOciCacheClustersSortByEnum

func GetListAssociatedOciCacheClustersSortOrderEnumStringValues added in v65.98.0

func GetListAssociatedOciCacheClustersSortOrderEnumStringValues() []string

GetListAssociatedOciCacheClustersSortOrderEnumStringValues Enumerates the set of values in String for ListAssociatedOciCacheClustersSortOrderEnum

func GetListAttachedOciCacheUsersSortByEnumStringValues added in v65.93.2

func GetListAttachedOciCacheUsersSortByEnumStringValues() []string

GetListAttachedOciCacheUsersSortByEnumStringValues Enumerates the set of values in String for ListAttachedOciCacheUsersSortByEnum

func GetListAttachedOciCacheUsersSortOrderEnumStringValues added in v65.93.2

func GetListAttachedOciCacheUsersSortOrderEnumStringValues() []string

GetListAttachedOciCacheUsersSortOrderEnumStringValues Enumerates the set of values in String for ListAttachedOciCacheUsersSortOrderEnum

func GetListAttachedRedisClustersSortByEnumStringValues added in v65.93.2

func GetListAttachedRedisClustersSortByEnumStringValues() []string

GetListAttachedRedisClustersSortByEnumStringValues Enumerates the set of values in String for ListAttachedRedisClustersSortByEnum

func GetListAttachedRedisClustersSortOrderEnumStringValues added in v65.93.2

func GetListAttachedRedisClustersSortOrderEnumStringValues() []string

GetListAttachedRedisClustersSortOrderEnumStringValues Enumerates the set of values in String for ListAttachedRedisClustersSortOrderEnum

func GetListOciCacheConfigSetsSortByEnumStringValues added in v65.98.0

func GetListOciCacheConfigSetsSortByEnumStringValues() []string

GetListOciCacheConfigSetsSortByEnumStringValues Enumerates the set of values in String for ListOciCacheConfigSetsSortByEnum

func GetListOciCacheConfigSetsSortOrderEnumStringValues added in v65.98.0

func GetListOciCacheConfigSetsSortOrderEnumStringValues() []string

GetListOciCacheConfigSetsSortOrderEnumStringValues Enumerates the set of values in String for ListOciCacheConfigSetsSortOrderEnum

func GetListOciCacheDefaultConfigSetsSortByEnumStringValues added in v65.98.0

func GetListOciCacheDefaultConfigSetsSortByEnumStringValues() []string

GetListOciCacheDefaultConfigSetsSortByEnumStringValues Enumerates the set of values in String for ListOciCacheDefaultConfigSetsSortByEnum

func GetListOciCacheDefaultConfigSetsSortOrderEnumStringValues added in v65.98.0

func GetListOciCacheDefaultConfigSetsSortOrderEnumStringValues() []string

GetListOciCacheDefaultConfigSetsSortOrderEnumStringValues Enumerates the set of values in String for ListOciCacheDefaultConfigSetsSortOrderEnum

func GetListOciCacheUsersSortByEnumStringValues added in v65.93.2

func GetListOciCacheUsersSortByEnumStringValues() []string

GetListOciCacheUsersSortByEnumStringValues Enumerates the set of values in String for ListOciCacheUsersSortByEnum

func GetListOciCacheUsersSortOrderEnumStringValues added in v65.93.2

func GetListOciCacheUsersSortOrderEnumStringValues() []string

GetListOciCacheUsersSortOrderEnumStringValues Enumerates the set of values in String for ListOciCacheUsersSortOrderEnum

func GetListRedisClusterNodesSortByEnumStringValues added in v65.72.0

func GetListRedisClusterNodesSortByEnumStringValues() []string

GetListRedisClusterNodesSortByEnumStringValues Enumerates the set of values in String for ListRedisClusterNodesSortByEnum

func GetListRedisClusterNodesSortOrderEnumStringValues added in v65.72.0

func GetListRedisClusterNodesSortOrderEnumStringValues() []string

GetListRedisClusterNodesSortOrderEnumStringValues Enumerates the set of values in String for ListRedisClusterNodesSortOrderEnum

func GetListRedisClustersSortByEnumStringValues

func GetListRedisClustersSortByEnumStringValues() []string

GetListRedisClustersSortByEnumStringValues Enumerates the set of values in String for ListRedisClustersSortByEnum

func GetListRedisClustersSortOrderEnumStringValues

func GetListRedisClustersSortOrderEnumStringValues() []string

GetListRedisClustersSortOrderEnumStringValues Enumerates the set of values in String for ListRedisClustersSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetOciCacheConfigSetLifecycleStateEnumStringValues added in v65.98.0

func GetOciCacheConfigSetLifecycleStateEnumStringValues() []string

GetOciCacheConfigSetLifecycleStateEnumStringValues Enumerates the set of values in String for OciCacheConfigSetLifecycleStateEnum

func GetOciCacheConfigSetSoftwareVersionEnumStringValues added in v65.98.0

func GetOciCacheConfigSetSoftwareVersionEnumStringValues() []string

GetOciCacheConfigSetSoftwareVersionEnumStringValues Enumerates the set of values in String for OciCacheConfigSetSoftwareVersionEnum

func GetOciCacheDefaultConfigSetLifecycleStateEnumStringValues added in v65.98.0

func GetOciCacheDefaultConfigSetLifecycleStateEnumStringValues() []string

GetOciCacheDefaultConfigSetLifecycleStateEnumStringValues Enumerates the set of values in String for OciCacheDefaultConfigSetLifecycleStateEnum

func GetOciCacheUserLifecycleStateEnumStringValues added in v65.93.2

func GetOciCacheUserLifecycleStateEnumStringValues() []string

GetOciCacheUserLifecycleStateEnumStringValues Enumerates the set of values in String for OciCacheUserLifecycleStateEnum

func GetOciCacheUserStatusEnumStringValues added in v65.93.2

func GetOciCacheUserStatusEnumStringValues() []string

GetOciCacheUserStatusEnumStringValues Enumerates the set of values in String for OciCacheUserStatusEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetRedisClusterClusterModeEnumStringValues added in v65.72.0

func GetRedisClusterClusterModeEnumStringValues() []string

GetRedisClusterClusterModeEnumStringValues Enumerates the set of values in String for RedisClusterClusterModeEnum

func GetRedisClusterLifecycleStateEnumStringValues

func GetRedisClusterLifecycleStateEnumStringValues() []string

GetRedisClusterLifecycleStateEnumStringValues Enumerates the set of values in String for RedisClusterLifecycleStateEnum

func GetRedisClusterSoftwareVersionEnumStringValues

func GetRedisClusterSoftwareVersionEnumStringValues() []string

GetRedisClusterSoftwareVersionEnumStringValues Enumerates the set of values in String for RedisClusterSoftwareVersionEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

Types

type ActionTypeEnum

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type AssociatedOciCacheClusterCollection added in v65.98.0

type AssociatedOciCacheClusterCollection struct {

	// List of clusters with the same OCI Cache Config Set ID.
	Items []AssociatedOciCacheClusterSummary `mandatory:"true" json:"items"`
}

AssociatedOciCacheClusterCollection Associated OCI Cache Clusters to which the OCI Cache Config Set is associated.

func (AssociatedOciCacheClusterCollection) String added in v65.98.0

func (AssociatedOciCacheClusterCollection) ValidateEnumValue added in v65.98.0

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

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

type AssociatedOciCacheClusterSummary added in v65.98.0

type AssociatedOciCacheClusterSummary struct {

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

AssociatedOciCacheClusterSummary Summary of the Clusters associated with an OCI Cache Config Set.

func (AssociatedOciCacheClusterSummary) String added in v65.98.0

func (AssociatedOciCacheClusterSummary) ValidateEnumValue added in v65.98.0

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

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

type AttachOciCacheUsersDetails added in v65.93.2

type AttachOciCacheUsersDetails struct {

	// List of OCI cache user unique IDs (OCIDs).
	OciCacheUsers []string `mandatory:"true" json:"ociCacheUsers"`
}

AttachOciCacheUsersDetails OCI cache user details to be attached with a cluster.

func (AttachOciCacheUsersDetails) String added in v65.93.2

func (AttachOciCacheUsersDetails) ValidateEnumValue added in v65.93.2

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

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

type AttachOciCacheUsersRequest added in v65.93.2

type AttachOciCacheUsersRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster.
	RedisClusterId *string `mandatory:"true" contributesTo:"path" name:"redisClusterId"`

	// The parameter details to attach the OCI cache users to the redis cluster.
	AttachOciCacheUsersDetails `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"`

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

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

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

AttachOciCacheUsersRequest wrapper for the AttachOciCacheUsers operation

See also

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

func (AttachOciCacheUsersRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (AttachOciCacheUsersRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (AttachOciCacheUsersRequest) RetryPolicy added in v65.93.2

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

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

func (AttachOciCacheUsersRequest) String added in v65.93.2

func (request AttachOciCacheUsersRequest) String() string

func (AttachOciCacheUsersRequest) ValidateEnumValue added in v65.93.2

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

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

type AttachOciCacheUsersResponse added in v65.93.2

type AttachOciCacheUsersResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

AttachOciCacheUsersResponse wrapper for the AttachOciCacheUsers operation

func (AttachOciCacheUsersResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (AttachOciCacheUsersResponse) String added in v65.93.2

func (response AttachOciCacheUsersResponse) String() string

type AttachedOciCacheCluster added in v65.93.2

type AttachedOciCacheCluster struct {

	// OCID of the OciCacheCluster
	OciCacheClusterId *string `mandatory:"true" json:"ociCacheClusterId"`
}

AttachedOciCacheCluster OciCacheCluster to which the OciCacheUser is attached.

func (AttachedOciCacheCluster) String added in v65.93.2

func (m AttachedOciCacheCluster) String() string

func (AttachedOciCacheCluster) ValidateEnumValue added in v65.93.2

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

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

type AttachedOciCacheUser added in v65.93.2

type AttachedOciCacheUser struct {

	// OCID of the OciCacheUser
	OciCacheUserId *string `mandatory:"true" json:"ociCacheUserId"`
}

AttachedOciCacheUser OciCacheUser attached to the OciCacheCluster.

func (AttachedOciCacheUser) String added in v65.93.2

func (m AttachedOciCacheUser) String() string

func (AttachedOciCacheUser) ValidateEnumValue added in v65.93.2

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

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

type AuthenticationMode added in v65.93.2

type AuthenticationMode interface {
}

AuthenticationMode These are the Authentication details of an OCI cache user.

type AuthenticationModeAuthenticationTypeEnum added in v65.93.2

type AuthenticationModeAuthenticationTypeEnum string

AuthenticationModeAuthenticationTypeEnum Enum with underlying type: string

const (
	AuthenticationModeAuthenticationTypeIam      AuthenticationModeAuthenticationTypeEnum = "IAM"
	AuthenticationModeAuthenticationTypePassword AuthenticationModeAuthenticationTypeEnum = "PASSWORD"
)

Set of constants representing the allowable values for AuthenticationModeAuthenticationTypeEnum

func GetAuthenticationModeAuthenticationTypeEnumValues added in v65.93.2

func GetAuthenticationModeAuthenticationTypeEnumValues() []AuthenticationModeAuthenticationTypeEnum

GetAuthenticationModeAuthenticationTypeEnumValues Enumerates the set of values for AuthenticationModeAuthenticationTypeEnum

func GetMappingAuthenticationModeAuthenticationTypeEnum added in v65.93.2

func GetMappingAuthenticationModeAuthenticationTypeEnum(val string) (AuthenticationModeAuthenticationTypeEnum, bool)

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

type CancelWorkRequestRequest

type CancelWorkRequestRequest struct {

	// The the asynchronous request ID.
	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"`

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

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

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

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

func (CancelWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy

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

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

func (CancelWorkRequestRequest) String

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue

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

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

type CancelWorkRequestResponse

type CancelWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String

func (response CancelWorkRequestResponse) String() string

type ChangeOciCacheConfigSetCompartmentDetails added in v65.98.0

type ChangeOciCacheConfigSetCompartmentDetails struct {

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

ChangeOciCacheConfigSetCompartmentDetails The information for the move operation.

func (ChangeOciCacheConfigSetCompartmentDetails) String added in v65.98.0

func (ChangeOciCacheConfigSetCompartmentDetails) ValidateEnumValue added in v65.98.0

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

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

type ChangeOciCacheConfigSetCompartmentRequest added in v65.98.0

type ChangeOciCacheConfigSetCompartmentRequest struct {

	// Unique OCI Cache Config Set identifier.
	OciCacheConfigSetId *string `mandatory:"true" contributesTo:"path" name:"ociCacheConfigSetId"`

	// The information to be updated.
	ChangeOciCacheConfigSetCompartmentDetails `contributesTo:"body"`

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

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

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

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

ChangeOciCacheConfigSetCompartmentRequest wrapper for the ChangeOciCacheConfigSetCompartment operation

See also

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

func (ChangeOciCacheConfigSetCompartmentRequest) BinaryRequestBody added in v65.98.0

BinaryRequestBody implements the OCIRequest interface

func (ChangeOciCacheConfigSetCompartmentRequest) HTTPRequest added in v65.98.0

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

HTTPRequest implements the OCIRequest interface

func (ChangeOciCacheConfigSetCompartmentRequest) RetryPolicy added in v65.98.0

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

func (ChangeOciCacheConfigSetCompartmentRequest) String added in v65.98.0

func (ChangeOciCacheConfigSetCompartmentRequest) ValidateEnumValue added in v65.98.0

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

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

type ChangeOciCacheConfigSetCompartmentResponse added in v65.98.0

type ChangeOciCacheConfigSetCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

ChangeOciCacheConfigSetCompartmentResponse wrapper for the ChangeOciCacheConfigSetCompartment operation

func (ChangeOciCacheConfigSetCompartmentResponse) HTTPResponse added in v65.98.0

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

HTTPResponse implements the OCIResponse interface

func (ChangeOciCacheConfigSetCompartmentResponse) String added in v65.98.0

type ChangeOciCacheUserCompartmentDetails added in v65.93.2

type ChangeOciCacheUserCompartmentDetails struct {

	// OCID of the compartment into which the OCI cache user will be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeOciCacheUserCompartmentDetails The configuration details for the move operation.

func (ChangeOciCacheUserCompartmentDetails) String added in v65.93.2

func (ChangeOciCacheUserCompartmentDetails) ValidateEnumValue added in v65.93.2

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

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

type ChangeOciCacheUserCompartmentRequest added in v65.93.2

type ChangeOciCacheUserCompartmentRequest struct {

	// A filter to return only resources, that match with the given OCI cache user ID (OCID).
	OciCacheUserId *string `mandatory:"true" contributesTo:"path" name:"ociCacheUserId"`

	// The configuration details to move compartment operation for an OCI cache user.
	ChangeOciCacheUserCompartmentDetails `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"`

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

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

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

ChangeOciCacheUserCompartmentRequest wrapper for the ChangeOciCacheUserCompartment operation

See also

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

func (ChangeOciCacheUserCompartmentRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeOciCacheUserCompartmentRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (ChangeOciCacheUserCompartmentRequest) RetryPolicy added in v65.93.2

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

func (ChangeOciCacheUserCompartmentRequest) String added in v65.93.2

func (ChangeOciCacheUserCompartmentRequest) ValidateEnumValue added in v65.93.2

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

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

type ChangeOciCacheUserCompartmentResponse added in v65.93.2

type ChangeOciCacheUserCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

ChangeOciCacheUserCompartmentResponse wrapper for the ChangeOciCacheUserCompartment operation

func (ChangeOciCacheUserCompartmentResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (ChangeOciCacheUserCompartmentResponse) String added in v65.93.2

type ChangeRedisClusterCompartmentDetails

type ChangeRedisClusterCompartmentDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment
	// into which the cluster should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeRedisClusterCompartmentDetails The configuration details for the move operation.

func (ChangeRedisClusterCompartmentDetails) String

func (ChangeRedisClusterCompartmentDetails) ValidateEnumValue

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

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

type ChangeRedisClusterCompartmentRequest

type ChangeRedisClusterCompartmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster.
	RedisClusterId *string `mandatory:"true" contributesTo:"path" name:"redisClusterId"`

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

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

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

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

ChangeRedisClusterCompartmentRequest wrapper for the ChangeRedisClusterCompartment operation

See also

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

func (ChangeRedisClusterCompartmentRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeRedisClusterCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeRedisClusterCompartmentRequest) RetryPolicy

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

func (ChangeRedisClusterCompartmentRequest) String

func (ChangeRedisClusterCompartmentRequest) ValidateEnumValue

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

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

type ChangeRedisClusterCompartmentResponse

type ChangeRedisClusterCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

ChangeRedisClusterCompartmentResponse wrapper for the ChangeRedisClusterCompartment operation

func (ChangeRedisClusterCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeRedisClusterCompartmentResponse) String

type ConfigurationDetails added in v65.98.0

type ConfigurationDetails struct {

	// List of ConfigurationInfo objects.
	Items []ConfigurationInfo `mandatory:"true" json:"items"`
}

ConfigurationDetails List of OCI Cache Config Set Values.

func (ConfigurationDetails) String added in v65.98.0

func (m ConfigurationDetails) String() string

func (ConfigurationDetails) ValidateEnumValue added in v65.98.0

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

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

type ConfigurationInfo added in v65.98.0

type ConfigurationInfo struct {

	// Key is the configuration key.
	ConfigKey *string `mandatory:"true" json:"configKey"`

	// Value of the configuration as a string. Can represent a string, boolean, or number.
	// Example: "true", "42", or "someString".
	ConfigValue *string `mandatory:"true" json:"configValue"`
}

ConfigurationInfo Details of a configuration setting in the OCI Cache Config Set.

func (ConfigurationInfo) String added in v65.98.0

func (m ConfigurationInfo) String() string

func (ConfigurationInfo) ValidateEnumValue added in v65.98.0

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

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

type CreateIdentityTokenDetails added in v65.93.2

type CreateIdentityTokenDetails struct {

	// User public key pair
	PublicKey *string `mandatory:"true" json:"publicKey"`

	// Redis User generating identity token.
	RedisUser *string `mandatory:"true" json:"redisUser"`

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

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

CreateIdentityTokenDetails Generate an Identity token for Redis cluster

func (CreateIdentityTokenDetails) String added in v65.93.2

func (CreateIdentityTokenDetails) ValidateEnumValue added in v65.93.2

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

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

type CreateIdentityTokenRequest added in v65.93.2

type CreateIdentityTokenRequest struct {

	// Details to create the token
	CreateIdentityTokenDetails `contributesTo:"body"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster.
	RedisClusterId *string `mandatory:"true" contributesTo:"path" name:"redisClusterId"`

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

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

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

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

CreateIdentityTokenRequest wrapper for the CreateIdentityToken operation

See also

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

func (CreateIdentityTokenRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (CreateIdentityTokenRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (CreateIdentityTokenRequest) RetryPolicy added in v65.93.2

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

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

func (CreateIdentityTokenRequest) String added in v65.93.2

func (request CreateIdentityTokenRequest) String() string

func (CreateIdentityTokenRequest) ValidateEnumValue added in v65.93.2

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

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

type CreateIdentityTokenResponse added in v65.93.2

type CreateIdentityTokenResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateIdentityTokenResponse wrapper for the CreateIdentityToken operation

func (CreateIdentityTokenResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (CreateIdentityTokenResponse) String added in v65.93.2

func (response CreateIdentityTokenResponse) String() string

type CreateOciCacheConfigSetDetails added in v65.98.0

type CreateOciCacheConfigSetDetails struct {

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment that contains the OCI Cache Config Set.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCI Cache engine version that the cluster is running.
	SoftwareVersion OciCacheConfigSetSoftwareVersionEnum `mandatory:"true" json:"softwareVersion"`

	ConfigurationDetails *ConfigurationDetails `mandatory:"true" json:"configurationDetails"`

	// Description for the custom OCI Cache Config Set.
	Description *string `mandatory:"false" json:"description"`

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

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

CreateOciCacheConfigSetDetails The information to create a new OCI Cache Config Set.

func (CreateOciCacheConfigSetDetails) String added in v65.98.0

func (CreateOciCacheConfigSetDetails) ValidateEnumValue added in v65.98.0

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

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

type CreateOciCacheConfigSetRequest added in v65.98.0

type CreateOciCacheConfigSetRequest struct {

	// Details for the new OCI Cache Config Set.
	CreateOciCacheConfigSetDetails `contributesTo:"body"`

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

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

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

CreateOciCacheConfigSetRequest wrapper for the CreateOciCacheConfigSet operation

See also

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

func (CreateOciCacheConfigSetRequest) BinaryRequestBody added in v65.98.0

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

BinaryRequestBody implements the OCIRequest interface

func (CreateOciCacheConfigSetRequest) HTTPRequest added in v65.98.0

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

HTTPRequest implements the OCIRequest interface

func (CreateOciCacheConfigSetRequest) RetryPolicy added in v65.98.0

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

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

func (CreateOciCacheConfigSetRequest) String added in v65.98.0

func (request CreateOciCacheConfigSetRequest) String() string

func (CreateOciCacheConfigSetRequest) ValidateEnumValue added in v65.98.0

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

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

type CreateOciCacheConfigSetResponse added in v65.98.0

type CreateOciCacheConfigSetResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

CreateOciCacheConfigSetResponse wrapper for the CreateOciCacheConfigSet operation

func (CreateOciCacheConfigSetResponse) HTTPResponse added in v65.98.0

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

HTTPResponse implements the OCIResponse interface

func (CreateOciCacheConfigSetResponse) String added in v65.98.0

func (response CreateOciCacheConfigSetResponse) String() string

type CreateOciCacheUserDetails added in v65.93.2

type CreateOciCacheUserDetails struct {

	// OCI cache user name is required to connect to an OCI cache cluster.
	Name *string `mandatory:"true" json:"name"`

	// Description of OCI cache user.
	Description *string `mandatory:"true" json:"description"`

	// OCI cache user compartment ID.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	AuthenticationMode AuthenticationMode `mandatory:"true" json:"authenticationMode"`

	// ACL string of OCI cache user.
	AclString *string `mandatory:"true" json:"aclString"`

	// OCI cache user status. ON enables and OFF disables the OCI cache user to login to the associated clusters. Default value is ON.
	Status OciCacheUserStatusEnum `mandatory:"false" json:"status,omitempty"`

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

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

CreateOciCacheUserDetails Details required to create a new OCI cache user.

func (CreateOciCacheUserDetails) String added in v65.93.2

func (m CreateOciCacheUserDetails) String() string

func (*CreateOciCacheUserDetails) UnmarshalJSON added in v65.93.2

func (m *CreateOciCacheUserDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateOciCacheUserDetails) ValidateEnumValue added in v65.93.2

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

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

type CreateOciCacheUserRequest added in v65.93.2

type CreateOciCacheUserRequest struct {

	// Details required to create a new OCI cache user.
	CreateOciCacheUserDetails `contributesTo:"body"`

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

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

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

CreateOciCacheUserRequest wrapper for the CreateOciCacheUser operation

See also

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

func (CreateOciCacheUserRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (CreateOciCacheUserRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (CreateOciCacheUserRequest) RetryPolicy added in v65.93.2

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

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

func (CreateOciCacheUserRequest) String added in v65.93.2

func (request CreateOciCacheUserRequest) String() string

func (CreateOciCacheUserRequest) ValidateEnumValue added in v65.93.2

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

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

type CreateOciCacheUserResponse added in v65.93.2

type CreateOciCacheUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

CreateOciCacheUserResponse wrapper for the CreateOciCacheUser operation

func (CreateOciCacheUserResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (CreateOciCacheUserResponse) String added in v65.93.2

func (response CreateOciCacheUserResponse) String() string

type CreateRedisClusterDetails

type CreateRedisClusterDetails struct {

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

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

	// The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
	NodeCount *int `mandatory:"true" json:"nodeCount"`

	// The OCI Cache engine version that the cluster is running.
	SoftwareVersion RedisClusterSoftwareVersionEnum `mandatory:"true" json:"softwareVersion"`

	// The amount of memory allocated to the cluster's nodes, in gigabytes.
	NodeMemoryInGBs *float32 `mandatory:"true" json:"nodeMemoryInGBs"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster's subnet.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// The ID of the corresponding OCI Cache Config Set for the cluster.
	OciCacheConfigSetId *string `mandatory:"false" json:"ociCacheConfigSetId"`

	// Specifies whether the cluster is sharded or non-sharded.
	ClusterMode RedisClusterClusterModeEnum `mandatory:"false" json:"clusterMode,omitempty"`

	// The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.
	ShardCount *int `mandatory:"false" json:"shardCount"`

	// A list of Network Security Group (NSG) OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
	// associated with this cluster. For more information,
	// see Using an NSG for Clusters (https://docs.oracle.com/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup).
	NsgIds []string `mandatory:"false" json:"nsgIds"`

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

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

CreateRedisClusterDetails The configuration details for a new OCI Cache cluster. An OCI Cache cluster is a memory-based storage solution. For more information, see OCI Cache (https://docs.oracle.com/iaas/Content/ocicache/home.htm).

func (CreateRedisClusterDetails) String

func (m CreateRedisClusterDetails) String() string

func (CreateRedisClusterDetails) ValidateEnumValue

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

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

type CreateRedisClusterRequest

type CreateRedisClusterRequest struct {

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

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

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

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

CreateRedisClusterRequest wrapper for the CreateRedisCluster operation

See also

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

func (CreateRedisClusterRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateRedisClusterRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateRedisClusterRequest) RetryPolicy

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

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

func (CreateRedisClusterRequest) String

func (request CreateRedisClusterRequest) String() string

func (CreateRedisClusterRequest) ValidateEnumValue

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

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

type CreateRedisClusterResponse

type CreateRedisClusterResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

CreateRedisClusterResponse wrapper for the CreateRedisCluster operation

func (CreateRedisClusterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateRedisClusterResponse) String

func (response CreateRedisClusterResponse) String() string

type DefaultConfigurationDetails added in v65.98.0

type DefaultConfigurationDetails struct {

	// List of DefaultConfigurationInfo objects.
	Items []DefaultConfigurationInfo `mandatory:"true" json:"items"`
}

DefaultConfigurationDetails List of OCI Cache Default Config Set Values.

func (DefaultConfigurationDetails) String added in v65.98.0

func (DefaultConfigurationDetails) ValidateEnumValue added in v65.98.0

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

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

type DefaultConfigurationInfo added in v65.98.0

type DefaultConfigurationInfo struct {

	// The key of the configuration setting.
	ConfigKey *string `mandatory:"true" json:"configKey"`

	// The default value for the configuration setting.
	DefaultConfigValue *string `mandatory:"true" json:"defaultConfigValue"`

	// The data type of the configuration setting.
	DataType *string `mandatory:"true" json:"dataType"`

	// Indicates if the configuration is modifiable.
	IsModifiable *bool `mandatory:"true" json:"isModifiable"`

	// Allowed values for the configuration setting.
	AllowedValues *string `mandatory:"false" json:"allowedValues"`

	// Description of the configuration setting.
	Description *string `mandatory:"false" json:"description"`
}

DefaultConfigurationInfo Details of a configuration setting in the OCI Cache Default Config Set.

func (DefaultConfigurationInfo) String added in v65.98.0

func (m DefaultConfigurationInfo) String() string

func (DefaultConfigurationInfo) ValidateEnumValue added in v65.98.0

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

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

type DeleteOciCacheConfigSetRequest added in v65.98.0

type DeleteOciCacheConfigSetRequest struct {

	// Unique OCI Cache Config Set identifier.
	OciCacheConfigSetId *string `mandatory:"true" contributesTo:"path" name:"ociCacheConfigSetId"`

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

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

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

DeleteOciCacheConfigSetRequest wrapper for the DeleteOciCacheConfigSet operation

See also

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

func (DeleteOciCacheConfigSetRequest) BinaryRequestBody added in v65.98.0

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteOciCacheConfigSetRequest) HTTPRequest added in v65.98.0

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

HTTPRequest implements the OCIRequest interface

func (DeleteOciCacheConfigSetRequest) RetryPolicy added in v65.98.0

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

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

func (DeleteOciCacheConfigSetRequest) String added in v65.98.0

func (request DeleteOciCacheConfigSetRequest) String() string

func (DeleteOciCacheConfigSetRequest) ValidateEnumValue added in v65.98.0

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

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

type DeleteOciCacheConfigSetResponse added in v65.98.0

type DeleteOciCacheConfigSetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

DeleteOciCacheConfigSetResponse wrapper for the DeleteOciCacheConfigSet operation

func (DeleteOciCacheConfigSetResponse) HTTPResponse added in v65.98.0

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

HTTPResponse implements the OCIResponse interface

func (DeleteOciCacheConfigSetResponse) String added in v65.98.0

func (response DeleteOciCacheConfigSetResponse) String() string

type DeleteOciCacheUserRequest added in v65.93.2

type DeleteOciCacheUserRequest struct {

	// A filter to return only resources, that match with the given OCI cache user ID (OCID).
	OciCacheUserId *string `mandatory:"true" contributesTo:"path" name:"ociCacheUserId"`

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

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

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

DeleteOciCacheUserRequest wrapper for the DeleteOciCacheUser operation

See also

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

func (DeleteOciCacheUserRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteOciCacheUserRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (DeleteOciCacheUserRequest) RetryPolicy added in v65.93.2

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

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

func (DeleteOciCacheUserRequest) String added in v65.93.2

func (request DeleteOciCacheUserRequest) String() string

func (DeleteOciCacheUserRequest) ValidateEnumValue added in v65.93.2

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

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

type DeleteOciCacheUserResponse added in v65.93.2

type DeleteOciCacheUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

DeleteOciCacheUserResponse wrapper for the DeleteOciCacheUser operation

func (DeleteOciCacheUserResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (DeleteOciCacheUserResponse) String added in v65.93.2

func (response DeleteOciCacheUserResponse) String() string

type DeleteRedisClusterRequest

type DeleteRedisClusterRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster.
	RedisClusterId *string `mandatory:"true" contributesTo:"path" name:"redisClusterId"`

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

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

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

DeleteRedisClusterRequest wrapper for the DeleteRedisCluster operation

See also

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

func (DeleteRedisClusterRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteRedisClusterRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteRedisClusterRequest) RetryPolicy

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

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

func (DeleteRedisClusterRequest) String

func (request DeleteRedisClusterRequest) String() string

func (DeleteRedisClusterRequest) ValidateEnumValue

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

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

type DeleteRedisClusterResponse

type DeleteRedisClusterResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

DeleteRedisClusterResponse wrapper for the DeleteRedisCluster operation

func (DeleteRedisClusterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteRedisClusterResponse) String

func (response DeleteRedisClusterResponse) String() string

type DetachOciCacheUsersDetails added in v65.93.2

type DetachOciCacheUsersDetails struct {

	// List of OCI cache user unique IDs (OCIDs).
	OciCacheUsers []string `mandatory:"true" json:"ociCacheUsers"`
}

DetachOciCacheUsersDetails OCI cache user details to be detached with a cluster.

func (DetachOciCacheUsersDetails) String added in v65.93.2

func (DetachOciCacheUsersDetails) ValidateEnumValue added in v65.93.2

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

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

type DetachOciCacheUsersRequest added in v65.93.2

type DetachOciCacheUsersRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster.
	RedisClusterId *string `mandatory:"true" contributesTo:"path" name:"redisClusterId"`

	// The parameter details to detach the OCI cache users to the redis cluster.
	DetachOciCacheUsersDetails `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"`

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

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

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

DetachOciCacheUsersRequest wrapper for the DetachOciCacheUsers operation

See also

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

func (DetachOciCacheUsersRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (DetachOciCacheUsersRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (DetachOciCacheUsersRequest) RetryPolicy added in v65.93.2

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

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

func (DetachOciCacheUsersRequest) String added in v65.93.2

func (request DetachOciCacheUsersRequest) String() string

func (DetachOciCacheUsersRequest) ValidateEnumValue added in v65.93.2

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

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

type DetachOciCacheUsersResponse added in v65.93.2

type DetachOciCacheUsersResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

DetachOciCacheUsersResponse wrapper for the DetachOciCacheUsers operation

func (DetachOciCacheUsersResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (DetachOciCacheUsersResponse) String added in v65.93.2

func (response DetachOciCacheUsersResponse) String() string

type GetOciCacheConfigSetRequest added in v65.98.0

type GetOciCacheConfigSetRequest struct {

	// Unique OCI Cache Config Set identifier.
	OciCacheConfigSetId *string `mandatory:"true" contributesTo:"path" name:"ociCacheConfigSetId"`

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

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

GetOciCacheConfigSetRequest wrapper for the GetOciCacheConfigSet operation

See also

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

func (GetOciCacheConfigSetRequest) BinaryRequestBody added in v65.98.0

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

BinaryRequestBody implements the OCIRequest interface

func (GetOciCacheConfigSetRequest) HTTPRequest added in v65.98.0

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

HTTPRequest implements the OCIRequest interface

func (GetOciCacheConfigSetRequest) RetryPolicy added in v65.98.0

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

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

func (GetOciCacheConfigSetRequest) String added in v65.98.0

func (request GetOciCacheConfigSetRequest) String() string

func (GetOciCacheConfigSetRequest) ValidateEnumValue added in v65.98.0

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

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

type GetOciCacheConfigSetResponse added in v65.98.0

type GetOciCacheConfigSetResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetOciCacheConfigSetResponse wrapper for the GetOciCacheConfigSet operation

func (GetOciCacheConfigSetResponse) HTTPResponse added in v65.98.0

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

HTTPResponse implements the OCIResponse interface

func (GetOciCacheConfigSetResponse) String added in v65.98.0

func (response GetOciCacheConfigSetResponse) String() string

type GetOciCacheDefaultConfigSetRequest added in v65.98.0

type GetOciCacheDefaultConfigSetRequest struct {

	// The unique identifier for the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Unique OCI Cache Default Config Set identifier.
	OciCacheDefaultConfigSetId *string `mandatory:"true" contributesTo:"path" name:"ociCacheDefaultConfigSetId"`

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

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

GetOciCacheDefaultConfigSetRequest wrapper for the GetOciCacheDefaultConfigSet operation

See also

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

func (GetOciCacheDefaultConfigSetRequest) BinaryRequestBody added in v65.98.0

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

BinaryRequestBody implements the OCIRequest interface

func (GetOciCacheDefaultConfigSetRequest) HTTPRequest added in v65.98.0

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

HTTPRequest implements the OCIRequest interface

func (GetOciCacheDefaultConfigSetRequest) RetryPolicy added in v65.98.0

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

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

func (GetOciCacheDefaultConfigSetRequest) String added in v65.98.0

func (request GetOciCacheDefaultConfigSetRequest) String() string

func (GetOciCacheDefaultConfigSetRequest) ValidateEnumValue added in v65.98.0

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

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

type GetOciCacheDefaultConfigSetResponse added in v65.98.0

type GetOciCacheDefaultConfigSetResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetOciCacheDefaultConfigSetResponse wrapper for the GetOciCacheDefaultConfigSet operation

func (GetOciCacheDefaultConfigSetResponse) HTTPResponse added in v65.98.0

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

HTTPResponse implements the OCIResponse interface

func (GetOciCacheDefaultConfigSetResponse) String added in v65.98.0

func (response GetOciCacheDefaultConfigSetResponse) String() string

type GetOciCacheUserRequest added in v65.93.2

type GetOciCacheUserRequest struct {

	// A filter to return only resources, that match with the given OCI cache user ID (OCID).
	OciCacheUserId *string `mandatory:"true" contributesTo:"path" name:"ociCacheUserId"`

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

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

GetOciCacheUserRequest wrapper for the GetOciCacheUser operation

See also

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

func (GetOciCacheUserRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (GetOciCacheUserRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (GetOciCacheUserRequest) RetryPolicy added in v65.93.2

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

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

func (GetOciCacheUserRequest) String added in v65.93.2

func (request GetOciCacheUserRequest) String() string

func (GetOciCacheUserRequest) ValidateEnumValue added in v65.93.2

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

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

type GetOciCacheUserResponse added in v65.93.2

type GetOciCacheUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetOciCacheUserResponse wrapper for the GetOciCacheUser operation

func (GetOciCacheUserResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (GetOciCacheUserResponse) String added in v65.93.2

func (response GetOciCacheUserResponse) String() string

type GetRedisClusterRequest

type GetRedisClusterRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster.
	RedisClusterId *string `mandatory:"true" contributesTo:"path" name:"redisClusterId"`

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

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

GetRedisClusterRequest wrapper for the GetRedisCluster operation

See also

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

func (GetRedisClusterRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetRedisClusterRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetRedisClusterRequest) RetryPolicy

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

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

func (GetRedisClusterRequest) String

func (request GetRedisClusterRequest) String() string

func (GetRedisClusterRequest) ValidateEnumValue

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

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

type GetRedisClusterResponse

type GetRedisClusterResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetRedisClusterResponse wrapper for the GetRedisCluster operation

func (GetRedisClusterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetRedisClusterResponse) String

func (response GetRedisClusterResponse) String() string

type GetWorkRequestRequest

type GetWorkRequestRequest struct {

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

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

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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

func (GetWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

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

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

type GetWorkRequestResponse

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type IamAuthenticationMode added in v65.93.2

type IamAuthenticationMode struct {
}

IamAuthenticationMode child class of AuthenticationMode.

func (IamAuthenticationMode) MarshalJSON added in v65.93.2

func (m IamAuthenticationMode) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (IamAuthenticationMode) String added in v65.93.2

func (m IamAuthenticationMode) String() string

func (IamAuthenticationMode) ValidateEnumValue added in v65.93.2

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

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

type IdentityTokenDetailsResponse added in v65.93.2

type IdentityTokenDetailsResponse struct {

	// Generated Identity token
	IdentityToken *string `mandatory:"true" json:"identityToken"`

	// Redis user for the newly created identity token
	RedisUser *string `mandatory:"true" json:"redisUser"`
}

IdentityTokenDetailsResponse Response an Identity token generated for Redis cluster

func (IdentityTokenDetailsResponse) String added in v65.93.2

func (IdentityTokenDetailsResponse) ValidateEnumValue added in v65.93.2

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

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

type ListAssociatedOciCacheClustersRequest added in v65.98.0

type ListAssociatedOciCacheClustersRequest struct {

	// Unique OCI Cache Config Set identifier.
	OciCacheConfigSetId *string `mandatory:"true" contributesTo:"path" name:"ociCacheConfigSetId"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListAssociatedOciCacheClustersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

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

ListAssociatedOciCacheClustersRequest wrapper for the ListAssociatedOciCacheClusters operation

See also

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

func (ListAssociatedOciCacheClustersRequest) BinaryRequestBody added in v65.98.0

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

BinaryRequestBody implements the OCIRequest interface

func (ListAssociatedOciCacheClustersRequest) HTTPRequest added in v65.98.0

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

HTTPRequest implements the OCIRequest interface

func (ListAssociatedOciCacheClustersRequest) RetryPolicy added in v65.98.0

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

func (ListAssociatedOciCacheClustersRequest) String added in v65.98.0

func (ListAssociatedOciCacheClustersRequest) ValidateEnumValue added in v65.98.0

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

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

type ListAssociatedOciCacheClustersResponse added in v65.98.0

type ListAssociatedOciCacheClustersResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListAssociatedOciCacheClustersResponse wrapper for the ListAssociatedOciCacheClusters operation

func (ListAssociatedOciCacheClustersResponse) HTTPResponse added in v65.98.0

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

HTTPResponse implements the OCIResponse interface

func (ListAssociatedOciCacheClustersResponse) String added in v65.98.0

type ListAssociatedOciCacheClustersSortByEnum added in v65.98.0

type ListAssociatedOciCacheClustersSortByEnum string

ListAssociatedOciCacheClustersSortByEnum Enum with underlying type: string

const (
	ListAssociatedOciCacheClustersSortByTimecreated ListAssociatedOciCacheClustersSortByEnum = "timeCreated"
	ListAssociatedOciCacheClustersSortByDisplayname ListAssociatedOciCacheClustersSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListAssociatedOciCacheClustersSortByEnum

func GetListAssociatedOciCacheClustersSortByEnumValues added in v65.98.0

func GetListAssociatedOciCacheClustersSortByEnumValues() []ListAssociatedOciCacheClustersSortByEnum

GetListAssociatedOciCacheClustersSortByEnumValues Enumerates the set of values for ListAssociatedOciCacheClustersSortByEnum

func GetMappingListAssociatedOciCacheClustersSortByEnum added in v65.98.0

func GetMappingListAssociatedOciCacheClustersSortByEnum(val string) (ListAssociatedOciCacheClustersSortByEnum, bool)

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

type ListAssociatedOciCacheClustersSortOrderEnum added in v65.98.0

type ListAssociatedOciCacheClustersSortOrderEnum string

ListAssociatedOciCacheClustersSortOrderEnum Enum with underlying type: string

const (
	ListAssociatedOciCacheClustersSortOrderAsc  ListAssociatedOciCacheClustersSortOrderEnum = "ASC"
	ListAssociatedOciCacheClustersSortOrderDesc ListAssociatedOciCacheClustersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAssociatedOciCacheClustersSortOrderEnum

func GetListAssociatedOciCacheClustersSortOrderEnumValues added in v65.98.0

func GetListAssociatedOciCacheClustersSortOrderEnumValues() []ListAssociatedOciCacheClustersSortOrderEnum

GetListAssociatedOciCacheClustersSortOrderEnumValues Enumerates the set of values for ListAssociatedOciCacheClustersSortOrderEnum

func GetMappingListAssociatedOciCacheClustersSortOrderEnum added in v65.98.0

func GetMappingListAssociatedOciCacheClustersSortOrderEnum(val string) (ListAssociatedOciCacheClustersSortOrderEnum, bool)

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

type ListAttachedOciCacheUsersRequest added in v65.93.2

type ListAttachedOciCacheUsersRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster.
	RedisClusterId *string `mandatory:"true" contributesTo:"path" name:"redisClusterId"`

	// The ID 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 entire display name given.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListAttachedOciCacheUsersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

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

ListAttachedOciCacheUsersRequest wrapper for the ListAttachedOciCacheUsers operation

See also

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

func (ListAttachedOciCacheUsersRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (ListAttachedOciCacheUsersRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (ListAttachedOciCacheUsersRequest) RetryPolicy added in v65.93.2

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

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

func (ListAttachedOciCacheUsersRequest) String added in v65.93.2

func (request ListAttachedOciCacheUsersRequest) String() string

func (ListAttachedOciCacheUsersRequest) ValidateEnumValue added in v65.93.2

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

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

type ListAttachedOciCacheUsersResponse added in v65.93.2

type ListAttachedOciCacheUsersResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListAttachedOciCacheUsersResponse wrapper for the ListAttachedOciCacheUsers operation

func (ListAttachedOciCacheUsersResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (ListAttachedOciCacheUsersResponse) String added in v65.93.2

func (response ListAttachedOciCacheUsersResponse) String() string

type ListAttachedOciCacheUsersSortByEnum added in v65.93.2

type ListAttachedOciCacheUsersSortByEnum string

ListAttachedOciCacheUsersSortByEnum Enum with underlying type: string

const (
	ListAttachedOciCacheUsersSortByTimecreated ListAttachedOciCacheUsersSortByEnum = "timeCreated"
	ListAttachedOciCacheUsersSortByDisplayname ListAttachedOciCacheUsersSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListAttachedOciCacheUsersSortByEnum

func GetListAttachedOciCacheUsersSortByEnumValues added in v65.93.2

func GetListAttachedOciCacheUsersSortByEnumValues() []ListAttachedOciCacheUsersSortByEnum

GetListAttachedOciCacheUsersSortByEnumValues Enumerates the set of values for ListAttachedOciCacheUsersSortByEnum

func GetMappingListAttachedOciCacheUsersSortByEnum added in v65.93.2

func GetMappingListAttachedOciCacheUsersSortByEnum(val string) (ListAttachedOciCacheUsersSortByEnum, bool)

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

type ListAttachedOciCacheUsersSortOrderEnum added in v65.93.2

type ListAttachedOciCacheUsersSortOrderEnum string

ListAttachedOciCacheUsersSortOrderEnum Enum with underlying type: string

const (
	ListAttachedOciCacheUsersSortOrderAsc  ListAttachedOciCacheUsersSortOrderEnum = "ASC"
	ListAttachedOciCacheUsersSortOrderDesc ListAttachedOciCacheUsersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAttachedOciCacheUsersSortOrderEnum

func GetListAttachedOciCacheUsersSortOrderEnumValues added in v65.93.2

func GetListAttachedOciCacheUsersSortOrderEnumValues() []ListAttachedOciCacheUsersSortOrderEnum

GetListAttachedOciCacheUsersSortOrderEnumValues Enumerates the set of values for ListAttachedOciCacheUsersSortOrderEnum

func GetMappingListAttachedOciCacheUsersSortOrderEnum added in v65.93.2

func GetMappingListAttachedOciCacheUsersSortOrderEnum(val string) (ListAttachedOciCacheUsersSortOrderEnum, bool)

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

type ListAttachedRedisClustersRequest added in v65.93.2

type ListAttachedRedisClustersRequest struct {

	// A filter to return only resources, that match with the given OCI cache user ID (OCID).
	OciCacheUserId *string `mandatory:"true" contributesTo:"path" name:"ociCacheUserId"`

	// The ID 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 entire display name given.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListAttachedRedisClustersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

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

ListAttachedRedisClustersRequest wrapper for the ListAttachedRedisClusters operation

See also

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

func (ListAttachedRedisClustersRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (ListAttachedRedisClustersRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (ListAttachedRedisClustersRequest) RetryPolicy added in v65.93.2

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

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

func (ListAttachedRedisClustersRequest) String added in v65.93.2

func (request ListAttachedRedisClustersRequest) String() string

func (ListAttachedRedisClustersRequest) ValidateEnumValue added in v65.93.2

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

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

type ListAttachedRedisClustersResponse added in v65.93.2

type ListAttachedRedisClustersResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListAttachedRedisClustersResponse wrapper for the ListAttachedRedisClusters operation

func (ListAttachedRedisClustersResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (ListAttachedRedisClustersResponse) String added in v65.93.2

func (response ListAttachedRedisClustersResponse) String() string

type ListAttachedRedisClustersSortByEnum added in v65.93.2

type ListAttachedRedisClustersSortByEnum string

ListAttachedRedisClustersSortByEnum Enum with underlying type: string

const (
	ListAttachedRedisClustersSortByTimecreated ListAttachedRedisClustersSortByEnum = "timeCreated"
	ListAttachedRedisClustersSortByDisplayname ListAttachedRedisClustersSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListAttachedRedisClustersSortByEnum

func GetListAttachedRedisClustersSortByEnumValues added in v65.93.2

func GetListAttachedRedisClustersSortByEnumValues() []ListAttachedRedisClustersSortByEnum

GetListAttachedRedisClustersSortByEnumValues Enumerates the set of values for ListAttachedRedisClustersSortByEnum

func GetMappingListAttachedRedisClustersSortByEnum added in v65.93.2

func GetMappingListAttachedRedisClustersSortByEnum(val string) (ListAttachedRedisClustersSortByEnum, bool)

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

type ListAttachedRedisClustersSortOrderEnum added in v65.93.2

type ListAttachedRedisClustersSortOrderEnum string

ListAttachedRedisClustersSortOrderEnum Enum with underlying type: string

const (
	ListAttachedRedisClustersSortOrderAsc  ListAttachedRedisClustersSortOrderEnum = "ASC"
	ListAttachedRedisClustersSortOrderDesc ListAttachedRedisClustersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAttachedRedisClustersSortOrderEnum

func GetListAttachedRedisClustersSortOrderEnumValues added in v65.93.2

func GetListAttachedRedisClustersSortOrderEnumValues() []ListAttachedRedisClustersSortOrderEnum

GetListAttachedRedisClustersSortOrderEnumValues Enumerates the set of values for ListAttachedRedisClustersSortOrderEnum

func GetMappingListAttachedRedisClustersSortOrderEnum added in v65.93.2

func GetMappingListAttachedRedisClustersSortOrderEnum(val string) (ListAttachedRedisClustersSortOrderEnum, bool)

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

type ListOciCacheConfigSetsRequest added in v65.98.0

type ListOciCacheConfigSetsRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return the OCI Cache Config Set resources, whose lifecycle state matches with the given lifecycle state.
	LifecycleState OciCacheConfigSetLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return the OCI Cache Config Set resources, whose software version matches with the given software version.
	SoftwareVersion OciCacheConfigSetSoftwareVersionEnum `mandatory:"false" contributesTo:"query" name:"softwareVersion" omitEmpty:"true"`

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

	// Unique OCI Cache Config Set identifier.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListOciCacheConfigSetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

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

ListOciCacheConfigSetsRequest wrapper for the ListOciCacheConfigSets operation

See also

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

func (ListOciCacheConfigSetsRequest) BinaryRequestBody added in v65.98.0

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

BinaryRequestBody implements the OCIRequest interface

func (ListOciCacheConfigSetsRequest) HTTPRequest added in v65.98.0

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

HTTPRequest implements the OCIRequest interface

func (ListOciCacheConfigSetsRequest) RetryPolicy added in v65.98.0

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

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

func (ListOciCacheConfigSetsRequest) String added in v65.98.0

func (request ListOciCacheConfigSetsRequest) String() string

func (ListOciCacheConfigSetsRequest) ValidateEnumValue added in v65.98.0

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

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

type ListOciCacheConfigSetsResponse added in v65.98.0

type ListOciCacheConfigSetsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListOciCacheConfigSetsResponse wrapper for the ListOciCacheConfigSets operation

func (ListOciCacheConfigSetsResponse) HTTPResponse added in v65.98.0

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

HTTPResponse implements the OCIResponse interface

func (ListOciCacheConfigSetsResponse) String added in v65.98.0

func (response ListOciCacheConfigSetsResponse) String() string

type ListOciCacheConfigSetsSortByEnum added in v65.98.0

type ListOciCacheConfigSetsSortByEnum string

ListOciCacheConfigSetsSortByEnum Enum with underlying type: string

const (
	ListOciCacheConfigSetsSortByTimecreated ListOciCacheConfigSetsSortByEnum = "timeCreated"
	ListOciCacheConfigSetsSortByDisplayname ListOciCacheConfigSetsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListOciCacheConfigSetsSortByEnum

func GetListOciCacheConfigSetsSortByEnumValues added in v65.98.0

func GetListOciCacheConfigSetsSortByEnumValues() []ListOciCacheConfigSetsSortByEnum

GetListOciCacheConfigSetsSortByEnumValues Enumerates the set of values for ListOciCacheConfigSetsSortByEnum

func GetMappingListOciCacheConfigSetsSortByEnum added in v65.98.0

func GetMappingListOciCacheConfigSetsSortByEnum(val string) (ListOciCacheConfigSetsSortByEnum, bool)

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

type ListOciCacheConfigSetsSortOrderEnum added in v65.98.0

type ListOciCacheConfigSetsSortOrderEnum string

ListOciCacheConfigSetsSortOrderEnum Enum with underlying type: string

const (
	ListOciCacheConfigSetsSortOrderAsc  ListOciCacheConfigSetsSortOrderEnum = "ASC"
	ListOciCacheConfigSetsSortOrderDesc ListOciCacheConfigSetsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOciCacheConfigSetsSortOrderEnum

func GetListOciCacheConfigSetsSortOrderEnumValues added in v65.98.0

func GetListOciCacheConfigSetsSortOrderEnumValues() []ListOciCacheConfigSetsSortOrderEnum

GetListOciCacheConfigSetsSortOrderEnumValues Enumerates the set of values for ListOciCacheConfigSetsSortOrderEnum

func GetMappingListOciCacheConfigSetsSortOrderEnum added in v65.98.0

func GetMappingListOciCacheConfigSetsSortOrderEnum(val string) (ListOciCacheConfigSetsSortOrderEnum, bool)

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

type ListOciCacheDefaultConfigSetsRequest added in v65.98.0

type ListOciCacheDefaultConfigSetsRequest struct {

	// The unique identifier for the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Unique OCI Cache Default Config Set identifier.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// A filter to return the OCI Cache Default Config Set resources, whose lifecycle state matches with the given lifecycle state.
	LifecycleState OciCacheDefaultConfigSetLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return the OCI Cache Config Set resources, whose software version matches with the given software version.
	SoftwareVersion OciCacheConfigSetSoftwareVersionEnum `mandatory:"false" contributesTo:"query" name:"softwareVersion" omitEmpty:"true"`

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

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

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListOciCacheDefaultConfigSetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

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

ListOciCacheDefaultConfigSetsRequest wrapper for the ListOciCacheDefaultConfigSets operation

See also

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

func (ListOciCacheDefaultConfigSetsRequest) BinaryRequestBody added in v65.98.0

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

BinaryRequestBody implements the OCIRequest interface

func (ListOciCacheDefaultConfigSetsRequest) HTTPRequest added in v65.98.0

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

HTTPRequest implements the OCIRequest interface

func (ListOciCacheDefaultConfigSetsRequest) RetryPolicy added in v65.98.0

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

func (ListOciCacheDefaultConfigSetsRequest) String added in v65.98.0

func (ListOciCacheDefaultConfigSetsRequest) ValidateEnumValue added in v65.98.0

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

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

type ListOciCacheDefaultConfigSetsResponse added in v65.98.0

type ListOciCacheDefaultConfigSetsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListOciCacheDefaultConfigSetsResponse wrapper for the ListOciCacheDefaultConfigSets operation

func (ListOciCacheDefaultConfigSetsResponse) HTTPResponse added in v65.98.0

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

HTTPResponse implements the OCIResponse interface

func (ListOciCacheDefaultConfigSetsResponse) String added in v65.98.0

type ListOciCacheDefaultConfigSetsSortByEnum added in v65.98.0

type ListOciCacheDefaultConfigSetsSortByEnum string

ListOciCacheDefaultConfigSetsSortByEnum Enum with underlying type: string

const (
	ListOciCacheDefaultConfigSetsSortByTimecreated ListOciCacheDefaultConfigSetsSortByEnum = "timeCreated"
	ListOciCacheDefaultConfigSetsSortByDisplayname ListOciCacheDefaultConfigSetsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListOciCacheDefaultConfigSetsSortByEnum

func GetListOciCacheDefaultConfigSetsSortByEnumValues added in v65.98.0

func GetListOciCacheDefaultConfigSetsSortByEnumValues() []ListOciCacheDefaultConfigSetsSortByEnum

GetListOciCacheDefaultConfigSetsSortByEnumValues Enumerates the set of values for ListOciCacheDefaultConfigSetsSortByEnum

func GetMappingListOciCacheDefaultConfigSetsSortByEnum added in v65.98.0

func GetMappingListOciCacheDefaultConfigSetsSortByEnum(val string) (ListOciCacheDefaultConfigSetsSortByEnum, bool)

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

type ListOciCacheDefaultConfigSetsSortOrderEnum added in v65.98.0

type ListOciCacheDefaultConfigSetsSortOrderEnum string

ListOciCacheDefaultConfigSetsSortOrderEnum Enum with underlying type: string

const (
	ListOciCacheDefaultConfigSetsSortOrderAsc  ListOciCacheDefaultConfigSetsSortOrderEnum = "ASC"
	ListOciCacheDefaultConfigSetsSortOrderDesc ListOciCacheDefaultConfigSetsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOciCacheDefaultConfigSetsSortOrderEnum

func GetListOciCacheDefaultConfigSetsSortOrderEnumValues added in v65.98.0

func GetListOciCacheDefaultConfigSetsSortOrderEnumValues() []ListOciCacheDefaultConfigSetsSortOrderEnum

GetListOciCacheDefaultConfigSetsSortOrderEnumValues Enumerates the set of values for ListOciCacheDefaultConfigSetsSortOrderEnum

func GetMappingListOciCacheDefaultConfigSetsSortOrderEnum added in v65.98.0

func GetMappingListOciCacheDefaultConfigSetsSortOrderEnum(val string) (ListOciCacheDefaultConfigSetsSortOrderEnum, bool)

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

type ListOciCacheUsersRequest added in v65.93.2

type ListOciCacheUsersRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return the resources that match with the given OCI cache user name.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// A filter to return the resources, whose lifecycleState matches with the given lifecycleState.
	LifecycleState OciCacheUserLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListOciCacheUsersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

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

ListOciCacheUsersRequest wrapper for the ListOciCacheUsers operation

See also

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

func (ListOciCacheUsersRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (ListOciCacheUsersRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (ListOciCacheUsersRequest) RetryPolicy added in v65.93.2

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

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

func (ListOciCacheUsersRequest) String added in v65.93.2

func (request ListOciCacheUsersRequest) String() string

func (ListOciCacheUsersRequest) ValidateEnumValue added in v65.93.2

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

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

type ListOciCacheUsersResponse added in v65.93.2

type ListOciCacheUsersResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListOciCacheUsersResponse wrapper for the ListOciCacheUsers operation

func (ListOciCacheUsersResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (ListOciCacheUsersResponse) String added in v65.93.2

func (response ListOciCacheUsersResponse) String() string

type ListOciCacheUsersSortByEnum added in v65.93.2

type ListOciCacheUsersSortByEnum string

ListOciCacheUsersSortByEnum Enum with underlying type: string

const (
	ListOciCacheUsersSortByTimecreated ListOciCacheUsersSortByEnum = "timeCreated"
	ListOciCacheUsersSortByDisplayname ListOciCacheUsersSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListOciCacheUsersSortByEnum

func GetListOciCacheUsersSortByEnumValues added in v65.93.2

func GetListOciCacheUsersSortByEnumValues() []ListOciCacheUsersSortByEnum

GetListOciCacheUsersSortByEnumValues Enumerates the set of values for ListOciCacheUsersSortByEnum

func GetMappingListOciCacheUsersSortByEnum added in v65.93.2

func GetMappingListOciCacheUsersSortByEnum(val string) (ListOciCacheUsersSortByEnum, bool)

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

type ListOciCacheUsersSortOrderEnum added in v65.93.2

type ListOciCacheUsersSortOrderEnum string

ListOciCacheUsersSortOrderEnum Enum with underlying type: string

const (
	ListOciCacheUsersSortOrderAsc  ListOciCacheUsersSortOrderEnum = "ASC"
	ListOciCacheUsersSortOrderDesc ListOciCacheUsersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOciCacheUsersSortOrderEnum

func GetListOciCacheUsersSortOrderEnumValues added in v65.93.2

func GetListOciCacheUsersSortOrderEnumValues() []ListOciCacheUsersSortOrderEnum

GetListOciCacheUsersSortOrderEnumValues Enumerates the set of values for ListOciCacheUsersSortOrderEnum

func GetMappingListOciCacheUsersSortOrderEnum added in v65.93.2

func GetMappingListOciCacheUsersSortOrderEnum(val string) (ListOciCacheUsersSortOrderEnum, bool)

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

type ListRedisClusterNodesRequest added in v65.72.0

type ListRedisClusterNodesRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster.
	RedisClusterId *string `mandatory:"true" contributesTo:"path" name:"redisClusterId"`

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

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListRedisClusterNodesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

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

ListRedisClusterNodesRequest wrapper for the ListRedisClusterNodes operation

See also

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

func (ListRedisClusterNodesRequest) BinaryRequestBody added in v65.72.0

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

BinaryRequestBody implements the OCIRequest interface

func (ListRedisClusterNodesRequest) HTTPRequest added in v65.72.0

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

HTTPRequest implements the OCIRequest interface

func (ListRedisClusterNodesRequest) RetryPolicy added in v65.72.0

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

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

func (ListRedisClusterNodesRequest) String added in v65.72.0

func (request ListRedisClusterNodesRequest) String() string

func (ListRedisClusterNodesRequest) ValidateEnumValue added in v65.72.0

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

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

type ListRedisClusterNodesResponse added in v65.72.0

type ListRedisClusterNodesResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListRedisClusterNodesResponse wrapper for the ListRedisClusterNodes operation

func (ListRedisClusterNodesResponse) HTTPResponse added in v65.72.0

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

HTTPResponse implements the OCIResponse interface

func (ListRedisClusterNodesResponse) String added in v65.72.0

func (response ListRedisClusterNodesResponse) String() string

type ListRedisClusterNodesSortByEnum added in v65.72.0

type ListRedisClusterNodesSortByEnum string

ListRedisClusterNodesSortByEnum Enum with underlying type: string

const (
	ListRedisClusterNodesSortByTimecreated ListRedisClusterNodesSortByEnum = "timeCreated"
	ListRedisClusterNodesSortByDisplayname ListRedisClusterNodesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListRedisClusterNodesSortByEnum

func GetListRedisClusterNodesSortByEnumValues added in v65.72.0

func GetListRedisClusterNodesSortByEnumValues() []ListRedisClusterNodesSortByEnum

GetListRedisClusterNodesSortByEnumValues Enumerates the set of values for ListRedisClusterNodesSortByEnum

func GetMappingListRedisClusterNodesSortByEnum added in v65.72.0

func GetMappingListRedisClusterNodesSortByEnum(val string) (ListRedisClusterNodesSortByEnum, bool)

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

type ListRedisClusterNodesSortOrderEnum added in v65.72.0

type ListRedisClusterNodesSortOrderEnum string

ListRedisClusterNodesSortOrderEnum Enum with underlying type: string

const (
	ListRedisClusterNodesSortOrderAsc  ListRedisClusterNodesSortOrderEnum = "ASC"
	ListRedisClusterNodesSortOrderDesc ListRedisClusterNodesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRedisClusterNodesSortOrderEnum

func GetListRedisClusterNodesSortOrderEnumValues added in v65.72.0

func GetListRedisClusterNodesSortOrderEnumValues() []ListRedisClusterNodesSortOrderEnum

GetListRedisClusterNodesSortOrderEnumValues Enumerates the set of values for ListRedisClusterNodesSortOrderEnum

func GetMappingListRedisClusterNodesSortOrderEnum added in v65.72.0

func GetMappingListRedisClusterNodesSortOrderEnum(val string) (ListRedisClusterNodesSortOrderEnum, bool)

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

type ListRedisClustersRequest

type ListRedisClustersRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources their lifecycleState matches the given lifecycleState.
	LifecycleState RedisClusterLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

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

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

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListRedisClustersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

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

ListRedisClustersRequest wrapper for the ListRedisClusters operation

See also

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

func (ListRedisClustersRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListRedisClustersRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListRedisClustersRequest) RetryPolicy

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

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

func (ListRedisClustersRequest) String

func (request ListRedisClustersRequest) String() string

func (ListRedisClustersRequest) ValidateEnumValue

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

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

type ListRedisClustersResponse

type ListRedisClustersResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListRedisClustersResponse wrapper for the ListRedisClusters operation

func (ListRedisClustersResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListRedisClustersResponse) String

func (response ListRedisClustersResponse) String() string

type ListRedisClustersSortByEnum

type ListRedisClustersSortByEnum string

ListRedisClustersSortByEnum Enum with underlying type: string

const (
	ListRedisClustersSortByTimecreated ListRedisClustersSortByEnum = "timeCreated"
	ListRedisClustersSortByDisplayname ListRedisClustersSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListRedisClustersSortByEnum

func GetListRedisClustersSortByEnumValues

func GetListRedisClustersSortByEnumValues() []ListRedisClustersSortByEnum

GetListRedisClustersSortByEnumValues Enumerates the set of values for ListRedisClustersSortByEnum

func GetMappingListRedisClustersSortByEnum

func GetMappingListRedisClustersSortByEnum(val string) (ListRedisClustersSortByEnum, bool)

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

type ListRedisClustersSortOrderEnum

type ListRedisClustersSortOrderEnum string

ListRedisClustersSortOrderEnum Enum with underlying type: string

const (
	ListRedisClustersSortOrderAsc  ListRedisClustersSortOrderEnum = "ASC"
	ListRedisClustersSortOrderDesc ListRedisClustersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRedisClustersSortOrderEnum

func GetListRedisClustersSortOrderEnumValues

func GetListRedisClustersSortOrderEnumValues() []ListRedisClustersSortOrderEnum

GetListRedisClustersSortOrderEnumValues Enumerates the set of values for ListRedisClustersSortOrderEnum

func GetMappingListRedisClustersSortOrderEnum

func GetMappingListRedisClustersSortOrderEnum(val string) (ListRedisClustersSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest

type ListWorkRequestErrorsRequest struct {

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

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

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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

func (ListWorkRequestErrorsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

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

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

type ListWorkRequestErrorsResponse

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest

type ListWorkRequestLogsRequest struct {

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

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

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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

func (ListWorkRequestLogsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

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

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

type ListWorkRequestLogsResponse

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest

type ListWorkRequestsRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The ID of the asynchronous work request.
	WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`

	// A filter to return only resources their lifecycleState matches the given OperationStatus.
	Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`

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

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

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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

func (ListWorkRequestsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

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

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

type ListWorkRequestsResponse

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type ListWorkRequestsStatusEnum

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

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

type Node

type Node struct {

	// The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
	PrivateEndpointFqdn *string `mandatory:"true" json:"privateEndpointFqdn"`

	// The private IP address of the API endpoint to access a specific node.
	PrivateEndpointIpAddress *string `mandatory:"true" json:"privateEndpointIpAddress"`

	// A user-friendly name of a cluster node.
	DisplayName *string `mandatory:"true" json:"displayName"`
}

Node The details of each node in the cluster.

func (Node) String

func (m Node) String() string

func (Node) ValidateEnumValue

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

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

type NodeCollection

type NodeCollection struct {

	// Collection of node objects.
	Items []Node `mandatory:"true" json:"items"`
}

NodeCollection The collection of cluster nodes.

func (NodeCollection) String

func (m NodeCollection) String() string

func (NodeCollection) ValidateEnumValue

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

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

type NodeSummary added in v65.72.0

type NodeSummary struct {

	// The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
	PrivateEndpointFqdn *string `mandatory:"true" json:"privateEndpointFqdn"`

	// The private IP address of the API endpoint to access a specific node.
	PrivateEndpointIpAddress *string `mandatory:"true" json:"privateEndpointIpAddress"`

	// A user-friendly name of a cluster node.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID of the cluster
	RedisClusterId *string `mandatory:"true" json:"redisClusterId"`

	// The shard number to which the node belongs to.
	ShardNumber *int `mandatory:"false" json:"shardNumber"`
}

NodeSummary The details of each node in the cluster.

func (NodeSummary) String added in v65.72.0

func (m NodeSummary) String() string

func (NodeSummary) ValidateEnumValue added in v65.72.0

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

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

type OciCacheConfigSet added in v65.98.0

type OciCacheConfigSet struct {

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment that contains the OCI Cache Config Set.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The current state of the OCI Cache Config Set.
	LifecycleState OciCacheConfigSetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The OCI Cache engine version that the cluster is running.
	SoftwareVersion OciCacheConfigSetSoftwareVersionEnum `mandatory:"true" json:"softwareVersion"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the default OCI Cache Config Set which the custom OCI Cache Config Set is based upon.
	DefaultConfigSetId *string `mandatory:"false" json:"defaultConfigSetId"`

	// A description of the OCI Cache Config Set.
	Description *string `mandatory:"false" json:"description"`

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

	// The date and time the OCI Cache Config Set was created. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The date and time the OCI Cache Config Set was updated. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	ConfigurationDetails *ConfigurationDetails `mandatory:"false" json:"configurationDetails"`

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

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

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

OciCacheConfigSet Configurations for OCI Cache to manage the behavior, performance, and functionality of the underlying cache engine.

func (OciCacheConfigSet) String added in v65.98.0

func (m OciCacheConfigSet) String() string

func (OciCacheConfigSet) ValidateEnumValue added in v65.98.0

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

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

type OciCacheConfigSetClient added in v65.98.0

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

OciCacheConfigSetClient a client for OciCacheConfigSet

func NewOciCacheConfigSetClientWithConfigurationProvider added in v65.98.0

func NewOciCacheConfigSetClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OciCacheConfigSetClient, err error)

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

func NewOciCacheConfigSetClientWithOboToken added in v65.98.0

func NewOciCacheConfigSetClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OciCacheConfigSetClient, err error)

NewOciCacheConfigSetClientWithOboToken Creates a new default OciCacheConfigSet 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 (OciCacheConfigSetClient) ChangeOciCacheConfigSetCompartment added in v65.98.0

func (client OciCacheConfigSetClient) ChangeOciCacheConfigSetCompartment(ctx context.Context, request ChangeOciCacheConfigSetCompartmentRequest) (response ChangeOciCacheConfigSetCompartmentResponse, err error)

ChangeOciCacheConfigSetCompartment Moves an OCI Cache Config Set into a different compartment within the same tenancy.

See also

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

func (*OciCacheConfigSetClient) ConfigurationProvider added in v65.98.0

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

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

func (OciCacheConfigSetClient) CreateOciCacheConfigSet added in v65.98.0

func (client OciCacheConfigSetClient) CreateOciCacheConfigSet(ctx context.Context, request CreateOciCacheConfigSetRequest) (response CreateOciCacheConfigSetResponse, err error)

CreateOciCacheConfigSet Create a new OCI Cache Config Set for the given OCI cache engine version.

See also

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

func (OciCacheConfigSetClient) DeleteOciCacheConfigSet added in v65.98.0

func (client OciCacheConfigSetClient) DeleteOciCacheConfigSet(ctx context.Context, request DeleteOciCacheConfigSetRequest) (response DeleteOciCacheConfigSetResponse, err error)

DeleteOciCacheConfigSet Deletes the specified OCI Cache Config Set.

See also

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

func (OciCacheConfigSetClient) GetOciCacheConfigSet added in v65.98.0

func (client OciCacheConfigSetClient) GetOciCacheConfigSet(ctx context.Context, request GetOciCacheConfigSetRequest) (response GetOciCacheConfigSetResponse, err error)

GetOciCacheConfigSet Retrieves the specified OCI Cache Config Set.

See also

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

func (OciCacheConfigSetClient) ListAssociatedOciCacheClusters added in v65.98.0

func (client OciCacheConfigSetClient) ListAssociatedOciCacheClusters(ctx context.Context, request ListAssociatedOciCacheClustersRequest) (response ListAssociatedOciCacheClustersResponse, err error)

ListAssociatedOciCacheClusters Gets a list of associated OCI Cache clusters for an OCI Cache Config Set.

See also

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

func (OciCacheConfigSetClient) ListOciCacheConfigSets added in v65.98.0

func (client OciCacheConfigSetClient) ListOciCacheConfigSets(ctx context.Context, request ListOciCacheConfigSetsRequest) (response ListOciCacheConfigSetsResponse, err error)

ListOciCacheConfigSets Lists the OCI Cache Config Sets in the specified compartment.

See also

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

func (*OciCacheConfigSetClient) SetRegion added in v65.98.0

func (client *OciCacheConfigSetClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OciCacheConfigSetClient) UpdateOciCacheConfigSet added in v65.98.0

func (client OciCacheConfigSetClient) UpdateOciCacheConfigSet(ctx context.Context, request UpdateOciCacheConfigSetRequest) (response UpdateOciCacheConfigSetResponse, err error)

UpdateOciCacheConfigSet Updates the specified OCI Cache Config Set.

See also

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

type OciCacheConfigSetCollection added in v65.98.0

type OciCacheConfigSetCollection struct {

	// List of OCI Cache Config Sets.
	Items []OciCacheConfigSetSummary `mandatory:"true" json:"items"`
}

OciCacheConfigSetCollection A list of OCI Cache Config Sets that match filter criteria, if any.

func (OciCacheConfigSetCollection) String added in v65.98.0

func (OciCacheConfigSetCollection) ValidateEnumValue added in v65.98.0

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

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

type OciCacheConfigSetLifecycleStateEnum added in v65.98.0

type OciCacheConfigSetLifecycleStateEnum string

OciCacheConfigSetLifecycleStateEnum Enum with underlying type: string

const (
	OciCacheConfigSetLifecycleStateCreating OciCacheConfigSetLifecycleStateEnum = "CREATING"
	OciCacheConfigSetLifecycleStateUpdating OciCacheConfigSetLifecycleStateEnum = "UPDATING"
	OciCacheConfigSetLifecycleStateActive   OciCacheConfigSetLifecycleStateEnum = "ACTIVE"
	OciCacheConfigSetLifecycleStateDeleting OciCacheConfigSetLifecycleStateEnum = "DELETING"
	OciCacheConfigSetLifecycleStateDeleted  OciCacheConfigSetLifecycleStateEnum = "DELETED"
	OciCacheConfigSetLifecycleStateFailed   OciCacheConfigSetLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OciCacheConfigSetLifecycleStateEnum

func GetMappingOciCacheConfigSetLifecycleStateEnum added in v65.98.0

func GetMappingOciCacheConfigSetLifecycleStateEnum(val string) (OciCacheConfigSetLifecycleStateEnum, bool)

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

func GetOciCacheConfigSetLifecycleStateEnumValues added in v65.98.0

func GetOciCacheConfigSetLifecycleStateEnumValues() []OciCacheConfigSetLifecycleStateEnum

GetOciCacheConfigSetLifecycleStateEnumValues Enumerates the set of values for OciCacheConfigSetLifecycleStateEnum

type OciCacheConfigSetSoftwareVersionEnum added in v65.98.0

type OciCacheConfigSetSoftwareVersionEnum string

OciCacheConfigSetSoftwareVersionEnum Enum with underlying type: string

const (
	OciCacheConfigSetSoftwareVersionV705     OciCacheConfigSetSoftwareVersionEnum = "V7_0_5"
	OciCacheConfigSetSoftwareVersionRedis70  OciCacheConfigSetSoftwareVersionEnum = "REDIS_7_0"
	OciCacheConfigSetSoftwareVersionValkey72 OciCacheConfigSetSoftwareVersionEnum = "VALKEY_7_2"
)

Set of constants representing the allowable values for OciCacheConfigSetSoftwareVersionEnum

func GetMappingOciCacheConfigSetSoftwareVersionEnum added in v65.98.0

func GetMappingOciCacheConfigSetSoftwareVersionEnum(val string) (OciCacheConfigSetSoftwareVersionEnum, bool)

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

func GetOciCacheConfigSetSoftwareVersionEnumValues added in v65.98.0

func GetOciCacheConfigSetSoftwareVersionEnumValues() []OciCacheConfigSetSoftwareVersionEnum

GetOciCacheConfigSetSoftwareVersionEnumValues Enumerates the set of values for OciCacheConfigSetSoftwareVersionEnum

type OciCacheConfigSetSummary added in v65.98.0

type OciCacheConfigSetSummary struct {

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment that contains the OCI Cache Config Set.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the default OCI Cache Config Set which the custom OCI Cache Config Set is based upon.
	DefaultConfigSetId *string `mandatory:"false" json:"defaultConfigSetId"`

	// A user-friendly name of the OCI Cache Config Set.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The current state of the OCI Cache Config Set.
	LifecycleState OciCacheConfigSetLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The engine version of the OCI Cache Config Set.
	SoftwareVersion OciCacheConfigSetSoftwareVersionEnum `mandatory:"false" json:"softwareVersion,omitempty"`

	// The date and time the configuration was created. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The date and time the configuration was updated. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

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

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

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

OciCacheConfigSetSummary Summary of information about the OCI Cache Config Set.

func (OciCacheConfigSetSummary) String added in v65.98.0

func (m OciCacheConfigSetSummary) String() string

func (OciCacheConfigSetSummary) ValidateEnumValue added in v65.98.0

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

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

type OciCacheDefaultConfigSet added in v65.98.0

type OciCacheDefaultConfigSet struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the OCI Cache Default Config Set.
	Id *string `mandatory:"true" json:"id"`

	// The engine version of the OCI Cache Default Config Set.
	SoftwareVersion OciCacheConfigSetSoftwareVersionEnum `mandatory:"true" json:"softwareVersion"`

	// A user-friendly name of the OCI Cache Default Config Set.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Description of the OCI Cache Default Config Set.
	Description *string `mandatory:"false" json:"description"`

	// The date and time the OCI Cache Default Config Set was created. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The current state of the OCI Cache Default Config Set.
	LifecycleState OciCacheDefaultConfigSetLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	DefaultConfigurationDetails *DefaultConfigurationDetails `mandatory:"false" json:"defaultConfigurationDetails"`
}

OciCacheDefaultConfigSet Default configurations for OCI Cache to manage the behavior, performance, and functionality of the underlying cache engine.

func (OciCacheDefaultConfigSet) String added in v65.98.0

func (m OciCacheDefaultConfigSet) String() string

func (OciCacheDefaultConfigSet) ValidateEnumValue added in v65.98.0

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

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

type OciCacheDefaultConfigSetClient added in v65.98.0

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

OciCacheDefaultConfigSetClient a client for OciCacheDefaultConfigSet

func NewOciCacheDefaultConfigSetClientWithConfigurationProvider added in v65.98.0

func NewOciCacheDefaultConfigSetClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OciCacheDefaultConfigSetClient, err error)

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

func NewOciCacheDefaultConfigSetClientWithOboToken added in v65.98.0

func NewOciCacheDefaultConfigSetClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OciCacheDefaultConfigSetClient, err error)

NewOciCacheDefaultConfigSetClientWithOboToken Creates a new default OciCacheDefaultConfigSet 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 (*OciCacheDefaultConfigSetClient) ConfigurationProvider added in v65.98.0

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

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

func (OciCacheDefaultConfigSetClient) GetOciCacheDefaultConfigSet added in v65.98.0

func (client OciCacheDefaultConfigSetClient) GetOciCacheDefaultConfigSet(ctx context.Context, request GetOciCacheDefaultConfigSetRequest) (response GetOciCacheDefaultConfigSetResponse, err error)

GetOciCacheDefaultConfigSet Retrieves the specified OCI Cache Default Config Set.

See also

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

func (OciCacheDefaultConfigSetClient) ListOciCacheDefaultConfigSets added in v65.98.0

ListOciCacheDefaultConfigSets Lists the OCI Cache Default Config Sets in the specified compartment.

See also

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

func (*OciCacheDefaultConfigSetClient) SetRegion added in v65.98.0

func (client *OciCacheDefaultConfigSetClient) SetRegion(region string)

SetRegion overrides the region of this client.

type OciCacheDefaultConfigSetCollection added in v65.98.0

type OciCacheDefaultConfigSetCollection struct {

	// List of OCI Cache Default Config Sets.
	Items []OciCacheDefaultConfigSetSummary `mandatory:"true" json:"items"`
}

OciCacheDefaultConfigSetCollection A list of OCI Cache Default Config Sets.

func (OciCacheDefaultConfigSetCollection) String added in v65.98.0

func (OciCacheDefaultConfigSetCollection) ValidateEnumValue added in v65.98.0

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

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

type OciCacheDefaultConfigSetLifecycleStateEnum added in v65.98.0

type OciCacheDefaultConfigSetLifecycleStateEnum string

OciCacheDefaultConfigSetLifecycleStateEnum Enum with underlying type: string

const (
	OciCacheDefaultConfigSetLifecycleStateActive   OciCacheDefaultConfigSetLifecycleStateEnum = "ACTIVE"
	OciCacheDefaultConfigSetLifecycleStateInactive OciCacheDefaultConfigSetLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for OciCacheDefaultConfigSetLifecycleStateEnum

func GetMappingOciCacheDefaultConfigSetLifecycleStateEnum added in v65.98.0

func GetMappingOciCacheDefaultConfigSetLifecycleStateEnum(val string) (OciCacheDefaultConfigSetLifecycleStateEnum, bool)

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

func GetOciCacheDefaultConfigSetLifecycleStateEnumValues added in v65.98.0

func GetOciCacheDefaultConfigSetLifecycleStateEnumValues() []OciCacheDefaultConfigSetLifecycleStateEnum

GetOciCacheDefaultConfigSetLifecycleStateEnumValues Enumerates the set of values for OciCacheDefaultConfigSetLifecycleStateEnum

type OciCacheDefaultConfigSetSummary added in v65.98.0

type OciCacheDefaultConfigSetSummary struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the OCI Cache Default Config Set.
	Id *string `mandatory:"true" json:"id"`

	// The engine version of the OCI Cache Default Config Set.
	SoftwareVersion OciCacheConfigSetSoftwareVersionEnum `mandatory:"true" json:"softwareVersion"`

	// A user-friendly name of the OCI Cache Default Config Set.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The current state of the OCI Cache Default Config Set.
	LifecycleState OciCacheDefaultConfigSetLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The date and time the configuration was created. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

OciCacheDefaultConfigSetSummary Summary of information about an OCI Cache Default Config Set.

func (OciCacheDefaultConfigSetSummary) String added in v65.98.0

func (OciCacheDefaultConfigSetSummary) ValidateEnumValue added in v65.98.0

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

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

type OciCacheUser added in v65.93.2

type OciCacheUser struct {

	// OCI Cache user unique ID.
	Id *string `mandatory:"true" json:"id"`

	// OCI Cache user name.
	Name *string `mandatory:"true" json:"name"`

	// OCI Cache user compartment ID.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	AuthenticationMode AuthenticationMode `mandatory:"true" json:"authenticationMode"`

	// ACL string of OCI cache user.
	AclString *string `mandatory:"true" json:"aclString"`

	// OCI Cache user status. ON enables and OFF disables the OCI cache user to login to the cluster.
	Status OciCacheUserStatusEnum `mandatory:"true" json:"status"`

	// OCI Cache user lifecycle state.
	LifecycleState OciCacheUserLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Description of OCI cache user.
	Description *string `mandatory:"false" json:"description"`

	// The date and time, when the OCI cache user was created.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The date and time, when the OCI cache user was updated.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

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

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

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

OciCacheUser An OCI cache user is required to connect to an OCI cache cluster.

func (OciCacheUser) String added in v65.93.2

func (m OciCacheUser) String() string

func (*OciCacheUser) UnmarshalJSON added in v65.93.2

func (m *OciCacheUser) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (OciCacheUser) ValidateEnumValue added in v65.93.2

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

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

type OciCacheUserClient added in v65.93.2

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

OciCacheUserClient a client for OciCacheUser

func NewOciCacheUserClientWithConfigurationProvider added in v65.93.2

func NewOciCacheUserClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OciCacheUserClient, err error)

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

func NewOciCacheUserClientWithOboToken added in v65.93.2

func NewOciCacheUserClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OciCacheUserClient, err error)

NewOciCacheUserClientWithOboToken Creates a new default OciCacheUser 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 (OciCacheUserClient) ChangeOciCacheUserCompartment added in v65.93.2

func (client OciCacheUserClient) ChangeOciCacheUserCompartment(ctx context.Context, request ChangeOciCacheUserCompartmentRequest) (response ChangeOciCacheUserCompartmentResponse, err error)

ChangeOciCacheUserCompartment Moves an OCI Cache User from one compartment to another within the same tenancy.

See also

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

func (*OciCacheUserClient) ConfigurationProvider added in v65.93.2

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

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

func (OciCacheUserClient) CreateOciCacheUser added in v65.93.2

func (client OciCacheUserClient) CreateOciCacheUser(ctx context.Context, request CreateOciCacheUserRequest) (response CreateOciCacheUserResponse, err error)

CreateOciCacheUser Creates a new OCI Cache user. OCI Cache user is required to authenticate to OCI Cache cluster.

See also

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

func (OciCacheUserClient) DeleteOciCacheUser added in v65.93.2

func (client OciCacheUserClient) DeleteOciCacheUser(ctx context.Context, request DeleteOciCacheUserRequest) (response DeleteOciCacheUserResponse, err error)

DeleteOciCacheUser Deletes an existing OCI Cache User based on the OCI cache user unique ID (OCID).

See also

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

func (OciCacheUserClient) GetOciCacheUser added in v65.93.2

func (client OciCacheUserClient) GetOciCacheUser(ctx context.Context, request GetOciCacheUserRequest) (response GetOciCacheUserResponse, err error)

GetOciCacheUser Get an existing OCI Cache users based on the ID (OCID).

See also

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

func (OciCacheUserClient) ListAttachedRedisClusters added in v65.93.2

func (client OciCacheUserClient) ListAttachedRedisClusters(ctx context.Context, request ListAttachedRedisClustersRequest) (response ListAttachedRedisClustersResponse, err error)

ListAttachedRedisClusters Gets a list of associated redis cluster for an OCI cache user.

See also

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

func (OciCacheUserClient) ListOciCacheUsers added in v65.93.2

func (client OciCacheUserClient) ListOciCacheUsers(ctx context.Context, request ListOciCacheUsersRequest) (response ListOciCacheUsersResponse, err error)

ListOciCacheUsers Lists the OCI Cache users based on the supplied parameters.

See also

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

func (*OciCacheUserClient) SetRegion added in v65.93.2

func (client *OciCacheUserClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OciCacheUserClient) UpdateOciCacheUser added in v65.93.2

func (client OciCacheUserClient) UpdateOciCacheUser(ctx context.Context, request UpdateOciCacheUserRequest) (response UpdateOciCacheUserResponse, err error)

UpdateOciCacheUser Update an existing OCI Cache User with new details.

See also

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

type OciCacheUserCollection added in v65.93.2

type OciCacheUserCollection struct {

	// A collection of OCI Cache users.
	Items []OciCacheUserSummary `mandatory:"true" json:"items"`
}

OciCacheUserCollection A list of OCI cache users that match filter criteria, if any.

func (OciCacheUserCollection) String added in v65.93.2

func (m OciCacheUserCollection) String() string

func (OciCacheUserCollection) ValidateEnumValue added in v65.93.2

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

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

type OciCacheUserLifecycleStateEnum added in v65.93.2

type OciCacheUserLifecycleStateEnum string

OciCacheUserLifecycleStateEnum Enum with underlying type: string

const (
	OciCacheUserLifecycleStateCreating OciCacheUserLifecycleStateEnum = "CREATING"
	OciCacheUserLifecycleStateUpdating OciCacheUserLifecycleStateEnum = "UPDATING"
	OciCacheUserLifecycleStateActive   OciCacheUserLifecycleStateEnum = "ACTIVE"
	OciCacheUserLifecycleStateDeleting OciCacheUserLifecycleStateEnum = "DELETING"
	OciCacheUserLifecycleStateDeleted  OciCacheUserLifecycleStateEnum = "DELETED"
	OciCacheUserLifecycleStateFailed   OciCacheUserLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OciCacheUserLifecycleStateEnum

func GetMappingOciCacheUserLifecycleStateEnum added in v65.93.2

func GetMappingOciCacheUserLifecycleStateEnum(val string) (OciCacheUserLifecycleStateEnum, bool)

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

func GetOciCacheUserLifecycleStateEnumValues added in v65.93.2

func GetOciCacheUserLifecycleStateEnumValues() []OciCacheUserLifecycleStateEnum

GetOciCacheUserLifecycleStateEnumValues Enumerates the set of values for OciCacheUserLifecycleStateEnum

type OciCacheUserStatusEnum added in v65.93.2

type OciCacheUserStatusEnum string

OciCacheUserStatusEnum Enum with underlying type: string

const (
	OciCacheUserStatusOn  OciCacheUserStatusEnum = "ON"
	OciCacheUserStatusOff OciCacheUserStatusEnum = "OFF"
)

Set of constants representing the allowable values for OciCacheUserStatusEnum

func GetMappingOciCacheUserStatusEnum added in v65.93.2

func GetMappingOciCacheUserStatusEnum(val string) (OciCacheUserStatusEnum, bool)

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

func GetOciCacheUserStatusEnumValues added in v65.93.2

func GetOciCacheUserStatusEnumValues() []OciCacheUserStatusEnum

GetOciCacheUserStatusEnumValues Enumerates the set of values for OciCacheUserStatusEnum

type OciCacheUserSummary added in v65.93.2

type OciCacheUserSummary struct {

	// OCI Cache user unique ID.
	Id *string `mandatory:"true" json:"id"`

	// OCI Cache user name.
	Name *string `mandatory:"true" json:"name"`

	// OCI Cache user compartment ID.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// OCI Cache user authentication type.
	AuthenticationType AuthenticationModeAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`

	// OCI Cache user status. ON enables and OFF disables the OCI cache user to use the cluster.
	Status OciCacheUserStatusEnum `mandatory:"true" json:"status"`

	// OCI Cache user lifecycle state.
	LifecycleState OciCacheUserLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Description of OCI cache user.
	Description *string `mandatory:"true" json:"description"`

	// The date and time, when the OCI cache user was created.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

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

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

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

OciCacheUserSummary OCI Cache user summary.

func (OciCacheUserSummary) String added in v65.93.2

func (m OciCacheUserSummary) String() string

func (OciCacheUserSummary) ValidateEnumValue added in v65.93.2

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

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

type OperationStatusEnum

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string

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

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string

const (
	OperationTypeCreateRedisCluster                 OperationTypeEnum = "CREATE_REDIS_CLUSTER"
	OperationTypeUpdateRedisCluster                 OperationTypeEnum = "UPDATE_REDIS_CLUSTER"
	OperationTypeDeleteRedisCluster                 OperationTypeEnum = "DELETE_REDIS_CLUSTER"
	OperationTypeMoveRedisCluster                   OperationTypeEnum = "MOVE_REDIS_CLUSTER"
	OperationTypeFailoverRedisCluster               OperationTypeEnum = "FAILOVER_REDIS_CLUSTER"
	OperationTypeCreateRedisConfigSet               OperationTypeEnum = "CREATE_REDIS_CONFIG_SET"
	OperationTypeUpdateRedisConfigSet               OperationTypeEnum = "UPDATE_REDIS_CONFIG_SET"
	OperationTypeDeleteRedisConfigSet               OperationTypeEnum = "DELETE_REDIS_CONFIG_SET"
	OperationTypeMoveRedisConfigSet                 OperationTypeEnum = "MOVE_REDIS_CONFIG_SET"
	OperationTypeMigrateCluster                     OperationTypeEnum = "MIGRATE_CLUSTER"
	OperationTypeClusterRollback                    OperationTypeEnum = "CLUSTER_ROLLBACK"
	OperationTypeAttachOciCacheUsers                OperationTypeEnum = "ATTACH_OCI_CACHE_USERS"
	OperationTypeDetachOciCacheUsers                OperationTypeEnum = "DETACH_OCI_CACHE_USERS"
	OperationTypeCreateOciCacheUser                 OperationTypeEnum = "CREATE_OCI_CACHE_USER"
	OperationTypeUpdateOciCacheUser                 OperationTypeEnum = "UPDATE_OCI_CACHE_USER"
	OperationTypeDeleteOciCacheUser                 OperationTypeEnum = "DELETE_OCI_CACHE_USER"
	OperationTypeCreateOciCacheConfigSet            OperationTypeEnum = "CREATE_OCI_CACHE_CONFIG_SET"
	OperationTypeUpdateOciCacheConfigSet            OperationTypeEnum = "UPDATE_OCI_CACHE_CONFIG_SET"
	OperationTypeDeleteOciCacheConfigSet            OperationTypeEnum = "DELETE_OCI_CACHE_CONFIG_SET"
	OperationTypeChangeOciCacheConfigSetCompartment OperationTypeEnum = "CHANGE_OCI_CACHE_CONFIG_SET_COMPARTMENT"
	OperationTypeChangeOciCacheUserCompartment      OperationTypeEnum = "CHANGE_OCI_CACHE_USER_COMPARTMENT"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type PasswordAuthenticationMode added in v65.93.2

type PasswordAuthenticationMode struct {

	// SHA-256 hashed passwords for OCI Cache user,required if authenticationType is set to PASSWORD.
	HashedPasswords []string `mandatory:"true" json:"hashedPasswords"`
}

PasswordAuthenticationMode child class of AuthenticationMode.

func (PasswordAuthenticationMode) MarshalJSON added in v65.93.2

func (m PasswordAuthenticationMode) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PasswordAuthenticationMode) String added in v65.93.2

func (PasswordAuthenticationMode) ValidateEnumValue added in v65.93.2

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

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

type RedisCluster

type RedisCluster struct {

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

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

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

	// The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
	NodeCount *int `mandatory:"true" json:"nodeCount"`

	// The amount of memory allocated to the cluster's nodes, in gigabytes.
	NodeMemoryInGBs *float32 `mandatory:"true" json:"nodeMemoryInGBs"`

	// The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
	PrimaryFqdn *string `mandatory:"true" json:"primaryFqdn"`

	// The private IP address of the API endpoint for the cluster's primary node.
	PrimaryEndpointIpAddress *string `mandatory:"true" json:"primaryEndpointIpAddress"`

	// The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
	ReplicasFqdn *string `mandatory:"true" json:"replicasFqdn"`

	// The private IP address of the API endpoint for the cluster's replica nodes.
	ReplicasEndpointIpAddress *string `mandatory:"true" json:"replicasEndpointIpAddress"`

	// The OCI Cache engine version that the cluster is running.
	SoftwareVersion RedisClusterSoftwareVersionEnum `mandatory:"true" json:"softwareVersion"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster's subnet.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	NodeCollection *NodeCollection `mandatory:"true" json:"nodeCollection"`

	// The current state of the cluster.
	LifecycleState RedisClusterLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// A message describing the current state in more detail. For example, the message might provide actionable information for a resource in `FAILED` state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// The fully qualified domain name (FQDN) of the API endpoint for sharded cluster discovery.
	DiscoveryFqdn *string `mandatory:"false" json:"discoveryFqdn"`

	// The private IP address of the API endpoint for sharded cluster discovery.
	DiscoveryEndpointIpAddress *string `mandatory:"false" json:"discoveryEndpointIpAddress"`

	// The date and time the cluster was created. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The date and time the cluster was updated. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// The ID of the corresponding OCI Cache Config Set for the cluster.
	OciCacheConfigSetId *string `mandatory:"false" json:"ociCacheConfigSetId"`

	// Specifies whether the cluster is sharded or non-sharded.
	ClusterMode RedisClusterClusterModeEnum `mandatory:"false" json:"clusterMode,omitempty"`

	// The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
	ShardCount *int `mandatory:"false" json:"shardCount"`

	// A list of Network Security Group (NSG) OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
	// associated with this cluster. For more information,
	// see Using an NSG for Clusters (https://docs.oracle.com/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup).
	NsgIds []string `mandatory:"false" json:"nsgIds"`

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

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

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

RedisCluster An OCI Cache cluster is a memory-based storage solution. For more information, see OCI Cache (https://docs.oracle.com/iaas/Content/ocicache/home.htm).

func (RedisCluster) String

func (m RedisCluster) String() string

func (RedisCluster) ValidateEnumValue

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

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

type RedisClusterClient

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

RedisClusterClient a client for RedisCluster

func NewRedisClusterClientWithConfigurationProvider

func NewRedisClusterClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RedisClusterClient, err error)

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

func NewRedisClusterClientWithOboToken

func NewRedisClusterClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RedisClusterClient, err error)

NewRedisClusterClientWithOboToken Creates a new default RedisCluster 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 (RedisClusterClient) AttachOciCacheUsers added in v65.93.2

func (client RedisClusterClient) AttachOciCacheUsers(ctx context.Context, request AttachOciCacheUsersRequest) (response AttachOciCacheUsersResponse, err error)

AttachOciCacheUsers Attach existing OCI cache users to a redis cluster.

See also

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

func (RedisClusterClient) CancelWorkRequest

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

CancelWorkRequest Cancels the specified work request.

See also

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

func (RedisClusterClient) ChangeRedisClusterCompartment

func (client RedisClusterClient) ChangeRedisClusterCompartment(ctx context.Context, request ChangeRedisClusterCompartmentRequest) (response ChangeRedisClusterCompartmentResponse, err error)

ChangeRedisClusterCompartment Moves an OCI Cache cluster into a different compartment within the same tenancy. A cluster is a memory-based storage solution. For more information, see OCI Cache (https://docs.oracle.com/iaas/Content/ocicache/home.htm).

See also

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

func (*RedisClusterClient) ConfigurationProvider

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

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

func (RedisClusterClient) CreateRedisCluster

func (client RedisClusterClient) CreateRedisCluster(ctx context.Context, request CreateRedisClusterRequest) (response CreateRedisClusterResponse, err error)

CreateRedisCluster Creates a new OCI Cache cluster. A cluster is a memory-based storage solution. For more information, see OCI Cache (https://docs.oracle.com/iaas/Content/ocicache/home.htm).

See also

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

func (RedisClusterClient) DeleteRedisCluster

func (client RedisClusterClient) DeleteRedisCluster(ctx context.Context, request DeleteRedisClusterRequest) (response DeleteRedisClusterResponse, err error)

DeleteRedisCluster Deletes the specified OCI Cache cluster. A cluster is a memory-based storage solution. For more information, see OCI Cache (https://docs.oracle.com/iaas/Content/ocicache/home.htm).

See also

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

func (RedisClusterClient) DetachOciCacheUsers added in v65.93.2

func (client RedisClusterClient) DetachOciCacheUsers(ctx context.Context, request DetachOciCacheUsersRequest) (response DetachOciCacheUsersResponse, err error)

DetachOciCacheUsers Detach existing OCI cache users to a redis cluster.

See also

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

func (RedisClusterClient) GetRedisCluster

func (client RedisClusterClient) GetRedisCluster(ctx context.Context, request GetRedisClusterRequest) (response GetRedisClusterResponse, err error)

GetRedisCluster Retrieves the specified OCI Cache cluster. A cluster is a memory-based storage solution. For more information, see OCI Cache (https://docs.oracle.com/iaas/Content/ocicache/home.htm).

See also

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

func (RedisClusterClient) GetWorkRequest

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

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

See also

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

func (RedisClusterClient) ListAttachedOciCacheUsers added in v65.93.2

func (client RedisClusterClient) ListAttachedOciCacheUsers(ctx context.Context, request ListAttachedOciCacheUsersRequest) (response ListAttachedOciCacheUsersResponse, err error)

ListAttachedOciCacheUsers Gets a list of associated OCI cache users for a redis cluster.

See also

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

func (RedisClusterClient) ListRedisClusterNodes added in v65.72.0

func (client RedisClusterClient) ListRedisClusterNodes(ctx context.Context, request ListRedisClusterNodesRequest) (response ListRedisClusterNodesResponse, err error)

ListRedisClusterNodes Gets the list of all nodes in a cluster.

See also

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

func (RedisClusterClient) ListRedisClusters

func (client RedisClusterClient) ListRedisClusters(ctx context.Context, request ListRedisClustersRequest) (response ListRedisClustersResponse, err error)

ListRedisClusters Lists the OCI Cache clusters in the specified compartment. A cluster is a memory-based storage solution. For more information, see OCI Cache (https://docs.oracle.com/iaas/Content/ocicache/home.htm).

See also

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

func (RedisClusterClient) ListWorkRequestErrors

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

ListWorkRequestErrors Returns a list of errors for a given work request.

See also

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

func (RedisClusterClient) ListWorkRequestLogs

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

ListWorkRequestLogs Returns a list of logs for a given work request.

See also

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

func (RedisClusterClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in a compartment.

See also

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

func (*RedisClusterClient) SetRegion

func (client *RedisClusterClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (RedisClusterClient) UpdateRedisCluster

func (client RedisClusterClient) UpdateRedisCluster(ctx context.Context, request UpdateRedisClusterRequest) (response UpdateRedisClusterResponse, err error)

UpdateRedisCluster Updates the specified OCI Cache cluster. A cluster is a memory-based storage solution. For more information, see OCI Cache (https://docs.oracle.com/iaas/Content/ocicache/home.htm).

See also

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

type RedisClusterClusterModeEnum added in v65.72.0

type RedisClusterClusterModeEnum string

RedisClusterClusterModeEnum Enum with underlying type: string

const (
	RedisClusterClusterModeSharded    RedisClusterClusterModeEnum = "SHARDED"
	RedisClusterClusterModeNonsharded RedisClusterClusterModeEnum = "NONSHARDED"
)

Set of constants representing the allowable values for RedisClusterClusterModeEnum

func GetMappingRedisClusterClusterModeEnum added in v65.72.0

func GetMappingRedisClusterClusterModeEnum(val string) (RedisClusterClusterModeEnum, bool)

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

func GetRedisClusterClusterModeEnumValues added in v65.72.0

func GetRedisClusterClusterModeEnumValues() []RedisClusterClusterModeEnum

GetRedisClusterClusterModeEnumValues Enumerates the set of values for RedisClusterClusterModeEnum

type RedisClusterCollection

type RedisClusterCollection struct {

	// The list of clusters.
	Items []RedisClusterSummary `mandatory:"true" json:"items"`
}

RedisClusterCollection A list of clusters that match filter criteria, if any. A cluster is a memory-based storage solution. For more information, see OCI Cache (https://docs.oracle.com/iaas/Content/ocicache/home.htm).

func (RedisClusterCollection) String

func (m RedisClusterCollection) String() string

func (RedisClusterCollection) ValidateEnumValue

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

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

type RedisClusterLifecycleStateEnum

type RedisClusterLifecycleStateEnum string

RedisClusterLifecycleStateEnum Enum with underlying type: string

const (
	RedisClusterLifecycleStateCreating RedisClusterLifecycleStateEnum = "CREATING"
	RedisClusterLifecycleStateUpdating RedisClusterLifecycleStateEnum = "UPDATING"
	RedisClusterLifecycleStateActive   RedisClusterLifecycleStateEnum = "ACTIVE"
	RedisClusterLifecycleStateDeleting RedisClusterLifecycleStateEnum = "DELETING"
	RedisClusterLifecycleStateDeleted  RedisClusterLifecycleStateEnum = "DELETED"
	RedisClusterLifecycleStateFailed   RedisClusterLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for RedisClusterLifecycleStateEnum

func GetMappingRedisClusterLifecycleStateEnum

func GetMappingRedisClusterLifecycleStateEnum(val string) (RedisClusterLifecycleStateEnum, bool)

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

func GetRedisClusterLifecycleStateEnumValues

func GetRedisClusterLifecycleStateEnumValues() []RedisClusterLifecycleStateEnum

GetRedisClusterLifecycleStateEnumValues Enumerates the set of values for RedisClusterLifecycleStateEnum

type RedisClusterSoftwareVersionEnum

type RedisClusterSoftwareVersionEnum string

RedisClusterSoftwareVersionEnum Enum with underlying type: string

const (
	RedisClusterSoftwareVersionV705     RedisClusterSoftwareVersionEnum = "V7_0_5"
	RedisClusterSoftwareVersionRedis70  RedisClusterSoftwareVersionEnum = "REDIS_7_0"
	RedisClusterSoftwareVersionValkey72 RedisClusterSoftwareVersionEnum = "VALKEY_7_2"
)

Set of constants representing the allowable values for RedisClusterSoftwareVersionEnum

func GetMappingRedisClusterSoftwareVersionEnum

func GetMappingRedisClusterSoftwareVersionEnum(val string) (RedisClusterSoftwareVersionEnum, bool)

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

func GetRedisClusterSoftwareVersionEnumValues

func GetRedisClusterSoftwareVersionEnumValues() []RedisClusterSoftwareVersionEnum

GetRedisClusterSoftwareVersionEnumValues Enumerates the set of values for RedisClusterSoftwareVersionEnum

type RedisClusterSummary

type RedisClusterSummary struct {

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

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

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

	// The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
	NodeCount *int `mandatory:"true" json:"nodeCount"`

	// The amount of memory allocated to the cluster's nodes, in gigabytes.
	NodeMemoryInGBs *float32 `mandatory:"true" json:"nodeMemoryInGBs"`

	// The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
	PrimaryFqdn *string `mandatory:"true" json:"primaryFqdn"`

	// The private IP address of the API endpoint for the cluster's primary node.
	PrimaryEndpointIpAddress *string `mandatory:"true" json:"primaryEndpointIpAddress"`

	// The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
	ReplicasFqdn *string `mandatory:"true" json:"replicasFqdn"`

	// The private IP address of the API endpoint for the cluster's replica nodes.
	ReplicasEndpointIpAddress *string `mandatory:"true" json:"replicasEndpointIpAddress"`

	// The OCI Cache engine version that the cluster is running.
	SoftwareVersion RedisClusterSoftwareVersionEnum `mandatory:"true" json:"softwareVersion"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster's subnet.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// The current state of the cluster.
	LifecycleState RedisClusterLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// A message describing the current state in more detail. For example, the message might provide actionable information for a resource in `FAILED` state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// The fully qualified domain name (FQDN) of the API endpoint for sharded cluster discovery.
	DiscoveryFqdn *string `mandatory:"false" json:"discoveryFqdn"`

	// The private IP address of the API endpoint for shareded cluster discovery.
	DiscoveryEndpointIpAddress *string `mandatory:"false" json:"discoveryEndpointIpAddress"`

	// The date and time the cluster was created. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The date and time the cluster was updated. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// The ID of the corresponding OCI Cache Config Set for the cluster.
	OciCacheConfigSetId *string `mandatory:"false" json:"ociCacheConfigSetId"`

	// Specifies whether the cluster is sharded or non-sharded.
	ClusterMode RedisClusterClusterModeEnum `mandatory:"false" json:"clusterMode,omitempty"`

	// The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
	ShardCount *int `mandatory:"false" json:"shardCount"`

	// A list of Network Security Group (NSG) OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
	// associated with this cluster. For more information,
	// see Using an NSG for Clusters (https://docs.oracle.com/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup).
	NsgIds []string `mandatory:"false" json:"nsgIds"`

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

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

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

RedisClusterSummary Summary of information about a cluster. A cluster is a memory-based storage solution. For more information, see OCI Cache (https://docs.oracle.com/iaas/Content/ocicache/home.htm).

func (RedisClusterSummary) String

func (m RedisClusterSummary) String() string

func (RedisClusterSummary) ValidateEnumValue

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

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

type RedisIdentityClient added in v65.93.2

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

RedisIdentityClient a client for RedisIdentity

func NewRedisIdentityClientWithConfigurationProvider added in v65.93.2

func NewRedisIdentityClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RedisIdentityClient, err error)

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

func NewRedisIdentityClientWithOboToken added in v65.93.2

func NewRedisIdentityClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RedisIdentityClient, err error)

NewRedisIdentityClientWithOboToken Creates a new default RedisIdentity 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 (*RedisIdentityClient) ConfigurationProvider added in v65.93.2

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

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

func (RedisIdentityClient) CreateIdentityToken added in v65.93.2

func (client RedisIdentityClient) CreateIdentityToken(ctx context.Context, request CreateIdentityTokenRequest) (response CreateIdentityTokenResponse, err error)

CreateIdentityToken Generates an identity token to sign in with the specified redis user for the redis cluster

See also

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

func (*RedisIdentityClient) SetRegion added in v65.93.2

func (client *RedisIdentityClient) SetRegion(region string)

SetRegion overrides the region of this client.

type RedisNodeCollection added in v65.72.0

type RedisNodeCollection struct {

	// The list of nodes in a cluster.
	Items []NodeSummary `mandatory:"true" json:"items"`
}

RedisNodeCollection A list of nodes in a cluster that match filter criteria, if any.

func (RedisNodeCollection) String added in v65.72.0

func (m RedisNodeCollection) String() string

func (RedisNodeCollection) ValidateEnumValue added in v65.72.0

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

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

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type UpdateOciCacheConfigSetDetails added in v65.98.0

type UpdateOciCacheConfigSetDetails 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"`

	// Description for the custom OCI Cache Config Set.
	Description *string `mandatory:"false" json:"description"`

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

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

UpdateOciCacheConfigSetDetails The information to be updated for an existing OCI Cache Config Set.

func (UpdateOciCacheConfigSetDetails) String added in v65.98.0

func (UpdateOciCacheConfigSetDetails) ValidateEnumValue added in v65.98.0

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

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

type UpdateOciCacheConfigSetRequest added in v65.98.0

type UpdateOciCacheConfigSetRequest struct {

	// Unique OCI Cache Config Set identifier.
	OciCacheConfigSetId *string `mandatory:"true" contributesTo:"path" name:"ociCacheConfigSetId"`

	// The information to be updated for OCI Cache Config Set.
	UpdateOciCacheConfigSetDetails `contributesTo:"body"`

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

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

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

UpdateOciCacheConfigSetRequest wrapper for the UpdateOciCacheConfigSet operation

See also

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

func (UpdateOciCacheConfigSetRequest) BinaryRequestBody added in v65.98.0

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateOciCacheConfigSetRequest) HTTPRequest added in v65.98.0

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

HTTPRequest implements the OCIRequest interface

func (UpdateOciCacheConfigSetRequest) RetryPolicy added in v65.98.0

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

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

func (UpdateOciCacheConfigSetRequest) String added in v65.98.0

func (request UpdateOciCacheConfigSetRequest) String() string

func (UpdateOciCacheConfigSetRequest) ValidateEnumValue added in v65.98.0

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

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

type UpdateOciCacheConfigSetResponse added in v65.98.0

type UpdateOciCacheConfigSetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

UpdateOciCacheConfigSetResponse wrapper for the UpdateOciCacheConfigSet operation

func (UpdateOciCacheConfigSetResponse) HTTPResponse added in v65.98.0

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

HTTPResponse implements the OCIResponse interface

func (UpdateOciCacheConfigSetResponse) String added in v65.98.0

func (response UpdateOciCacheConfigSetResponse) String() string

type UpdateOciCacheUserDetails added in v65.93.2

type UpdateOciCacheUserDetails struct {

	// Description of OCI cache user.
	Description *string `mandatory:"false" json:"description"`

	AuthenticationMode AuthenticationMode `mandatory:"false" json:"authenticationMode"`

	// ACL string of OCI cache user.
	AclString *string `mandatory:"false" json:"aclString"`

	// OCI cache user status. ON enables and OFF disables the OCI cache user to login to the associated clusters.
	Status OciCacheUserStatusEnum `mandatory:"false" json:"status,omitempty"`

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

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

UpdateOciCacheUserDetails Details required to update an existing OCI cache user.

func (UpdateOciCacheUserDetails) String added in v65.93.2

func (m UpdateOciCacheUserDetails) String() string

func (*UpdateOciCacheUserDetails) UnmarshalJSON added in v65.93.2

func (m *UpdateOciCacheUserDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (UpdateOciCacheUserDetails) ValidateEnumValue added in v65.93.2

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

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

type UpdateOciCacheUserRequest added in v65.93.2

type UpdateOciCacheUserRequest struct {

	// A filter to return only resources, that match with the given OCI cache user ID (OCID).
	OciCacheUserId *string `mandatory:"true" contributesTo:"path" name:"ociCacheUserId"`

	// The information to be updated for an existing OCI Cache User.
	UpdateOciCacheUserDetails `contributesTo:"body"`

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

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

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

UpdateOciCacheUserRequest wrapper for the UpdateOciCacheUser operation

See also

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

func (UpdateOciCacheUserRequest) BinaryRequestBody added in v65.93.2

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateOciCacheUserRequest) HTTPRequest added in v65.93.2

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

HTTPRequest implements the OCIRequest interface

func (UpdateOciCacheUserRequest) RetryPolicy added in v65.93.2

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

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

func (UpdateOciCacheUserRequest) String added in v65.93.2

func (request UpdateOciCacheUserRequest) String() string

func (UpdateOciCacheUserRequest) ValidateEnumValue added in v65.93.2

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

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

type UpdateOciCacheUserResponse added in v65.93.2

type UpdateOciCacheUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

UpdateOciCacheUserResponse wrapper for the UpdateOciCacheUser operation

func (UpdateOciCacheUserResponse) HTTPResponse added in v65.93.2

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

HTTPResponse implements the OCIResponse interface

func (UpdateOciCacheUserResponse) String added in v65.93.2

func (response UpdateOciCacheUserResponse) String() string

type UpdateRedisClusterDetails

type UpdateRedisClusterDetails struct {

	// The ID of the corresponding OCI Cache Config Set for the cluster.
	OciCacheConfigSetId *string `mandatory:"false" json:"ociCacheConfigSetId"`

	// The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.
	ShardCount *int `mandatory:"false" json:"shardCount"`

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

	// The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
	NodeCount *int `mandatory:"false" json:"nodeCount"`

	// The amount of memory allocated to the cluster's nodes, in gigabytes.
	NodeMemoryInGBs *float32 `mandatory:"false" json:"nodeMemoryInGBs"`

	// The OCI Cache engine version that the cluster is running.
	SoftwareVersion RedisClusterSoftwareVersionEnum `mandatory:"false" json:"softwareVersion,omitempty"`

	// A list of Network Security Group (NSG) OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
	// associated with this cluster. For more information,
	// see Using an NSG for Clusters (https://docs.oracle.com/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup).
	NsgIds []string `mandatory:"false" json:"nsgIds"`

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

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

UpdateRedisClusterDetails The configuration to update for an existing cluster.

func (UpdateRedisClusterDetails) String

func (m UpdateRedisClusterDetails) String() string

func (UpdateRedisClusterDetails) ValidateEnumValue

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

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

type UpdateRedisClusterRequest

type UpdateRedisClusterRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster.
	RedisClusterId *string `mandatory:"true" contributesTo:"path" name:"redisClusterId"`

	// The information to be updated.
	UpdateRedisClusterDetails `contributesTo:"body"`

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

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

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

UpdateRedisClusterRequest wrapper for the UpdateRedisCluster operation

See also

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

func (UpdateRedisClusterRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateRedisClusterRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateRedisClusterRequest) RetryPolicy

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

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

func (UpdateRedisClusterRequest) String

func (request UpdateRedisClusterRequest) String() string

func (UpdateRedisClusterRequest) ValidateEnumValue

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

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

type UpdateRedisClusterResponse

type UpdateRedisClusterResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

UpdateRedisClusterResponse wrapper for the UpdateRedisCluster operation

func (UpdateRedisClusterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateRedisClusterResponse) String

func (response UpdateRedisClusterResponse) String() string

type WorkRequest

type WorkRequest struct {

	// The type of operation that spawned the work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

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

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) 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"`

	// The percentage complete of the operation tracked by the work request.
	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/rfc/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/rfc/rfc3339).
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

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

WorkRequest An asynchronous work request.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

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

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

type WorkRequestError

type WorkRequestError struct {

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

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

	// The time and time the error occured.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

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

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

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

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

type WorkRequestErrorCollection

type WorkRequestErrorCollection struct {

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

WorkRequestErrorCollection A list of errors for a work request.

func (WorkRequestErrorCollection) String

func (WorkRequestErrorCollection) ValidateEnumValue

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

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

type WorkRequestLogEntry

type WorkRequestLogEntry struct {

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

	// The date and time the log message was written.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

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

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

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

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

type WorkRequestLogEntryCollection

type WorkRequestLogEntryCollection struct {

	// A collection of work request logs.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection A list of logs for the specified work request.

func (WorkRequestLogEntryCollection) String

func (WorkRequestLogEntryCollection) ValidateEnumValue

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

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

type WorkRequestResource

type WorkRequestResource struct {

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

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the resource the work request affects.
	Identifier *string `mandatory:"true" json:"identifier"`

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

WorkRequestResource The resources that are affected by the work request.

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

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

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

type WorkRequestSummary

type WorkRequestSummary struct {

	// The type of operation that spawned the work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

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

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

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

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

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

	// The date and time the work request was created, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/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/rfc/rfc3339).
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

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

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

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

WorkRequestSummary A description of the work request status.

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

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

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

type WorkRequestSummaryCollection

type WorkRequestSummaryCollection struct {

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

WorkRequestSummaryCollection A list of work requests.

func (WorkRequestSummaryCollection) String

func (WorkRequestSummaryCollection) ValidateEnumValue

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

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

Source Files

Jump to

Keyboard shortcuts

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