func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetAuthenticationModeAuthenticationTypeEnumStringValues() []string
GetAuthenticationModeAuthenticationTypeEnumStringValues Enumerates the set of values in String for AuthenticationModeAuthenticationTypeEnum
func GetListAttachedOciCacheUsersSortByEnumStringValues() []string
GetListAttachedOciCacheUsersSortByEnumStringValues Enumerates the set of values in String for ListAttachedOciCacheUsersSortByEnum
func GetListAttachedOciCacheUsersSortOrderEnumStringValues() []string
GetListAttachedOciCacheUsersSortOrderEnumStringValues Enumerates the set of values in String for ListAttachedOciCacheUsersSortOrderEnum
func GetListAttachedRedisClustersSortByEnumStringValues() []string
GetListAttachedRedisClustersSortByEnumStringValues Enumerates the set of values in String for ListAttachedRedisClustersSortByEnum
func GetListAttachedRedisClustersSortOrderEnumStringValues() []string
GetListAttachedRedisClustersSortOrderEnumStringValues Enumerates the set of values in String for ListAttachedRedisClustersSortOrderEnum
func GetListOciCacheUsersSortByEnumStringValues() []string
GetListOciCacheUsersSortByEnumStringValues Enumerates the set of values in String for ListOciCacheUsersSortByEnum
func GetListOciCacheUsersSortOrderEnumStringValues() []string
GetListOciCacheUsersSortOrderEnumStringValues Enumerates the set of values in String for ListOciCacheUsersSortOrderEnum
func GetListRedisClusterNodesSortByEnumStringValues() []string
GetListRedisClusterNodesSortByEnumStringValues Enumerates the set of values in String for ListRedisClusterNodesSortByEnum
func GetListRedisClusterNodesSortOrderEnumStringValues() []string
GetListRedisClusterNodesSortOrderEnumStringValues Enumerates the set of values in String for ListRedisClusterNodesSortOrderEnum
func GetListRedisClustersSortByEnumStringValues() []string
GetListRedisClustersSortByEnumStringValues Enumerates the set of values in String for ListRedisClustersSortByEnum
func GetListRedisClustersSortOrderEnumStringValues() []string
GetListRedisClustersSortOrderEnumStringValues Enumerates the set of values in String for ListRedisClustersSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOciCacheUserLifecycleStateEnumStringValues() []string
GetOciCacheUserLifecycleStateEnumStringValues Enumerates the set of values in String for OciCacheUserLifecycleStateEnum
func GetOciCacheUserStatusEnumStringValues() []string
GetOciCacheUserStatusEnumStringValues Enumerates the set of values in String for OciCacheUserStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetRedisClusterClusterModeEnumStringValues() []string
GetRedisClusterClusterModeEnumStringValues Enumerates the set of values in String for RedisClusterClusterModeEnum
func GetRedisClusterLifecycleStateEnumStringValues() []string
GetRedisClusterLifecycleStateEnumStringValues Enumerates the set of values in String for RedisClusterLifecycleStateEnum
func GetRedisClusterSoftwareVersionEnumStringValues() []string
GetRedisClusterSoftwareVersionEnumStringValues Enumerates the set of values in String for RedisClusterSoftwareVersionEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AttachOciCacheUsersDetails OCI cache user details to be attached with a cluster.
type AttachOciCacheUsersDetails struct {
// List of OCI cache user unique IDs (OCIDs).
OciCacheUsers []string `mandatory:"true" json:"ociCacheUsers"`
}
func (m AttachOciCacheUsersDetails) String() string
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
AttachOciCacheUsersRequest wrapper for the AttachOciCacheUsers operation
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.
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
}
func (request AttachOciCacheUsersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AttachOciCacheUsersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AttachOciCacheUsersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AttachOciCacheUsersRequest) String() string
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
AttachOciCacheUsersResponse wrapper for the AttachOciCacheUsers operation
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"`
}
func (response AttachOciCacheUsersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AttachOciCacheUsersResponse) String() string
AttachedOciCacheCluster OciCacheCluster to which the OciCacheUser is attached.
type AttachedOciCacheCluster struct {
// OCID of the OciCacheCluster
OciCacheClusterId *string `mandatory:"true" json:"ociCacheClusterId"`
}
func (m AttachedOciCacheCluster) String() string
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
AttachedOciCacheUser OciCacheUser attached to the OciCacheCluster.
type AttachedOciCacheUser struct {
// OCID of the OciCacheUser
OciCacheUserId *string `mandatory:"true" json:"ociCacheUserId"`
}
func (m AttachedOciCacheUser) String() string
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
AuthenticationMode These are the Authentication details of an OCI cache user.
type AuthenticationMode interface {
}
AuthenticationModeAuthenticationTypeEnum Enum with underlying type: string
type AuthenticationModeAuthenticationTypeEnum string
Set of constants representing the allowable values for AuthenticationModeAuthenticationTypeEnum
const (
AuthenticationModeAuthenticationTypeIam AuthenticationModeAuthenticationTypeEnum = "IAM"
AuthenticationModeAuthenticationTypePassword AuthenticationModeAuthenticationTypeEnum = "PASSWORD"
)
func GetAuthenticationModeAuthenticationTypeEnumValues() []AuthenticationModeAuthenticationTypeEnum
GetAuthenticationModeAuthenticationTypeEnumValues Enumerates the set of values for AuthenticationModeAuthenticationTypeEnum
func GetMappingAuthenticationModeAuthenticationTypeEnum(val string) (AuthenticationModeAuthenticationTypeEnum, bool)
GetMappingAuthenticationModeAuthenticationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
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.
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
}
func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
ChangeOciCacheUserCompartmentDetails The configuration details for the move operation.
type ChangeOciCacheUserCompartmentDetails struct {
// OCID of the compartment into which the OCI cache user will be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeOciCacheUserCompartmentDetails) String() string
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
ChangeOciCacheUserCompartmentRequest wrapper for the ChangeOciCacheUserCompartment operation
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.
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
}
func (request ChangeOciCacheUserCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeOciCacheUserCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeOciCacheUserCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeOciCacheUserCompartmentRequest) String() string
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
ChangeOciCacheUserCompartmentResponse wrapper for the ChangeOciCacheUserCompartment operation
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"`
}
func (response ChangeOciCacheUserCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeOciCacheUserCompartmentResponse) String() string
ChangeRedisClusterCompartmentDetails The configuration details for the move operation.
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"`
}
func (m ChangeRedisClusterCompartmentDetails) String() string
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
ChangeRedisClusterCompartmentRequest wrapper for the ChangeRedisClusterCompartment operation
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.
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
}
func (request ChangeRedisClusterCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeRedisClusterCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeRedisClusterCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeRedisClusterCompartmentRequest) String() string
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
ChangeRedisClusterCompartmentResponse wrapper for the ChangeRedisClusterCompartment operation
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"`
}
func (response ChangeRedisClusterCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeRedisClusterCompartmentResponse) String() string
CreateIdentityTokenDetails Generate an Identity token for Redis cluster
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"`
}
func (m CreateIdentityTokenDetails) String() string
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
CreateIdentityTokenRequest wrapper for the CreateIdentityToken operation
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.
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
}
func (request CreateIdentityTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateIdentityTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateIdentityTokenRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateIdentityTokenRequest) String() string
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
CreateIdentityTokenResponse wrapper for the CreateIdentityToken operation
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"`
}
func (response CreateIdentityTokenResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateIdentityTokenResponse) String() string
CreateOciCacheUserDetails Details required to create a new OCI cache user.
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"`
}
func (m CreateOciCacheUserDetails) String() string
func (m *CreateOciCacheUserDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
CreateOciCacheUserRequest wrapper for the CreateOciCacheUser operation
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.
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
}
func (request CreateOciCacheUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOciCacheUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOciCacheUserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOciCacheUserRequest) String() string
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
CreateOciCacheUserResponse wrapper for the CreateOciCacheUser operation
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"`
}
func (response CreateOciCacheUserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOciCacheUserResponse) String() string
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).
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"`
// 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"`
}
func (m CreateRedisClusterDetails) String() string
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
CreateRedisClusterRequest wrapper for the CreateRedisCluster operation
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.
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
}
func (request CreateRedisClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRedisClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRedisClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRedisClusterRequest) String() string
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
CreateRedisClusterResponse wrapper for the CreateRedisCluster operation
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"`
}
func (response CreateRedisClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRedisClusterResponse) String() string
DeleteOciCacheUserRequest wrapper for the DeleteOciCacheUser operation
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.
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
}
func (request DeleteOciCacheUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOciCacheUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOciCacheUserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOciCacheUserRequest) String() string
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
DeleteOciCacheUserResponse wrapper for the DeleteOciCacheUser operation
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"`
}
func (response DeleteOciCacheUserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOciCacheUserResponse) String() string
DeleteRedisClusterRequest wrapper for the DeleteRedisCluster operation
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.
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
}
func (request DeleteRedisClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRedisClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRedisClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRedisClusterRequest) String() string
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
DeleteRedisClusterResponse wrapper for the DeleteRedisCluster operation
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"`
}
func (response DeleteRedisClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRedisClusterResponse) String() string
DetachOciCacheUsersDetails OCI cache user details to be detached with a cluster.
type DetachOciCacheUsersDetails struct {
// List of OCI cache user unique IDs (OCIDs).
OciCacheUsers []string `mandatory:"true" json:"ociCacheUsers"`
}
func (m DetachOciCacheUsersDetails) String() string
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
DetachOciCacheUsersRequest wrapper for the DetachOciCacheUsers operation
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.
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
}
func (request DetachOciCacheUsersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DetachOciCacheUsersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DetachOciCacheUsersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DetachOciCacheUsersRequest) String() string
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
DetachOciCacheUsersResponse wrapper for the DetachOciCacheUsers operation
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"`
}
func (response DetachOciCacheUsersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DetachOciCacheUsersResponse) String() string
GetOciCacheUserRequest wrapper for the GetOciCacheUser operation
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.
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
}
func (request GetOciCacheUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOciCacheUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOciCacheUserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOciCacheUserRequest) String() string
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
GetOciCacheUserResponse wrapper for the GetOciCacheUser operation
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"`
}
func (response GetOciCacheUserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOciCacheUserResponse) String() string
GetRedisClusterRequest wrapper for the GetRedisCluster operation
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.
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
}
func (request GetRedisClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRedisClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRedisClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRedisClusterRequest) String() string
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
GetRedisClusterResponse wrapper for the GetRedisCluster operation
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"`
}
func (response GetRedisClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRedisClusterResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
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.
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
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
IamAuthenticationMode child class of AuthenticationMode.
type IamAuthenticationMode struct {
}
func (m IamAuthenticationMode) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IamAuthenticationMode) String() string
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
IdentityTokenDetailsResponse Response an Identity token generated for Redis cluster
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"`
}
func (m IdentityTokenDetailsResponse) String() string
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
ListAttachedOciCacheUsersRequest wrapper for the ListAttachedOciCacheUsers operation
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.
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
}
func (request ListAttachedOciCacheUsersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAttachedOciCacheUsersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAttachedOciCacheUsersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAttachedOciCacheUsersRequest) String() string
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
ListAttachedOciCacheUsersResponse wrapper for the ListAttachedOciCacheUsers operation
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"`
}
func (response ListAttachedOciCacheUsersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAttachedOciCacheUsersResponse) String() string
ListAttachedOciCacheUsersSortByEnum Enum with underlying type: string
type ListAttachedOciCacheUsersSortByEnum string
Set of constants representing the allowable values for ListAttachedOciCacheUsersSortByEnum
const (
ListAttachedOciCacheUsersSortByTimecreated ListAttachedOciCacheUsersSortByEnum = "timeCreated"
ListAttachedOciCacheUsersSortByDisplayname ListAttachedOciCacheUsersSortByEnum = "displayName"
)
func GetListAttachedOciCacheUsersSortByEnumValues() []ListAttachedOciCacheUsersSortByEnum
GetListAttachedOciCacheUsersSortByEnumValues Enumerates the set of values for ListAttachedOciCacheUsersSortByEnum
func GetMappingListAttachedOciCacheUsersSortByEnum(val string) (ListAttachedOciCacheUsersSortByEnum, bool)
GetMappingListAttachedOciCacheUsersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttachedOciCacheUsersSortOrderEnum Enum with underlying type: string
type ListAttachedOciCacheUsersSortOrderEnum string
Set of constants representing the allowable values for ListAttachedOciCacheUsersSortOrderEnum
const (
ListAttachedOciCacheUsersSortOrderAsc ListAttachedOciCacheUsersSortOrderEnum = "ASC"
ListAttachedOciCacheUsersSortOrderDesc ListAttachedOciCacheUsersSortOrderEnum = "DESC"
)
func GetListAttachedOciCacheUsersSortOrderEnumValues() []ListAttachedOciCacheUsersSortOrderEnum
GetListAttachedOciCacheUsersSortOrderEnumValues Enumerates the set of values for ListAttachedOciCacheUsersSortOrderEnum
func GetMappingListAttachedOciCacheUsersSortOrderEnum(val string) (ListAttachedOciCacheUsersSortOrderEnum, bool)
GetMappingListAttachedOciCacheUsersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttachedRedisClustersRequest wrapper for the ListAttachedRedisClusters operation
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.
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
}
func (request ListAttachedRedisClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAttachedRedisClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAttachedRedisClustersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAttachedRedisClustersRequest) String() string
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
ListAttachedRedisClustersResponse wrapper for the ListAttachedRedisClusters operation
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"`
}
func (response ListAttachedRedisClustersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAttachedRedisClustersResponse) String() string
ListAttachedRedisClustersSortByEnum Enum with underlying type: string
type ListAttachedRedisClustersSortByEnum string
Set of constants representing the allowable values for ListAttachedRedisClustersSortByEnum
const (
ListAttachedRedisClustersSortByTimecreated ListAttachedRedisClustersSortByEnum = "timeCreated"
ListAttachedRedisClustersSortByDisplayname ListAttachedRedisClustersSortByEnum = "displayName"
)
func GetListAttachedRedisClustersSortByEnumValues() []ListAttachedRedisClustersSortByEnum
GetListAttachedRedisClustersSortByEnumValues Enumerates the set of values for ListAttachedRedisClustersSortByEnum
func GetMappingListAttachedRedisClustersSortByEnum(val string) (ListAttachedRedisClustersSortByEnum, bool)
GetMappingListAttachedRedisClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttachedRedisClustersSortOrderEnum Enum with underlying type: string
type ListAttachedRedisClustersSortOrderEnum string
Set of constants representing the allowable values for ListAttachedRedisClustersSortOrderEnum
const (
ListAttachedRedisClustersSortOrderAsc ListAttachedRedisClustersSortOrderEnum = "ASC"
ListAttachedRedisClustersSortOrderDesc ListAttachedRedisClustersSortOrderEnum = "DESC"
)
func GetListAttachedRedisClustersSortOrderEnumValues() []ListAttachedRedisClustersSortOrderEnum
GetListAttachedRedisClustersSortOrderEnumValues Enumerates the set of values for ListAttachedRedisClustersSortOrderEnum
func GetMappingListAttachedRedisClustersSortOrderEnum(val string) (ListAttachedRedisClustersSortOrderEnum, bool)
GetMappingListAttachedRedisClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOciCacheUsersRequest wrapper for the ListOciCacheUsers operation
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.
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
}
func (request ListOciCacheUsersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOciCacheUsersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOciCacheUsersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOciCacheUsersRequest) String() string
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
ListOciCacheUsersResponse wrapper for the ListOciCacheUsers operation
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"`
}
func (response ListOciCacheUsersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOciCacheUsersResponse) String() string
ListOciCacheUsersSortByEnum Enum with underlying type: string
type ListOciCacheUsersSortByEnum string
Set of constants representing the allowable values for ListOciCacheUsersSortByEnum
const (
ListOciCacheUsersSortByTimecreated ListOciCacheUsersSortByEnum = "timeCreated"
ListOciCacheUsersSortByDisplayname ListOciCacheUsersSortByEnum = "displayName"
)
func GetListOciCacheUsersSortByEnumValues() []ListOciCacheUsersSortByEnum
GetListOciCacheUsersSortByEnumValues Enumerates the set of values for ListOciCacheUsersSortByEnum
func GetMappingListOciCacheUsersSortByEnum(val string) (ListOciCacheUsersSortByEnum, bool)
GetMappingListOciCacheUsersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOciCacheUsersSortOrderEnum Enum with underlying type: string
type ListOciCacheUsersSortOrderEnum string
Set of constants representing the allowable values for ListOciCacheUsersSortOrderEnum
const (
ListOciCacheUsersSortOrderAsc ListOciCacheUsersSortOrderEnum = "ASC"
ListOciCacheUsersSortOrderDesc ListOciCacheUsersSortOrderEnum = "DESC"
)
func GetListOciCacheUsersSortOrderEnumValues() []ListOciCacheUsersSortOrderEnum
GetListOciCacheUsersSortOrderEnumValues Enumerates the set of values for ListOciCacheUsersSortOrderEnum
func GetMappingListOciCacheUsersSortOrderEnum(val string) (ListOciCacheUsersSortOrderEnum, bool)
GetMappingListOciCacheUsersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRedisClusterNodesRequest wrapper for the ListRedisClusterNodes operation
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.
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
}
func (request ListRedisClusterNodesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRedisClusterNodesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRedisClusterNodesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRedisClusterNodesRequest) String() string
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
ListRedisClusterNodesResponse wrapper for the ListRedisClusterNodes operation
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"`
}
func (response ListRedisClusterNodesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRedisClusterNodesResponse) String() string
ListRedisClusterNodesSortByEnum Enum with underlying type: string
type ListRedisClusterNodesSortByEnum string
Set of constants representing the allowable values for ListRedisClusterNodesSortByEnum
const (
ListRedisClusterNodesSortByTimecreated ListRedisClusterNodesSortByEnum = "timeCreated"
ListRedisClusterNodesSortByDisplayname ListRedisClusterNodesSortByEnum = "displayName"
)
func GetListRedisClusterNodesSortByEnumValues() []ListRedisClusterNodesSortByEnum
GetListRedisClusterNodesSortByEnumValues Enumerates the set of values for ListRedisClusterNodesSortByEnum
func GetMappingListRedisClusterNodesSortByEnum(val string) (ListRedisClusterNodesSortByEnum, bool)
GetMappingListRedisClusterNodesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRedisClusterNodesSortOrderEnum Enum with underlying type: string
type ListRedisClusterNodesSortOrderEnum string
Set of constants representing the allowable values for ListRedisClusterNodesSortOrderEnum
const (
ListRedisClusterNodesSortOrderAsc ListRedisClusterNodesSortOrderEnum = "ASC"
ListRedisClusterNodesSortOrderDesc ListRedisClusterNodesSortOrderEnum = "DESC"
)
func GetListRedisClusterNodesSortOrderEnumValues() []ListRedisClusterNodesSortOrderEnum
GetListRedisClusterNodesSortOrderEnumValues Enumerates the set of values for ListRedisClusterNodesSortOrderEnum
func GetMappingListRedisClusterNodesSortOrderEnum(val string) (ListRedisClusterNodesSortOrderEnum, bool)
GetMappingListRedisClusterNodesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRedisClustersRequest wrapper for the ListRedisClusters operation
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.
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
}
func (request ListRedisClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRedisClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRedisClustersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRedisClustersRequest) String() string
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
ListRedisClustersResponse wrapper for the ListRedisClusters operation
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"`
}
func (response ListRedisClustersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRedisClustersResponse) String() string
ListRedisClustersSortByEnum Enum with underlying type: string
type ListRedisClustersSortByEnum string
Set of constants representing the allowable values for ListRedisClustersSortByEnum
const (
ListRedisClustersSortByTimecreated ListRedisClustersSortByEnum = "timeCreated"
ListRedisClustersSortByDisplayname ListRedisClustersSortByEnum = "displayName"
)
func GetListRedisClustersSortByEnumValues() []ListRedisClustersSortByEnum
GetListRedisClustersSortByEnumValues Enumerates the set of values for ListRedisClustersSortByEnum
func GetMappingListRedisClustersSortByEnum(val string) (ListRedisClustersSortByEnum, bool)
GetMappingListRedisClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRedisClustersSortOrderEnum Enum with underlying type: string
type ListRedisClustersSortOrderEnum string
Set of constants representing the allowable values for ListRedisClustersSortOrderEnum
const (
ListRedisClustersSortOrderAsc ListRedisClustersSortOrderEnum = "ASC"
ListRedisClustersSortOrderDesc ListRedisClustersSortOrderEnum = "DESC"
)
func GetListRedisClustersSortOrderEnumValues() []ListRedisClustersSortOrderEnum
GetListRedisClustersSortOrderEnumValues Enumerates the set of values for ListRedisClustersSortOrderEnum
func GetMappingListRedisClustersSortOrderEnum(val string) (ListRedisClustersSortOrderEnum, bool)
GetMappingListRedisClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/redis/ListWorkRequestErrors.go.html to see an example of how to use 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
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/redis/ListWorkRequestLogs.go.html to see an example of how to use 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
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/redis/ListWorkRequests.go.html to see an example of how to use 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
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
Node The details of each node in the cluster.
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"`
}
func (m Node) String() string
func (m Node) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NodeCollection The collection of cluster nodes.
type NodeCollection struct {
// Collection of node objects.
Items []Node `mandatory:"true" json:"items"`
}
func (m NodeCollection) String() string
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
NodeSummary The details of each node in the cluster.
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"`
}
func (m NodeSummary) String() string
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
OciCacheUser An OCI cache user is required to connect to an OCI cache cluster.
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"`
}
func (m OciCacheUser) String() string
func (m *OciCacheUser) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
OciCacheUserClient a client for OciCacheUser
type OciCacheUserClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (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.
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 (client *OciCacheUserClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
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 (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).
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 (client OciCacheUserClient) GetOciCacheUser(ctx context.Context, request GetOciCacheUserRequest) (response GetOciCacheUserResponse, err error)
GetOciCacheUser Get an existing OCI Cache users based on the ID (OCID).
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 (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.
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 (client OciCacheUserClient) ListOciCacheUsers(ctx context.Context, request ListOciCacheUsersRequest) (response ListOciCacheUsersResponse, err error)
ListOciCacheUsers Lists the OCI Cache users based on the supplied parameters.
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 (client *OciCacheUserClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client OciCacheUserClient) UpdateOciCacheUser(ctx context.Context, request UpdateOciCacheUserRequest) (response UpdateOciCacheUserResponse, err error)
UpdateOciCacheUser Update an existing OCI Cache User with new details.
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()
OciCacheUserCollection A list of OCI cache users that match filter criteria, if any.
type OciCacheUserCollection struct {
// A collection of OCI Cache users.
Items []OciCacheUserSummary `mandatory:"true" json:"items"`
}
func (m OciCacheUserCollection) String() string
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
OciCacheUserLifecycleStateEnum Enum with underlying type: string
type OciCacheUserLifecycleStateEnum string
Set of constants representing the allowable values for OciCacheUserLifecycleStateEnum
const (
OciCacheUserLifecycleStateCreating OciCacheUserLifecycleStateEnum = "CREATING"
OciCacheUserLifecycleStateUpdating OciCacheUserLifecycleStateEnum = "UPDATING"
OciCacheUserLifecycleStateActive OciCacheUserLifecycleStateEnum = "ACTIVE"
OciCacheUserLifecycleStateDeleting OciCacheUserLifecycleStateEnum = "DELETING"
OciCacheUserLifecycleStateDeleted OciCacheUserLifecycleStateEnum = "DELETED"
OciCacheUserLifecycleStateFailed OciCacheUserLifecycleStateEnum = "FAILED"
)
func GetMappingOciCacheUserLifecycleStateEnum(val string) (OciCacheUserLifecycleStateEnum, bool)
GetMappingOciCacheUserLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOciCacheUserLifecycleStateEnumValues() []OciCacheUserLifecycleStateEnum
GetOciCacheUserLifecycleStateEnumValues Enumerates the set of values for OciCacheUserLifecycleStateEnum
OciCacheUserStatusEnum Enum with underlying type: string
type OciCacheUserStatusEnum string
Set of constants representing the allowable values for OciCacheUserStatusEnum
const (
OciCacheUserStatusOn OciCacheUserStatusEnum = "ON"
OciCacheUserStatusOff OciCacheUserStatusEnum = "OFF"
)
func GetMappingOciCacheUserStatusEnum(val string) (OciCacheUserStatusEnum, bool)
GetMappingOciCacheUserStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOciCacheUserStatusEnumValues() []OciCacheUserStatusEnum
GetOciCacheUserStatusEnumValues Enumerates the set of values for OciCacheUserStatusEnum
OciCacheUserSummary OCI Cache user summary.
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"`
}
func (m OciCacheUserSummary) String() string
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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
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"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PasswordAuthenticationMode child class of AuthenticationMode.
type PasswordAuthenticationMode struct {
// SHA-256 hashed passwords for OCI Cache user,required if authenticationType is set to PASSWORD.
HashedPasswords []string `mandatory:"true" json:"hashedPasswords"`
}
func (m PasswordAuthenticationMode) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PasswordAuthenticationMode) String() string
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
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).
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 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"`
// 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"`
}
func (m RedisCluster) String() string
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
RedisClusterClient a client for RedisCluster
type RedisClusterClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client RedisClusterClient) AttachOciCacheUsers(ctx context.Context, request AttachOciCacheUsersRequest) (response AttachOciCacheUsersResponse, err error)
AttachOciCacheUsers Attach existing OCI cache users to a redis cluster.
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 (client RedisClusterClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels the specified work request.
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 (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).
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 (client *RedisClusterClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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).
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 (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).
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 (client RedisClusterClient) DetachOciCacheUsers(ctx context.Context, request DetachOciCacheUsersRequest) (response DetachOciCacheUsersResponse, err error)
DetachOciCacheUsers Detach existing OCI cache users to a redis cluster.
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 (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).
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 (client RedisClusterClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
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 (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.
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 (client RedisClusterClient) ListRedisClusterNodes(ctx context.Context, request ListRedisClusterNodesRequest) (response ListRedisClusterNodesResponse, err error)
ListRedisClusterNodes Gets the list of all nodes in a cluster.
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 (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).
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 (client RedisClusterClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a list of errors for a given work request.
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 (client RedisClusterClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a list of logs for a given work request.
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 (client RedisClusterClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/redis/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *RedisClusterClient) SetRegion(region string)
SetRegion overrides the region of this client.
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).
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()
RedisClusterClusterModeEnum Enum with underlying type: string
type RedisClusterClusterModeEnum string
Set of constants representing the allowable values for RedisClusterClusterModeEnum
const (
RedisClusterClusterModeSharded RedisClusterClusterModeEnum = "SHARDED"
RedisClusterClusterModeNonsharded RedisClusterClusterModeEnum = "NONSHARDED"
)
func GetMappingRedisClusterClusterModeEnum(val string) (RedisClusterClusterModeEnum, bool)
GetMappingRedisClusterClusterModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRedisClusterClusterModeEnumValues() []RedisClusterClusterModeEnum
GetRedisClusterClusterModeEnumValues Enumerates the set of values for RedisClusterClusterModeEnum
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).
type RedisClusterCollection struct {
// The list of clusters.
Items []RedisClusterSummary `mandatory:"true" json:"items"`
}
func (m RedisClusterCollection) String() string
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
RedisClusterLifecycleStateEnum Enum with underlying type: string
type RedisClusterLifecycleStateEnum string
Set of constants representing the allowable values for RedisClusterLifecycleStateEnum
const (
RedisClusterLifecycleStateCreating RedisClusterLifecycleStateEnum = "CREATING"
RedisClusterLifecycleStateUpdating RedisClusterLifecycleStateEnum = "UPDATING"
RedisClusterLifecycleStateActive RedisClusterLifecycleStateEnum = "ACTIVE"
RedisClusterLifecycleStateDeleting RedisClusterLifecycleStateEnum = "DELETING"
RedisClusterLifecycleStateDeleted RedisClusterLifecycleStateEnum = "DELETED"
RedisClusterLifecycleStateFailed RedisClusterLifecycleStateEnum = "FAILED"
)
func GetMappingRedisClusterLifecycleStateEnum(val string) (RedisClusterLifecycleStateEnum, bool)
GetMappingRedisClusterLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRedisClusterLifecycleStateEnumValues() []RedisClusterLifecycleStateEnum
GetRedisClusterLifecycleStateEnumValues Enumerates the set of values for RedisClusterLifecycleStateEnum
RedisClusterSoftwareVersionEnum Enum with underlying type: string
type RedisClusterSoftwareVersionEnum string
Set of constants representing the allowable values for RedisClusterSoftwareVersionEnum
const (
RedisClusterSoftwareVersionV705 RedisClusterSoftwareVersionEnum = "V7_0_5"
RedisClusterSoftwareVersionRedis70 RedisClusterSoftwareVersionEnum = "REDIS_7_0"
RedisClusterSoftwareVersionValkey72 RedisClusterSoftwareVersionEnum = "VALKEY_7_2"
)
func GetMappingRedisClusterSoftwareVersionEnum(val string) (RedisClusterSoftwareVersionEnum, bool)
GetMappingRedisClusterSoftwareVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRedisClusterSoftwareVersionEnumValues() []RedisClusterSoftwareVersionEnum
GetRedisClusterSoftwareVersionEnumValues Enumerates the set of values for RedisClusterSoftwareVersionEnum
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).
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 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"`
// 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"`
}
func (m RedisClusterSummary) String() string
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
RedisIdentityClient a client for RedisIdentity
type RedisIdentityClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client *RedisIdentityClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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
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 (client *RedisIdentityClient) SetRegion(region string)
SetRegion overrides the region of this client.
RedisNodeCollection A list of nodes in a cluster that match filter criteria, if any.
type RedisNodeCollection struct {
// The list of nodes in a cluster.
Items []NodeSummary `mandatory:"true" json:"items"`
}
func (m RedisNodeCollection) String() string
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
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
UpdateOciCacheUserDetails Details required to update an existing OCI cache user.
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"`
}
func (m UpdateOciCacheUserDetails) String() string
func (m *UpdateOciCacheUserDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
UpdateOciCacheUserRequest wrapper for the UpdateOciCacheUser operation
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.
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
}
func (request UpdateOciCacheUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOciCacheUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOciCacheUserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOciCacheUserRequest) String() string
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
UpdateOciCacheUserResponse wrapper for the UpdateOciCacheUser operation
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"`
}
func (response UpdateOciCacheUserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOciCacheUserResponse) String() string
UpdateRedisClusterDetails The configuration to update for an existing cluster.
type UpdateRedisClusterDetails struct {
// 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"`
}
func (m UpdateRedisClusterDetails) String() string
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
UpdateRedisClusterRequest wrapper for the UpdateRedisCluster operation
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.
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
}
func (request UpdateRedisClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRedisClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRedisClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRedisClusterRequest) String() string
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
UpdateRedisClusterResponse wrapper for the UpdateRedisCluster operation
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"`
}
func (response UpdateRedisClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRedisClusterResponse) String() string
WorkRequest An asynchronous work request.
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"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing an operation that is tracked by a work request.
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"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection A list of errors for a work request.
type WorkRequestErrorCollection struct {
// A collection of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from executing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time the log message was written.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection A list of logs for the specified work request.
type WorkRequestLogEntryCollection struct {
// A collection of work request logs.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource The resources that are affected by the work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the `IN_PROGRESS` state until
// work is complete for that resource at which point it will transition to `CREATED`, `UPDATED`,
// or `DELETED`, respectively.
ActionType 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"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummary A description of the work request status.
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"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryCollection A list of work requests.
type WorkRequestSummaryCollection struct {
// A collection of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly