func GetClientOptionsAccessEnumStringValues() []string
GetClientOptionsAccessEnumStringValues Enumerates the set of values in String for ClientOptionsAccessEnum
func GetClientOptionsAllowedAuthEnumStringValues() []string
GetClientOptionsAllowedAuthEnumStringValues Enumerates the set of values in String for ClientOptionsAllowedAuthEnum
func GetClientOptionsIdentitySquashEnumStringValues() []string
GetClientOptionsIdentitySquashEnumStringValues Enumerates the set of values in String for ClientOptionsIdentitySquashEnum
func GetCreateFileSystemDetailsCloneAttachStatusEnumStringValues() []string
GetCreateFileSystemDetailsCloneAttachStatusEnumStringValues Enumerates the set of values in String for CreateFileSystemDetailsCloneAttachStatusEnum
func GetCreateLdapIdmapDetailsSchemaTypeEnumStringValues() []string
GetCreateLdapIdmapDetailsSchemaTypeEnumStringValues Enumerates the set of values in String for CreateLdapIdmapDetailsSchemaTypeEnum
func GetCreateQuotaRuleDetailsPrincipalTypeEnumStringValues() []string
GetCreateQuotaRuleDetailsPrincipalTypeEnumStringValues Enumerates the set of values in String for CreateQuotaRuleDetailsPrincipalTypeEnum
func GetDeleteReplicationDeleteModeEnumStringValues() []string
GetDeleteReplicationDeleteModeEnumStringValues Enumerates the set of values in String for DeleteReplicationDeleteModeEnum
func GetExportLifecycleStateEnumStringValues() []string
GetExportLifecycleStateEnumStringValues Enumerates the set of values in String for ExportLifecycleStateEnum
func GetExportSetLifecycleStateEnumStringValues() []string
GetExportSetLifecycleStateEnumStringValues Enumerates the set of values in String for ExportSetLifecycleStateEnum
func GetExportSetSummaryLifecycleStateEnumStringValues() []string
GetExportSetSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for ExportSetSummaryLifecycleStateEnum
func GetExportSummaryLifecycleStateEnumStringValues() []string
GetExportSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for ExportSummaryLifecycleStateEnum
func GetFileSystemCloneAttachStatusEnumStringValues() []string
GetFileSystemCloneAttachStatusEnumStringValues Enumerates the set of values in String for FileSystemCloneAttachStatusEnum
func GetFileSystemLifecycleStateEnumStringValues() []string
GetFileSystemLifecycleStateEnumStringValues Enumerates the set of values in String for FileSystemLifecycleStateEnum
func GetFileSystemQuotaEnforcementStateEnumStringValues() []string
GetFileSystemQuotaEnforcementStateEnumStringValues Enumerates the set of values in String for FileSystemQuotaEnforcementStateEnum
func GetFileSystemSummaryCloneAttachStatusEnumStringValues() []string
GetFileSystemSummaryCloneAttachStatusEnumStringValues Enumerates the set of values in String for FileSystemSummaryCloneAttachStatusEnum
func GetFileSystemSummaryLifecycleStateEnumStringValues() []string
GetFileSystemSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for FileSystemSummaryLifecycleStateEnum
func GetFileSystemSummaryQuotaEnforcementStateEnumStringValues() []string
GetFileSystemSummaryQuotaEnforcementStateEnumStringValues Enumerates the set of values in String for FileSystemSummaryQuotaEnforcementStateEnum
func GetFilesystemSnapshotPolicyLifecycleStateEnumStringValues() []string
GetFilesystemSnapshotPolicyLifecycleStateEnumStringValues Enumerates the set of values in String for FilesystemSnapshotPolicyLifecycleStateEnum
func GetFilesystemSnapshotPolicySummaryLifecycleStateEnumStringValues() []string
GetFilesystemSnapshotPolicySummaryLifecycleStateEnumStringValues Enumerates the set of values in String for FilesystemSnapshotPolicySummaryLifecycleStateEnum
func GetKerberosKeytabEntryEncryptionTypeEnumStringValues() []string
GetKerberosKeytabEntryEncryptionTypeEnumStringValues Enumerates the set of values in String for KerberosKeytabEntryEncryptionTypeEnum
func GetLdapIdmapSchemaTypeEnumStringValues() []string
GetLdapIdmapSchemaTypeEnumStringValues Enumerates the set of values in String for LdapIdmapSchemaTypeEnum
func GetListExportSetsLifecycleStateEnumStringValues() []string
GetListExportSetsLifecycleStateEnumStringValues Enumerates the set of values in String for ListExportSetsLifecycleStateEnum
func GetListExportSetsSortByEnumStringValues() []string
GetListExportSetsSortByEnumStringValues Enumerates the set of values in String for ListExportSetsSortByEnum
func GetListExportSetsSortOrderEnumStringValues() []string
GetListExportSetsSortOrderEnumStringValues Enumerates the set of values in String for ListExportSetsSortOrderEnum
func GetListExportsLifecycleStateEnumStringValues() []string
GetListExportsLifecycleStateEnumStringValues Enumerates the set of values in String for ListExportsLifecycleStateEnum
func GetListExportsSortByEnumStringValues() []string
GetListExportsSortByEnumStringValues Enumerates the set of values in String for ListExportsSortByEnum
func GetListExportsSortOrderEnumStringValues() []string
GetListExportsSortOrderEnumStringValues Enumerates the set of values in String for ListExportsSortOrderEnum
func GetListFileSystemsLifecycleStateEnumStringValues() []string
GetListFileSystemsLifecycleStateEnumStringValues Enumerates the set of values in String for ListFileSystemsLifecycleStateEnum
func GetListFileSystemsSortByEnumStringValues() []string
GetListFileSystemsSortByEnumStringValues Enumerates the set of values in String for ListFileSystemsSortByEnum
func GetListFileSystemsSortOrderEnumStringValues() []string
GetListFileSystemsSortOrderEnumStringValues Enumerates the set of values in String for ListFileSystemsSortOrderEnum
func GetListFilesystemSnapshotPoliciesLifecycleStateEnumStringValues() []string
GetListFilesystemSnapshotPoliciesLifecycleStateEnumStringValues Enumerates the set of values in String for ListFilesystemSnapshotPoliciesLifecycleStateEnum
func GetListFilesystemSnapshotPoliciesSortByEnumStringValues() []string
GetListFilesystemSnapshotPoliciesSortByEnumStringValues Enumerates the set of values in String for ListFilesystemSnapshotPoliciesSortByEnum
func GetListFilesystemSnapshotPoliciesSortOrderEnumStringValues() []string
GetListFilesystemSnapshotPoliciesSortOrderEnumStringValues Enumerates the set of values in String for ListFilesystemSnapshotPoliciesSortOrderEnum
func GetListMountTargetsLifecycleStateEnumStringValues() []string
GetListMountTargetsLifecycleStateEnumStringValues Enumerates the set of values in String for ListMountTargetsLifecycleStateEnum
func GetListMountTargetsSortByEnumStringValues() []string
GetListMountTargetsSortByEnumStringValues Enumerates the set of values in String for ListMountTargetsSortByEnum
func GetListMountTargetsSortOrderEnumStringValues() []string
GetListMountTargetsSortOrderEnumStringValues Enumerates the set of values in String for ListMountTargetsSortOrderEnum
func GetListOutboundConnectorsLifecycleStateEnumStringValues() []string
GetListOutboundConnectorsLifecycleStateEnumStringValues Enumerates the set of values in String for ListOutboundConnectorsLifecycleStateEnum
func GetListOutboundConnectorsSortByEnumStringValues() []string
GetListOutboundConnectorsSortByEnumStringValues Enumerates the set of values in String for ListOutboundConnectorsSortByEnum
func GetListOutboundConnectorsSortOrderEnumStringValues() []string
GetListOutboundConnectorsSortOrderEnumStringValues Enumerates the set of values in String for ListOutboundConnectorsSortOrderEnum
func GetListQuotaRulesPrincipalTypeEnumStringValues() []string
GetListQuotaRulesPrincipalTypeEnumStringValues Enumerates the set of values in String for ListQuotaRulesPrincipalTypeEnum
func GetListQuotaRulesSortOrderEnumStringValues() []string
GetListQuotaRulesSortOrderEnumStringValues Enumerates the set of values in String for ListQuotaRulesSortOrderEnum
func GetListReplicationTargetsLifecycleStateEnumStringValues() []string
GetListReplicationTargetsLifecycleStateEnumStringValues Enumerates the set of values in String for ListReplicationTargetsLifecycleStateEnum
func GetListReplicationTargetsSortByEnumStringValues() []string
GetListReplicationTargetsSortByEnumStringValues Enumerates the set of values in String for ListReplicationTargetsSortByEnum
func GetListReplicationTargetsSortOrderEnumStringValues() []string
GetListReplicationTargetsSortOrderEnumStringValues Enumerates the set of values in String for ListReplicationTargetsSortOrderEnum
func GetListReplicationsLifecycleStateEnumStringValues() []string
GetListReplicationsLifecycleStateEnumStringValues Enumerates the set of values in String for ListReplicationsLifecycleStateEnum
func GetListReplicationsSortByEnumStringValues() []string
GetListReplicationsSortByEnumStringValues Enumerates the set of values in String for ListReplicationsSortByEnum
func GetListReplicationsSortOrderEnumStringValues() []string
GetListReplicationsSortOrderEnumStringValues Enumerates the set of values in String for ListReplicationsSortOrderEnum
func GetListSnapshotsLifecycleStateEnumStringValues() []string
GetListSnapshotsLifecycleStateEnumStringValues Enumerates the set of values in String for ListSnapshotsLifecycleStateEnum
func GetListSnapshotsSortOrderEnumStringValues() []string
GetListSnapshotsSortOrderEnumStringValues Enumerates the set of values in String for ListSnapshotsSortOrderEnum
func GetMountTargetIdmapTypeEnumStringValues() []string
GetMountTargetIdmapTypeEnumStringValues Enumerates the set of values in String for MountTargetIdmapTypeEnum
func GetMountTargetLifecycleStateEnumStringValues() []string
GetMountTargetLifecycleStateEnumStringValues Enumerates the set of values in String for MountTargetLifecycleStateEnum
func GetMountTargetSummaryLifecycleStateEnumStringValues() []string
GetMountTargetSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for MountTargetSummaryLifecycleStateEnum
func GetOutboundConnectorConnectorTypeEnumStringValues() []string
GetOutboundConnectorConnectorTypeEnumStringValues Enumerates the set of values in String for OutboundConnectorConnectorTypeEnum
func GetOutboundConnectorLifecycleStateEnumStringValues() []string
GetOutboundConnectorLifecycleStateEnumStringValues Enumerates the set of values in String for OutboundConnectorLifecycleStateEnum
func GetOutboundConnectorSummaryLifecycleStateEnumStringValues() []string
GetOutboundConnectorSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for OutboundConnectorSummaryLifecycleStateEnum
func GetQuotaRulePrincipalTypeEnumStringValues() []string
GetQuotaRulePrincipalTypeEnumStringValues Enumerates the set of values in String for QuotaRulePrincipalTypeEnum
func GetQuotaRuleSummaryPrincipalTypeEnumStringValues() []string
GetQuotaRuleSummaryPrincipalTypeEnumStringValues Enumerates the set of values in String for QuotaRuleSummaryPrincipalTypeEnum
func GetReplicationDeltaStatusEnumStringValues() []string
GetReplicationDeltaStatusEnumStringValues Enumerates the set of values in String for ReplicationDeltaStatusEnum
func GetReplicationLifecycleStateEnumStringValues() []string
GetReplicationLifecycleStateEnumStringValues Enumerates the set of values in String for ReplicationLifecycleStateEnum
func GetReplicationSummaryLifecycleStateEnumStringValues() []string
GetReplicationSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for ReplicationSummaryLifecycleStateEnum
func GetReplicationTargetDeltaStatusEnumStringValues() []string
GetReplicationTargetDeltaStatusEnumStringValues Enumerates the set of values in String for ReplicationTargetDeltaStatusEnum
func GetReplicationTargetLifecycleStateEnumStringValues() []string
GetReplicationTargetLifecycleStateEnumStringValues Enumerates the set of values in String for ReplicationTargetLifecycleStateEnum
func GetReplicationTargetSummaryLifecycleStateEnumStringValues() []string
GetReplicationTargetSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for ReplicationTargetSummaryLifecycleStateEnum
func GetResourceLockTypeEnumStringValues() []string
GetResourceLockTypeEnumStringValues Enumerates the set of values in String for ResourceLockTypeEnum
func GetSnapshotLifecycleStateEnumStringValues() []string
GetSnapshotLifecycleStateEnumStringValues Enumerates the set of values in String for SnapshotLifecycleStateEnum
func GetSnapshotScheduleDayOfWeekEnumStringValues() []string
GetSnapshotScheduleDayOfWeekEnumStringValues Enumerates the set of values in String for SnapshotScheduleDayOfWeekEnum
func GetSnapshotScheduleMonthEnumStringValues() []string
GetSnapshotScheduleMonthEnumStringValues Enumerates the set of values in String for SnapshotScheduleMonthEnum
func GetSnapshotSchedulePeriodEnumStringValues() []string
GetSnapshotSchedulePeriodEnumStringValues Enumerates the set of values in String for SnapshotSchedulePeriodEnum
func GetSnapshotScheduleTimeZoneEnumStringValues() []string
GetSnapshotScheduleTimeZoneEnumStringValues Enumerates the set of values in String for SnapshotScheduleTimeZoneEnum
func GetSnapshotSnapshotTypeEnumStringValues() []string
GetSnapshotSnapshotTypeEnumStringValues Enumerates the set of values in String for SnapshotSnapshotTypeEnum
func GetSnapshotSummaryLifecycleStateEnumStringValues() []string
GetSnapshotSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for SnapshotSummaryLifecycleStateEnum
func GetSnapshotSummarySnapshotTypeEnumStringValues() []string
GetSnapshotSummarySnapshotTypeEnumStringValues Enumerates the set of values in String for SnapshotSummarySnapshotTypeEnum
func GetUpdateLdapIdmapDetailsSchemaTypeEnumStringValues() []string
GetUpdateLdapIdmapDetailsSchemaTypeEnumStringValues Enumerates the set of values in String for UpdateLdapIdmapDetailsSchemaTypeEnum
AddExportLockRequest wrapper for the AddExportLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddExportLock.go.html to see an example of how to use AddExportLockRequest.
type AddExportLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export.
ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"`
// The details to be updated for the AddLock.
AddExportLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 AddExportLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddExportLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddExportLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddExportLockRequest) String() string
func (request AddExportLockRequest) 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
AddExportLockResponse wrapper for the AddExportLock operation
type AddExportLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Export instance
Export `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 AddExportLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddExportLockResponse) String() string
AddFileSystemLockRequest wrapper for the AddFileSystemLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddFileSystemLock.go.html to see an example of how to use AddFileSystemLockRequest.
type AddFileSystemLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// The details to be updated for the AddLock.
AddFileSystemLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 AddFileSystemLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddFileSystemLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddFileSystemLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddFileSystemLockRequest) String() string
func (request AddFileSystemLockRequest) 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
AddFileSystemLockResponse wrapper for the AddFileSystemLock operation
type AddFileSystemLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The FileSystem instance
FileSystem `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 AddFileSystemLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddFileSystemLockResponse) String() string
AddFilesystemSnapshotPolicyLockRequest wrapper for the AddFilesystemSnapshotPolicyLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddFilesystemSnapshotPolicyLock.go.html to see an example of how to use AddFilesystemSnapshotPolicyLockRequest.
type AddFilesystemSnapshotPolicyLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
FilesystemSnapshotPolicyId *string `mandatory:"true" contributesTo:"path" name:"filesystemSnapshotPolicyId"`
// The details to be updated for the AddLock.
AddFilesystemSnapshotPolicyLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 AddFilesystemSnapshotPolicyLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddFilesystemSnapshotPolicyLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddFilesystemSnapshotPolicyLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddFilesystemSnapshotPolicyLockRequest) String() string
func (request AddFilesystemSnapshotPolicyLockRequest) 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
AddFilesystemSnapshotPolicyLockResponse wrapper for the AddFilesystemSnapshotPolicyLock operation
type AddFilesystemSnapshotPolicyLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The FilesystemSnapshotPolicy instance
FilesystemSnapshotPolicy `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 AddFilesystemSnapshotPolicyLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddFilesystemSnapshotPolicyLockResponse) String() string
AddMountTargetLockRequest wrapper for the AddMountTargetLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddMountTargetLock.go.html to see an example of how to use AddMountTargetLockRequest.
type AddMountTargetLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`
// The details to be updated for the AddLock.
AddMountTargetLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 AddMountTargetLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddMountTargetLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddMountTargetLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddMountTargetLockRequest) String() string
func (request AddMountTargetLockRequest) 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
AddMountTargetLockResponse wrapper for the AddMountTargetLock operation
type AddMountTargetLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The MountTarget instance
MountTarget `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 AddMountTargetLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddMountTargetLockResponse) String() string
AddOutboundConnectorLockRequest wrapper for the AddOutboundConnectorLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddOutboundConnectorLock.go.html to see an example of how to use AddOutboundConnectorLockRequest.
type AddOutboundConnectorLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector.
OutboundConnectorId *string `mandatory:"true" contributesTo:"path" name:"outboundConnectorId"`
// The details to be updated for the AddLock.
AddOutboundConnectorLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 AddOutboundConnectorLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddOutboundConnectorLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddOutboundConnectorLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddOutboundConnectorLockRequest) String() string
func (request AddOutboundConnectorLockRequest) 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
AddOutboundConnectorLockResponse wrapper for the AddOutboundConnectorLock operation
type AddOutboundConnectorLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The OutboundConnector instance
OutboundConnector `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 AddOutboundConnectorLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddOutboundConnectorLockResponse) String() string
AddReplicationLockRequest wrapper for the AddReplicationLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddReplicationLock.go.html to see an example of how to use AddReplicationLockRequest.
type AddReplicationLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication.
ReplicationId *string `mandatory:"true" contributesTo:"path" name:"replicationId"`
// The details to be updated for the AddLock.
AddReplicationLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 AddReplicationLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddReplicationLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddReplicationLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddReplicationLockRequest) String() string
func (request AddReplicationLockRequest) 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
AddReplicationLockResponse wrapper for the AddReplicationLock operation
type AddReplicationLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Replication instance
Replication `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 AddReplicationLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddReplicationLockResponse) String() string
AddSnapshotLockRequest wrapper for the AddSnapshotLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddSnapshotLock.go.html to see an example of how to use AddSnapshotLockRequest.
type AddSnapshotLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot.
SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`
// The details to be updated for the AddLock.
AddSnapshotLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 AddSnapshotLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddSnapshotLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddSnapshotLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddSnapshotLockRequest) String() string
func (request AddSnapshotLockRequest) 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
AddSnapshotLockResponse wrapper for the AddSnapshotLock operation
type AddSnapshotLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Snapshot instance
Snapshot `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 AddSnapshotLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddSnapshotLockResponse) String() string
CancelDowngradeShapeMountTargetRequest wrapper for the CancelDowngradeShapeMountTarget operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CancelDowngradeShapeMountTarget.go.html to see an example of how to use CancelDowngradeShapeMountTargetRequest.
type CancelDowngradeShapeMountTargetRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 CancelDowngradeShapeMountTargetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelDowngradeShapeMountTargetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelDowngradeShapeMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelDowngradeShapeMountTargetRequest) String() string
func (request CancelDowngradeShapeMountTargetRequest) 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
CancelDowngradeShapeMountTargetResponse wrapper for the CancelDowngradeShapeMountTarget operation
type CancelDowngradeShapeMountTargetResponse struct {
// The underlying http response
RawResponse *http.Response
// The MountTarget instance
MountTarget `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 CancelDowngradeShapeMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelDowngradeShapeMountTargetResponse) String() string
ChangeFileSystemCompartmentDetails Details for changing the compartment.
type ChangeFileSystemCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the file system to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeFileSystemCompartmentDetails) String() string
func (m ChangeFileSystemCompartmentDetails) 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
ChangeFileSystemCompartmentRequest wrapper for the ChangeFileSystemCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ChangeFileSystemCompartment.go.html to see an example of how to use ChangeFileSystemCompartmentRequest.
type ChangeFileSystemCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// Details for changing the compartment.
ChangeFileSystemCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 ChangeFileSystemCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeFileSystemCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeFileSystemCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeFileSystemCompartmentRequest) String() string
func (request ChangeFileSystemCompartmentRequest) 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
ChangeFileSystemCompartmentResponse wrapper for the ChangeFileSystemCompartment operation
type ChangeFileSystemCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeFileSystemCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeFileSystemCompartmentResponse) String() string
ChangeFilesystemSnapshotPolicyCompartmentDetails Details for changing the compartment of a file system snapshot policy.
type ChangeFilesystemSnapshotPolicyCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the file system snapshot policy to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeFilesystemSnapshotPolicyCompartmentDetails) String() string
func (m ChangeFilesystemSnapshotPolicyCompartmentDetails) 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
ChangeFilesystemSnapshotPolicyCompartmentRequest wrapper for the ChangeFilesystemSnapshotPolicyCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ChangeFilesystemSnapshotPolicyCompartment.go.html to see an example of how to use ChangeFilesystemSnapshotPolicyCompartmentRequest.
type ChangeFilesystemSnapshotPolicyCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
FilesystemSnapshotPolicyId *string `mandatory:"true" contributesTo:"path" name:"filesystemSnapshotPolicyId"`
// Details for changing the compartment of a file system snapshot policy.
ChangeFilesystemSnapshotPolicyCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 ChangeFilesystemSnapshotPolicyCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeFilesystemSnapshotPolicyCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeFilesystemSnapshotPolicyCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeFilesystemSnapshotPolicyCompartmentRequest) String() string
func (request ChangeFilesystemSnapshotPolicyCompartmentRequest) 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
ChangeFilesystemSnapshotPolicyCompartmentResponse wrapper for the ChangeFilesystemSnapshotPolicyCompartment operation
type ChangeFilesystemSnapshotPolicyCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeFilesystemSnapshotPolicyCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeFilesystemSnapshotPolicyCompartmentResponse) String() string
ChangeMountTargetCompartmentDetails Details for changing the compartment.
type ChangeMountTargetCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the mount target to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeMountTargetCompartmentDetails) String() string
func (m ChangeMountTargetCompartmentDetails) 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
ChangeMountTargetCompartmentRequest wrapper for the ChangeMountTargetCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ChangeMountTargetCompartment.go.html to see an example of how to use ChangeMountTargetCompartmentRequest.
type ChangeMountTargetCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`
// Details for changing the compartment.
ChangeMountTargetCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 ChangeMountTargetCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeMountTargetCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeMountTargetCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeMountTargetCompartmentRequest) String() string
func (request ChangeMountTargetCompartmentRequest) 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
ChangeMountTargetCompartmentResponse wrapper for the ChangeMountTargetCompartment operation
type ChangeMountTargetCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeMountTargetCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeMountTargetCompartmentResponse) String() string
ChangeOutboundConnectorCompartmentDetails Details for changing the compartment of the outbound connector.
type ChangeOutboundConnectorCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// to move the outbound connector to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeOutboundConnectorCompartmentDetails) String() string
func (m ChangeOutboundConnectorCompartmentDetails) 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
ChangeOutboundConnectorCompartmentRequest wrapper for the ChangeOutboundConnectorCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ChangeOutboundConnectorCompartment.go.html to see an example of how to use ChangeOutboundConnectorCompartmentRequest.
type ChangeOutboundConnectorCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector.
OutboundConnectorId *string `mandatory:"true" contributesTo:"path" name:"outboundConnectorId"`
// Details for changing the compartment.
ChangeOutboundConnectorCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 ChangeOutboundConnectorCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeOutboundConnectorCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeOutboundConnectorCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeOutboundConnectorCompartmentRequest) String() string
func (request ChangeOutboundConnectorCompartmentRequest) 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
ChangeOutboundConnectorCompartmentResponse wrapper for the ChangeOutboundConnectorCompartment operation
type ChangeOutboundConnectorCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeOutboundConnectorCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeOutboundConnectorCompartmentResponse) String() string
ChangeReplicationCompartmentDetails Details for changing the compartment of both replication and replication target.
type ChangeReplicationCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the replication to. Also changes the replication target's compartment in the target region.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeReplicationCompartmentDetails) String() string
func (m ChangeReplicationCompartmentDetails) 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
ChangeReplicationCompartmentRequest wrapper for the ChangeReplicationCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ChangeReplicationCompartment.go.html to see an example of how to use ChangeReplicationCompartmentRequest.
type ChangeReplicationCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication.
ReplicationId *string `mandatory:"true" contributesTo:"path" name:"replicationId"`
// Details for changing the compartment.
ChangeReplicationCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 ChangeReplicationCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeReplicationCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeReplicationCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeReplicationCompartmentRequest) String() string
func (request ChangeReplicationCompartmentRequest) 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
ChangeReplicationCompartmentResponse wrapper for the ChangeReplicationCompartment operation
type ChangeReplicationCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeReplicationCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeReplicationCompartmentResponse) String() string
ClientOptions NFS export options applied to a specified set of clients. Only governs access through the associated export. Access to the same file system through a different export (on the same or different mount target) will be governed by that export's export options.
type ClientOptions struct {
// Clients these options should apply to. Must be a either
// single IPv4 address or single IPv4 CIDR block.
// **Note:** Access will also be limited by any applicable VCN
// security rules and the ability to route IP packets to the
// mount target. Mount targets do not have Internet-routable IP addresses.
Source *string `mandatory:"true" json:"source"`
// If `true`, clients accessing the file system through this
// export must connect from a privileged source port. If
// unspecified, defaults to `true`.
RequirePrivilegedSourcePort *bool `mandatory:"false" json:"requirePrivilegedSourcePort"`
// Type of access to grant clients using the file system
// through this export. If unspecified defaults to `READ_WRITE`.
Access ClientOptionsAccessEnum `mandatory:"false" json:"access,omitempty"`
// Used when clients accessing the file system through this export
// have their UID and GID remapped to 'anonymousUid' and
// 'anonymousGid'. If `ALL`, all users and groups are remapped;
// if `ROOT`, only the root user and group (UID/GID 0) are
// remapped; if `NONE`, no remapping is done. If unspecified,
// defaults to `ROOT`.
IdentitySquash ClientOptionsIdentitySquashEnum `mandatory:"false" json:"identitySquash,omitempty"`
// UID value to remap to when squashing a client UID (see
// identitySquash for more details.) If unspecified, defaults
// to `65534`.
AnonymousUid *int64 `mandatory:"false" json:"anonymousUid"`
// GID value to remap to when squashing a client GID (see
// identitySquash for more details.) If unspecified defaults
// to `65534`.
AnonymousGid *int64 `mandatory:"false" json:"anonymousGid"`
// Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping.
// If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID.
IsAnonymousAccessAllowed *bool `mandatory:"false" json:"isAnonymousAccessAllowed"`
// Array of allowed NFS authentication types.
AllowedAuth []ClientOptionsAllowedAuthEnum `mandatory:"false" json:"allowedAuth,omitempty"`
}
func (m ClientOptions) String() string
func (m ClientOptions) 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
ClientOptionsAccessEnum Enum with underlying type: string
type ClientOptionsAccessEnum string
Set of constants representing the allowable values for ClientOptionsAccessEnum
const (
ClientOptionsAccessWrite ClientOptionsAccessEnum = "READ_WRITE"
ClientOptionsAccessOnly ClientOptionsAccessEnum = "READ_ONLY"
)
func GetClientOptionsAccessEnumValues() []ClientOptionsAccessEnum
GetClientOptionsAccessEnumValues Enumerates the set of values for ClientOptionsAccessEnum
func GetMappingClientOptionsAccessEnum(val string) (ClientOptionsAccessEnum, bool)
GetMappingClientOptionsAccessEnum performs case Insensitive comparison on enum value and return the desired enum
ClientOptionsAllowedAuthEnum Enum with underlying type: string
type ClientOptionsAllowedAuthEnum string
Set of constants representing the allowable values for ClientOptionsAllowedAuthEnum
const (
ClientOptionsAllowedAuthSys ClientOptionsAllowedAuthEnum = "SYS"
ClientOptionsAllowedAuthKrb5 ClientOptionsAllowedAuthEnum = "KRB5"
ClientOptionsAllowedAuthKrb5i ClientOptionsAllowedAuthEnum = "KRB5I"
ClientOptionsAllowedAuthKrb5p ClientOptionsAllowedAuthEnum = "KRB5P"
)
func GetClientOptionsAllowedAuthEnumValues() []ClientOptionsAllowedAuthEnum
GetClientOptionsAllowedAuthEnumValues Enumerates the set of values for ClientOptionsAllowedAuthEnum
func GetMappingClientOptionsAllowedAuthEnum(val string) (ClientOptionsAllowedAuthEnum, bool)
GetMappingClientOptionsAllowedAuthEnum performs case Insensitive comparison on enum value and return the desired enum
ClientOptionsIdentitySquashEnum Enum with underlying type: string
type ClientOptionsIdentitySquashEnum string
Set of constants representing the allowable values for ClientOptionsIdentitySquashEnum
const (
ClientOptionsIdentitySquashNone ClientOptionsIdentitySquashEnum = "NONE"
ClientOptionsIdentitySquashRoot ClientOptionsIdentitySquashEnum = "ROOT"
ClientOptionsIdentitySquashAll ClientOptionsIdentitySquashEnum = "ALL"
)
func GetClientOptionsIdentitySquashEnumValues() []ClientOptionsIdentitySquashEnum
GetClientOptionsIdentitySquashEnumValues Enumerates the set of values for ClientOptionsIdentitySquashEnum
func GetMappingClientOptionsIdentitySquashEnum(val string) (ClientOptionsIdentitySquashEnum, bool)
GetMappingClientOptionsIdentitySquashEnum performs case Insensitive comparison on enum value and return the desired enum
CreateExportDetails Details for creating the export.
type CreateExportDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export's export set.
ExportSetId *string `mandatory:"true" json:"exportSetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export's file system.
FileSystemId *string `mandatory:"true" json:"fileSystemId"`
// Path used to access the associated file system.
// Avoid entering confidential information.
// Example: `/mediafiles`
Path *string `mandatory:"true" json:"path"`
// Export options for the new export. For exports of mount targets with
// IPv4 address, if client options are left unspecified, client options
// would default to:
// [
// {
// "source" : "0.0.0.0/0",
// "requirePrivilegedSourcePort" : false,
// "access": "READ_WRITE",
// "identitySquash": "NONE",
// "anonymousUid": 65534,
// "anonymousGid": 65534,
// "isAnonymousAccessAllowed": false,
// "allowedAuth": ["SYS"]
// }
// ]
// For exports of mount targets with IPv6 address, if client options are
// left unspecified, client options would be an empty array, i.e. export
// would not be visible to any clients.
// **Note:** Mount targets do not have Internet-routable IP
// addresses. Therefore they will not be reachable from the
// Internet, even if an associated `ClientOptions` item has
// a source of `0.0.0.0/0`.
// **If set to the empty array then the export will not be
// visible to any clients.**
// The export's `exportOptions` can be changed after creation
// using the `UpdateExport` operation.
ExportOptions []ClientOptions `mandatory:"false" json:"exportOptions"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
IsIdmapGroupsForSysAuth *bool `mandatory:"false" json:"isIdmapGroupsForSysAuth"`
}
func (m CreateExportDetails) String() string
func (m CreateExportDetails) 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
CreateExportRequest wrapper for the CreateExport operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateExport.go.html to see an example of how to use CreateExportRequest.
type CreateExportRequest struct {
// Details for creating a new export.
CreateExportDetails `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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 CreateExportRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateExportRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateExportRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateExportRequest) String() string
func (request CreateExportRequest) 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
CreateExportResponse wrapper for the CreateExport operation
type CreateExportResponse struct {
// The underlying http response
RawResponse *http.Response
// The Export instance
Export `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 CreateExportResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateExportResponse) String() string
CreateFileSystemDetails Details for creating the file system.
type CreateFileSystemDetails struct {
// The availability domain to create the file system in.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the file system in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My file system`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
SourceSnapshotId *string `mandatory:"false" json:"sourceSnapshotId"`
// Specifies whether the clone file system is attached to its parent file system.
// If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot
// specified by sourceSnapshotId, else will remain attached to its parent.
CloneAttachStatus CreateFileSystemDetailsCloneAttachStatusEnum `mandatory:"false" json:"cloneAttachStatus,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated file system snapshot policy, which
// controls the frequency of snapshot creation and retention period of the taken snapshots.
// May be unset as a blank value.
FilesystemSnapshotPolicyId *string `mandatory:"false" json:"filesystemSnapshotPolicyId"`
// Specifies the enforcement of quota rules on the file system.
AreQuotaRulesEnabled *bool `mandatory:"false" json:"areQuotaRulesEnabled"`
}
func (m CreateFileSystemDetails) String() string
func (m CreateFileSystemDetails) 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
CreateFileSystemDetailsCloneAttachStatusEnum Enum with underlying type: string
type CreateFileSystemDetailsCloneAttachStatusEnum string
Set of constants representing the allowable values for CreateFileSystemDetailsCloneAttachStatusEnum
const (
CreateFileSystemDetailsCloneAttachStatusDetach CreateFileSystemDetailsCloneAttachStatusEnum = "DETACH"
CreateFileSystemDetailsCloneAttachStatusAttach CreateFileSystemDetailsCloneAttachStatusEnum = "ATTACH"
)
func GetCreateFileSystemDetailsCloneAttachStatusEnumValues() []CreateFileSystemDetailsCloneAttachStatusEnum
GetCreateFileSystemDetailsCloneAttachStatusEnumValues Enumerates the set of values for CreateFileSystemDetailsCloneAttachStatusEnum
func GetMappingCreateFileSystemDetailsCloneAttachStatusEnum(val string) (CreateFileSystemDetailsCloneAttachStatusEnum, bool)
GetMappingCreateFileSystemDetailsCloneAttachStatusEnum performs case Insensitive comparison on enum value and return the desired enum
CreateFileSystemRequest wrapper for the CreateFileSystem operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateFileSystem.go.html to see an example of how to use CreateFileSystemRequest.
type CreateFileSystemRequest struct {
// Details for creating a new file system.
CreateFileSystemDetails `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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 CreateFileSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateFileSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateFileSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateFileSystemRequest) String() string
func (request CreateFileSystemRequest) 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
CreateFileSystemResponse wrapper for the CreateFileSystem operation
type CreateFileSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// The FileSystem instance
FileSystem `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 CreateFileSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateFileSystemResponse) String() string
CreateFilesystemSnapshotPolicyDetails Details for creating the file system snapshot policy.
type CreateFilesystemSnapshotPolicyDetails struct {
// The availability domain that the file system snapshot policy is in.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `policy1`
DisplayName *string `mandatory:"false" json:"displayName"`
// The prefix to apply to all snapshots created by this policy.
// Example: `acme`
PolicyPrefix *string `mandatory:"false" json:"policyPrefix"`
// The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
// If using the CLI, provide the schedule as a list of JSON strings, with the list wrapped in
// quotation marks, i.e.
// ```
// --schedules '[{"timeZone":"UTC","period":"DAILY","hourOfDay":18},{"timeZone":"UTC","period":"HOURLY"}]'
// ```
Schedules []SnapshotSchedule `mandatory:"false" json:"schedules"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m CreateFilesystemSnapshotPolicyDetails) String() string
func (m CreateFilesystemSnapshotPolicyDetails) 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
CreateFilesystemSnapshotPolicyRequest wrapper for the CreateFilesystemSnapshotPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateFilesystemSnapshotPolicy.go.html to see an example of how to use CreateFilesystemSnapshotPolicyRequest.
type CreateFilesystemSnapshotPolicyRequest struct {
// Details for creating a new file system snapshot policy.
CreateFilesystemSnapshotPolicyDetails `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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 CreateFilesystemSnapshotPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateFilesystemSnapshotPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateFilesystemSnapshotPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateFilesystemSnapshotPolicyRequest) String() string
func (request CreateFilesystemSnapshotPolicyRequest) 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
CreateFilesystemSnapshotPolicyResponse wrapper for the CreateFilesystemSnapshotPolicy operation
type CreateFilesystemSnapshotPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The FilesystemSnapshotPolicy instance
FilesystemSnapshotPolicy `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 CreateFilesystemSnapshotPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateFilesystemSnapshotPolicyResponse) String() string
CreateKerberosDetails Kerberos details needed to create configuration.
type CreateKerberosDetails struct {
// The Kerberos realm that the mount target will join.
KerberosRealm *string `mandatory:"true" json:"kerberosRealm"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the keytab Secret in the Vault.
KeyTabSecretId *string `mandatory:"false" json:"keyTabSecretId"`
// Version of the keytab Secret in the Vault to use.
CurrentKeyTabSecretVersion *int `mandatory:"false" json:"currentKeyTabSecretVersion"`
// Version of the keytab Secret in the Vault to use as a backup.
BackupKeyTabSecretVersion *int `mandatory:"false" json:"backupKeyTabSecretVersion"`
// Specifies whether to enable or disable Kerberos.
IsKerberosEnabled *bool `mandatory:"false" json:"isKerberosEnabled"`
}
func (m CreateKerberosDetails) String() string
func (m CreateKerberosDetails) 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
CreateLdapBindAccountDetails Account details for the LDAP bind account to be used by mount targets that use this outbound connector.
type CreateLdapBindAccountDetails struct {
// The availability domain the outbound connector is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Array of server endpoints to use when connecting with the LDAP bind account.
Endpoints []Endpoint `mandatory:"true" json:"endpoints"`
// The LDAP Distinguished Name of the bind account.
BindDistinguishedName *string `mandatory:"true" json:"bindDistinguishedName"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My outbound connector`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the password for the LDAP bind account in the Vault.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Version of the password secret in the Vault to use.
PasswordSecretVersion *int `mandatory:"false" json:"passwordSecretVersion"`
}
func (m CreateLdapBindAccountDetails) GetAvailabilityDomain() *string
GetAvailabilityDomain returns AvailabilityDomain
func (m CreateLdapBindAccountDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateLdapBindAccountDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateLdapBindAccountDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateLdapBindAccountDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateLdapBindAccountDetails) GetLocks() []ResourceLock
GetLocks returns Locks
func (m CreateLdapBindAccountDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateLdapBindAccountDetails) String() string
func (m CreateLdapBindAccountDetails) 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
CreateLdapIdmapDetails Mount target details about the LDAP ID mapping configuration.
type CreateLdapIdmapDetails struct {
// Schema type of the LDAP account.
SchemaType CreateLdapIdmapDetailsSchemaTypeEnum `mandatory:"false" json:"schemaType,omitempty"`
// The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry.
CacheRefreshIntervalSeconds *int `mandatory:"false" json:"cacheRefreshIntervalSeconds"`
// The maximum amount of time the mount target is allowed to use a cached entry.
CacheLifetimeSeconds *int `mandatory:"false" json:"cacheLifetimeSeconds"`
// The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration.
NegativeCacheLifetimeSeconds *int `mandatory:"false" json:"negativeCacheLifetimeSeconds"`
// All LDAP searches are recursive starting at this user.
// Example: `CN=User,DC=domain,DC=com`
UserSearchBase *string `mandatory:"false" json:"userSearchBase"`
// All LDAP searches are recursive starting at this group.
// Example: `CN=Group,DC=domain,DC=com`
GroupSearchBase *string `mandatory:"false" json:"groupSearchBase"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first connector to use to communicate with the LDAP server.
OutboundConnector1Id *string `mandatory:"false" json:"outboundConnector1Id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second connector to use to communicate with the LDAP server.
OutboundConnector2Id *string `mandatory:"false" json:"outboundConnector2Id"`
}
func (m CreateLdapIdmapDetails) String() string
func (m CreateLdapIdmapDetails) 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
CreateLdapIdmapDetailsSchemaTypeEnum Enum with underlying type: string
type CreateLdapIdmapDetailsSchemaTypeEnum string
Set of constants representing the allowable values for CreateLdapIdmapDetailsSchemaTypeEnum
const (
CreateLdapIdmapDetailsSchemaTypeRfc2307 CreateLdapIdmapDetailsSchemaTypeEnum = "RFC2307"
)
func GetCreateLdapIdmapDetailsSchemaTypeEnumValues() []CreateLdapIdmapDetailsSchemaTypeEnum
GetCreateLdapIdmapDetailsSchemaTypeEnumValues Enumerates the set of values for CreateLdapIdmapDetailsSchemaTypeEnum
func GetMappingCreateLdapIdmapDetailsSchemaTypeEnum(val string) (CreateLdapIdmapDetailsSchemaTypeEnum, bool)
GetMappingCreateLdapIdmapDetailsSchemaTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateMountTargetDetails Details for creating the mount target.
type CreateMountTargetDetails struct {
// The availability domain in which to create the mount target.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to create the mount target.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in which to create the mount target.
SubnetId *string `mandatory:"true" json:"subnetId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My mount target`
DisplayName *string `mandatory:"false" json:"displayName"`
// The hostname for the mount target's IP address, used for
// DNS resolution. The value is the hostname portion of the private IP
// address's fully qualified domain name (FQDN). For example,
// `files-1` in the FQDN `files-1.subnet123.vcn1.oraclevcn.com`.
// Must be unique across all VNICs in the subnet and comply
// with RFC 952 (https://tools.ietf.org/html/rfc952)
// and RFC 1123 (https://tools.ietf.org/html/rfc1123).
// Note: This attribute value is stored in the PrivateIp (https://docs.oracle.com/iaas/en-us/iaas/api/#/en/iaas/20160918/PrivateIp/) resource,
// not in the `mountTarget` resource.
// To update the `hostnameLabel`, use `GetMountTarget` to obtain the
// OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target's
// private IPs (`privateIpIds`). Then, you can use
// UpdatePrivateIp (https://docs.oracle.com/iaas/en-us/iaas/api/#/en/iaas/20160918/PrivateIp/UpdatePrivateIp)
// to update the `hostnameLabel` value.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `files-1`
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// A private IP address of your choice. Must be an available IP address within
// the subnet's CIDR. If you don't specify a value, Oracle automatically
// assigns a private IP address from the subnet.
// Example: `10.0.3.3`
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The method used to map a Unix UID to secondary groups, if any.
IdmapType MountTargetIdmapTypeEnum `mandatory:"false" json:"idmapType,omitempty"`
LdapIdmap *CreateLdapIdmapDetails `mandatory:"false" json:"ldapIdmap"`
// A list of Network Security Group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this mount target.
// A maximum of 5 is allowed.
// Setting this to an empty array after the list is created removes the mount target from all NSGs.
// For more information about NSGs, see Security Rules (https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm).
NsgIds []string `mandatory:"false" json:"nsgIds"`
Kerberos *CreateKerberosDetails `mandatory:"false" json:"kerberos"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Throughput for mount target in Gbps. Currently only 1 Gbps of requestedThroughput is supported during create MountTarget.
// Available shapes and corresponding throughput are listed at Mount Target Performance (https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
RequestedThroughput *int64 `mandatory:"false" json:"requestedThroughput"`
}
func (m CreateMountTargetDetails) String() string
func (m CreateMountTargetDetails) 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
CreateMountTargetRequest wrapper for the CreateMountTarget operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateMountTarget.go.html to see an example of how to use CreateMountTargetRequest.
type CreateMountTargetRequest struct {
// Details for creating a new mount target.
CreateMountTargetDetails `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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 CreateMountTargetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateMountTargetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateMountTargetRequest) String() string
func (request CreateMountTargetRequest) 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
CreateMountTargetResponse wrapper for the CreateMountTarget operation
type CreateMountTargetResponse struct {
// The underlying http response
RawResponse *http.Response
// The MountTarget instance
MountTarget `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 CreateMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateMountTargetResponse) String() string
CreateOutboundConnectorDetails Details for creating the outbound connector.
type CreateOutboundConnectorDetails interface {
// The availability domain the outbound connector is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
GetAvailabilityDomain() *string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector.
GetCompartmentId() *string
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My outbound connector`
GetDisplayName() *string
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
GetDefinedTags() map[string]map[string]interface{}
// Locks associated with this resource.
GetLocks() []ResourceLock
}
CreateOutboundConnectorRequest wrapper for the CreateOutboundConnector operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateOutboundConnector.go.html to see an example of how to use CreateOutboundConnectorRequest.
type CreateOutboundConnectorRequest struct {
// Details for creating a new outbound connector.
CreateOutboundConnectorDetails `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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 CreateOutboundConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOutboundConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOutboundConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOutboundConnectorRequest) String() string
func (request CreateOutboundConnectorRequest) 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
CreateOutboundConnectorResponse wrapper for the CreateOutboundConnector operation
type CreateOutboundConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// The OutboundConnector instance
OutboundConnector `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 CreateOutboundConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOutboundConnectorResponse) String() string
CreateQuotaRuleDetails Details for creating a quota rule in the file system.
type CreateQuotaRuleDetails struct {
// The type of the owner of this quota rule and usage.
PrincipalType CreateQuotaRuleDetailsPrincipalTypeEnum `mandatory:"true" json:"principalType"`
// Whether the quota rule will be enforced.
// If `isHardQuota` is true, the quota rule is enforced so that the write is blocked if usage
// exceeds the hard quota limit.
// If `isHardQuota` is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated.
IsHardQuota *bool `mandatory:"true" json:"isHardQuota"`
// The value of the quota rule in gigabytes.
QuotaLimitInGigabytes *int `mandatory:"true" json:"quotaLimitInGigabytes"`
// An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to
// identify a user or group to manage access control.
PrincipalId *int `mandatory:"false" json:"principalId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `UserXYZ's quota`
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m CreateQuotaRuleDetails) String() string
func (m CreateQuotaRuleDetails) 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
CreateQuotaRuleDetailsPrincipalTypeEnum Enum with underlying type: string
type CreateQuotaRuleDetailsPrincipalTypeEnum string
Set of constants representing the allowable values for CreateQuotaRuleDetailsPrincipalTypeEnum
const (
CreateQuotaRuleDetailsPrincipalTypeFileSystemLevel CreateQuotaRuleDetailsPrincipalTypeEnum = "FILE_SYSTEM_LEVEL"
CreateQuotaRuleDetailsPrincipalTypeDefaultGroup CreateQuotaRuleDetailsPrincipalTypeEnum = "DEFAULT_GROUP"
CreateQuotaRuleDetailsPrincipalTypeDefaultUser CreateQuotaRuleDetailsPrincipalTypeEnum = "DEFAULT_USER"
CreateQuotaRuleDetailsPrincipalTypeIndividualGroup CreateQuotaRuleDetailsPrincipalTypeEnum = "INDIVIDUAL_GROUP"
CreateQuotaRuleDetailsPrincipalTypeIndividualUser CreateQuotaRuleDetailsPrincipalTypeEnum = "INDIVIDUAL_USER"
)
func GetCreateQuotaRuleDetailsPrincipalTypeEnumValues() []CreateQuotaRuleDetailsPrincipalTypeEnum
GetCreateQuotaRuleDetailsPrincipalTypeEnumValues Enumerates the set of values for CreateQuotaRuleDetailsPrincipalTypeEnum
func GetMappingCreateQuotaRuleDetailsPrincipalTypeEnum(val string) (CreateQuotaRuleDetailsPrincipalTypeEnum, bool)
GetMappingCreateQuotaRuleDetailsPrincipalTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateQuotaRuleRequest wrapper for the CreateQuotaRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateQuotaRule.go.html to see an example of how to use CreateQuotaRuleRequest.
type CreateQuotaRuleRequest struct {
// Details for adding a new quota rule.
CreateQuotaRuleDetails `contributesTo:"body"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 CreateQuotaRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateQuotaRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateQuotaRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateQuotaRuleRequest) String() string
func (request CreateQuotaRuleRequest) 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
CreateQuotaRuleResponse wrapper for the CreateQuotaRule operation
type CreateQuotaRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The QuotaRule instance
QuotaRule `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 CreateQuotaRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateQuotaRuleResponse) String() string
CreateReplicationDetails Details for creating the replication and replication target.
type CreateReplicationDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source file system.
SourceId *string `mandatory:"true" json:"sourceId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target file system.
TargetId *string `mandatory:"true" json:"targetId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// An associated replication target will also created with the same `displayName`.
// Example: `My replication`
DisplayName *string `mandatory:"false" json:"displayName"`
// Duration in minutes between replication snapshots.
ReplicationInterval *int64 `mandatory:"false" json:"replicationInterval"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m CreateReplicationDetails) String() string
func (m CreateReplicationDetails) 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
CreateReplicationRequest wrapper for the CreateReplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateReplication.go.html to see an example of how to use CreateReplicationRequest.
type CreateReplicationRequest struct {
// Details for creating a new replication.
CreateReplicationDetails `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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 CreateReplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateReplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateReplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateReplicationRequest) String() string
func (request CreateReplicationRequest) 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
CreateReplicationResponse wrapper for the CreateReplication operation
type CreateReplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Replication instance
Replication `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 CreateReplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateReplicationResponse) String() string
CreateSnapshotDetails Details for creating the snapshot.
type CreateSnapshotDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system to take a snapshot of.
FileSystemId *string `mandatory:"true" json:"fileSystemId"`
// Name of the snapshot. This value is immutable. It must also be unique with respect
// to all other non-DELETED snapshots on the associated file
// system.
// Avoid entering confidential information.
// Example: `Sunday`
Name *string `mandatory:"true" json:"name"`
// The time when this snapshot will be deleted.
ExpirationTime *common.SDKTime `mandatory:"false" json:"expirationTime"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m CreateSnapshotDetails) String() string
func (m CreateSnapshotDetails) 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
CreateSnapshotRequest wrapper for the CreateSnapshot operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateSnapshot.go.html to see an example of how to use CreateSnapshotRequest.
type CreateSnapshotRequest struct {
// Details for creating a new snapshot.
CreateSnapshotDetails `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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 CreateSnapshotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSnapshotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSnapshotRequest) String() string
func (request CreateSnapshotRequest) 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
CreateSnapshotResponse wrapper for the CreateSnapshot operation
type CreateSnapshotResponse struct {
// The underlying http response
RawResponse *http.Response
// The Snapshot instance
Snapshot `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 CreateSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSnapshotResponse) String() string
DeleteExportRequest wrapper for the DeleteExport operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteExport.go.html to see an example of how to use DeleteExportRequest.
type DeleteExportRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export.
ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 DeleteExportRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteExportRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteExportRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteExportRequest) String() string
func (request DeleteExportRequest) 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
DeleteExportResponse wrapper for the DeleteExport operation
type DeleteExportResponse 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 DeleteExportResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteExportResponse) String() string
DeleteFileSystemRequest wrapper for the DeleteFileSystem operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteFileSystem.go.html to see an example of how to use DeleteFileSystemRequest.
type DeleteFileSystemRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// If the value is set to true, then the file system will be deleted by detaching its child file system, turning
// the child file system into an independent File System.
CanDetachChildFileSystem *bool `mandatory:"false" contributesTo:"query" name:"canDetachChildFileSystem"`
// 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 DeleteFileSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteFileSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteFileSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteFileSystemRequest) String() string
func (request DeleteFileSystemRequest) 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
DeleteFileSystemResponse wrapper for the DeleteFileSystem operation
type DeleteFileSystemResponse 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 DeleteFileSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteFileSystemResponse) String() string
DeleteFilesystemSnapshotPolicyRequest wrapper for the DeleteFilesystemSnapshotPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteFilesystemSnapshotPolicy.go.html to see an example of how to use DeleteFilesystemSnapshotPolicyRequest.
type DeleteFilesystemSnapshotPolicyRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
FilesystemSnapshotPolicyId *string `mandatory:"true" contributesTo:"path" name:"filesystemSnapshotPolicyId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 DeleteFilesystemSnapshotPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteFilesystemSnapshotPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteFilesystemSnapshotPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteFilesystemSnapshotPolicyRequest) String() string
func (request DeleteFilesystemSnapshotPolicyRequest) 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
DeleteFilesystemSnapshotPolicyResponse wrapper for the DeleteFilesystemSnapshotPolicy operation
type DeleteFilesystemSnapshotPolicyResponse 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 DeleteFilesystemSnapshotPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteFilesystemSnapshotPolicyResponse) String() string
DeleteMountTargetRequest wrapper for the DeleteMountTarget operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteMountTarget.go.html to see an example of how to use DeleteMountTargetRequest.
type DeleteMountTargetRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 DeleteMountTargetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteMountTargetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteMountTargetRequest) String() string
func (request DeleteMountTargetRequest) 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
DeleteMountTargetResponse wrapper for the DeleteMountTarget operation
type DeleteMountTargetResponse 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 DeleteMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteMountTargetResponse) String() string
DeleteOutboundConnectorRequest wrapper for the DeleteOutboundConnector operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteOutboundConnector.go.html to see an example of how to use DeleteOutboundConnectorRequest.
type DeleteOutboundConnectorRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector.
OutboundConnectorId *string `mandatory:"true" contributesTo:"path" name:"outboundConnectorId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 DeleteOutboundConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOutboundConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOutboundConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOutboundConnectorRequest) String() string
func (request DeleteOutboundConnectorRequest) 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
DeleteOutboundConnectorResponse wrapper for the DeleteOutboundConnector operation
type DeleteOutboundConnectorResponse 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 DeleteOutboundConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOutboundConnectorResponse) String() string
DeleteQuotaRuleRequest wrapper for the DeleteQuotaRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteQuotaRule.go.html to see an example of how to use DeleteQuotaRuleRequest.
type DeleteQuotaRuleRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
QuotaRuleId *string `mandatory:"true" contributesTo:"path" name:"quotaRuleId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 DeleteQuotaRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteQuotaRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteQuotaRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteQuotaRuleRequest) String() string
func (request DeleteQuotaRuleRequest) 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
DeleteQuotaRuleResponse wrapper for the DeleteQuotaRule operation
type DeleteQuotaRuleResponse 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 DeleteQuotaRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteQuotaRuleResponse) String() string
DeleteReplicationDeleteModeEnum Enum with underlying type: string
type DeleteReplicationDeleteModeEnum string
Set of constants representing the allowable values for DeleteReplicationDeleteModeEnum
const (
DeleteReplicationDeleteModeFinishCycleIfCapturingOrApplying DeleteReplicationDeleteModeEnum = "FINISH_CYCLE_IF_CAPTURING_OR_APPLYING"
DeleteReplicationDeleteModeOneMoreCycle DeleteReplicationDeleteModeEnum = "ONE_MORE_CYCLE"
DeleteReplicationDeleteModeFinishCycleIfApplying DeleteReplicationDeleteModeEnum = "FINISH_CYCLE_IF_APPLYING"
)
func GetDeleteReplicationDeleteModeEnumValues() []DeleteReplicationDeleteModeEnum
GetDeleteReplicationDeleteModeEnumValues Enumerates the set of values for DeleteReplicationDeleteModeEnum
func GetMappingDeleteReplicationDeleteModeEnum(val string) (DeleteReplicationDeleteModeEnum, bool)
GetMappingDeleteReplicationDeleteModeEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteReplicationRequest wrapper for the DeleteReplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteReplication.go.html to see an example of how to use DeleteReplicationRequest.
type DeleteReplicationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication.
ReplicationId *string `mandatory:"true" contributesTo:"path" name:"replicationId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// You can choose a mode for deleting the replication resource.
// - `FINISH_CYCLE_IF_CAPTURING_OR_APPLYING` Before deleting, complete the current delta cycle. If cycle is idle, delete immediately. Safest option.
// - `ONE_MORE_CYCLE` Before deleting, complete the current delta cycle, and initiate one more cycle. If cycle is idle, initiate one more cycle. Use for lossless failover.
// - `FINISH_CYCLE_IF_APPLYING` Before deleting, finish applying. If cycle is idle or capturing, delete immediately. Fastest option.
DeleteMode DeleteReplicationDeleteModeEnum `mandatory:"false" contributesTo:"query" name:"deleteMode" omitEmpty:"true"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 DeleteReplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteReplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteReplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteReplicationRequest) String() string
func (request DeleteReplicationRequest) 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
DeleteReplicationResponse wrapper for the DeleteReplication operation
type DeleteReplicationResponse 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 DeleteReplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteReplicationResponse) String() string
DeleteReplicationTargetRequest wrapper for the DeleteReplicationTarget operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteReplicationTarget.go.html to see an example of how to use DeleteReplicationTargetRequest.
type DeleteReplicationTargetRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication target.
ReplicationTargetId *string `mandatory:"true" contributesTo:"path" name:"replicationTargetId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 DeleteReplicationTargetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteReplicationTargetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteReplicationTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteReplicationTargetRequest) String() string
func (request DeleteReplicationTargetRequest) 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
DeleteReplicationTargetResponse wrapper for the DeleteReplicationTarget operation
type DeleteReplicationTargetResponse 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 DeleteReplicationTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteReplicationTargetResponse) String() string
DeleteSnapshotRequest wrapper for the DeleteSnapshot operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteSnapshot.go.html to see an example of how to use DeleteSnapshotRequest.
type DeleteSnapshotRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot.
SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 DeleteSnapshotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSnapshotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSnapshotRequest) String() string
func (request DeleteSnapshotRequest) 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
DeleteSnapshotResponse wrapper for the DeleteSnapshot operation
type DeleteSnapshotResponse 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 DeleteSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSnapshotResponse) String() string
DetachCloneRequest wrapper for the DetachClone operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DetachClone.go.html to see an example of how to use DetachCloneRequest.
type DetachCloneRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 DetachCloneRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DetachCloneRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DetachCloneRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DetachCloneRequest) String() string
func (request DetachCloneRequest) 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
DetachCloneResponse wrapper for the DetachClone operation
type DetachCloneResponse 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 DetachCloneResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DetachCloneResponse) String() string
Endpoint Combination of DNS server name and port.
type Endpoint struct {
// Name of the DNS server.
Hostname *string `mandatory:"true" json:"hostname"`
// Port of the DNS server.
Port *int64 `mandatory:"true" json:"port"`
}
func (m Endpoint) String() string
func (m Endpoint) 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
EstimateReplicationRequest wrapper for the EstimateReplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/EstimateReplication.go.html to see an example of how to use EstimateReplicationRequest.
type EstimateReplicationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The rate of change of data on source file system in MegaBytes per second.
ChangeRateInMBps *int `mandatory:"false" contributesTo:"query" name:"changeRateInMBps"`
// 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 EstimateReplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request EstimateReplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request EstimateReplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request EstimateReplicationRequest) String() string
func (request EstimateReplicationRequest) 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
EstimateReplicationResponse wrapper for the EstimateReplication operation
type EstimateReplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// The ReplicationEstimate instance
ReplicationEstimate `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 EstimateReplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response EstimateReplicationResponse) String() string
Export A file system and the path that you can use to mount it. Each export resource belongs to exactly one export set. The export's path attribute is not a path in the referenced file system, but the value used by clients for the path component of the remotetarget argument when mounting the file system. The path must start with a slash (/) followed by a sequence of zero or more slash-separated path elements. For any two export resources associated with the same export set, except those in a 'DELETED' state, the path element sequence for the first export resource can't contain the complete path element sequence of the second export resource.
For example, the following are acceptable:
The following examples are not acceptable:
Paths may not end in a slash (/). No path element can be a period (.) or two periods in sequence (..). All path elements must be 255 bytes or less. No two non-'DELETED' export resources in the same export set can reference the same file system. Use `exportOptions` to control access to an export. For more information, see Export Options (https://docs.oracle.com/iaas/Content/File/Tasks/exportoptions.htm).
type Export struct {
// Policies that apply to NFS requests made through this
// export. `exportOptions` contains a sequential list of
// `ClientOptions`. Each `ClientOptions` item defines the
// export options that are applied to a specified
// set of clients.
// For each NFS request, the first `ClientOptions` option
// in the list whose `source` attribute matches the source
// IP address of the request is applied.
// If a client source IP address does not match the `source`
// property of any `ClientOptions` in the list, then the
// export will be invisible to that client. This export will
// not be returned by `MOUNTPROC_EXPORT` calls made by the client
// and any attempt to mount or access the file system through
// this export will result in an error.
// **Exports without defined `ClientOptions` are invisible to all clients.**
// If one export is invisible to a particular client, associated file
// systems may still be accessible through other exports on the same
// or different mount targets.
// To completely deny client access to a file system, be sure that the client
// source IP address is not included in any export for any mount target
// associated with the file system.
ExportOptions []ClientOptions `mandatory:"true" json:"exportOptions"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export's export set.
ExportSetId *string `mandatory:"true" json:"exportSetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export's file system.
FileSystemId *string `mandatory:"true" json:"fileSystemId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export.
Id *string `mandatory:"true" json:"id"`
// The current state of this export.
LifecycleState ExportLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Path used to access the associated file system.
// Avoid entering confidential information.
// Example: `/accounting`
Path *string `mandatory:"true" json:"path"`
// The date and time the export was created, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
IsIdmapGroupsForSysAuth *bool `mandatory:"false" json:"isIdmapGroupsForSysAuth"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m Export) String() string
func (m Export) 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
ExportLifecycleStateEnum Enum with underlying type: string
type ExportLifecycleStateEnum string
Set of constants representing the allowable values for ExportLifecycleStateEnum
const (
ExportLifecycleStateCreating ExportLifecycleStateEnum = "CREATING"
ExportLifecycleStateActive ExportLifecycleStateEnum = "ACTIVE"
ExportLifecycleStateDeleting ExportLifecycleStateEnum = "DELETING"
ExportLifecycleStateDeleted ExportLifecycleStateEnum = "DELETED"
)
func GetExportLifecycleStateEnumValues() []ExportLifecycleStateEnum
GetExportLifecycleStateEnumValues Enumerates the set of values for ExportLifecycleStateEnum
func GetMappingExportLifecycleStateEnum(val string) (ExportLifecycleStateEnum, bool)
GetMappingExportLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ExportSet A set of file systems to export through one or more mount targets. Composed of zero or more export resources.
type ExportSet struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the export set.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My export set`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export set.
Id *string `mandatory:"true" json:"id"`
// The current state of the export set.
LifecycleState ExportSetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the export set was created, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual cloud network (VCN) the export set is in.
VcnId *string `mandatory:"true" json:"vcnId"`
// The availability domain the export set is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Controls the maximum `tbytes`, `fbytes`, and `abytes`,
// values reported by `NFS FSSTAT` calls through any associated
// mount targets. This is an advanced feature. For most
// applications, use the default value. The
// `tbytes` value reported by `FSSTAT` will be
// `maxFsStatBytes`. The value of `fbytes` and `abytes` will be
// `maxFsStatBytes` minus the metered size of the file
// system. If the metered size is larger than `maxFsStatBytes`,
// then `fbytes` and `abytes` will both be '0'.
MaxFsStatBytes *int64 `mandatory:"false" json:"maxFsStatBytes"`
// Controls the maximum `tfiles`, `ffiles`, and `afiles`
// values reported by `NFS FSSTAT` calls through any associated
// mount targets. This is an advanced feature. For most
// applications, use the default value. The
// `tfiles` value reported by `FSSTAT` will be
// `maxFsStatFiles`. The value of `ffiles` and `afiles` will be
// `maxFsStatFiles` minus the metered size of the file
// system. If the metered size is larger than `maxFsStatFiles`,
// then `ffiles` and `afiles` will both be '0'.
MaxFsStatFiles *int64 `mandatory:"false" json:"maxFsStatFiles"`
}
func (m ExportSet) String() string
func (m ExportSet) 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
ExportSetLifecycleStateEnum Enum with underlying type: string
type ExportSetLifecycleStateEnum string
Set of constants representing the allowable values for ExportSetLifecycleStateEnum
const (
ExportSetLifecycleStateCreating ExportSetLifecycleStateEnum = "CREATING"
ExportSetLifecycleStateActive ExportSetLifecycleStateEnum = "ACTIVE"
ExportSetLifecycleStateDeleting ExportSetLifecycleStateEnum = "DELETING"
ExportSetLifecycleStateDeleted ExportSetLifecycleStateEnum = "DELETED"
)
func GetExportSetLifecycleStateEnumValues() []ExportSetLifecycleStateEnum
GetExportSetLifecycleStateEnumValues Enumerates the set of values for ExportSetLifecycleStateEnum
func GetMappingExportSetLifecycleStateEnum(val string) (ExportSetLifecycleStateEnum, bool)
GetMappingExportSetLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ExportSetSummary Summary information for an export set.
type ExportSetSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the export set.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My export set`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export set.
Id *string `mandatory:"true" json:"id"`
// The current state of the export set.
LifecycleState ExportSetSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the export set was created, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual cloud network (VCN) the export set is in.
VcnId *string `mandatory:"true" json:"vcnId"`
// The availability domain the export set is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
}
func (m ExportSetSummary) String() string
func (m ExportSetSummary) 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
ExportSetSummaryLifecycleStateEnum Enum with underlying type: string
type ExportSetSummaryLifecycleStateEnum string
Set of constants representing the allowable values for ExportSetSummaryLifecycleStateEnum
const (
ExportSetSummaryLifecycleStateCreating ExportSetSummaryLifecycleStateEnum = "CREATING"
ExportSetSummaryLifecycleStateActive ExportSetSummaryLifecycleStateEnum = "ACTIVE"
ExportSetSummaryLifecycleStateDeleting ExportSetSummaryLifecycleStateEnum = "DELETING"
ExportSetSummaryLifecycleStateDeleted ExportSetSummaryLifecycleStateEnum = "DELETED"
)
func GetExportSetSummaryLifecycleStateEnumValues() []ExportSetSummaryLifecycleStateEnum
GetExportSetSummaryLifecycleStateEnumValues Enumerates the set of values for ExportSetSummaryLifecycleStateEnum
func GetMappingExportSetSummaryLifecycleStateEnum(val string) (ExportSetSummaryLifecycleStateEnum, bool)
GetMappingExportSetSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ExportSummary Summary information for an export.
type ExportSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export's export set.
ExportSetId *string `mandatory:"true" json:"exportSetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export's file system.
FileSystemId *string `mandatory:"true" json:"fileSystemId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export.
Id *string `mandatory:"true" json:"id"`
// The current state of this export.
LifecycleState ExportSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Path used to access the associated file system.
// Avoid entering confidential information.
// Example: `/mediafiles`
Path *string `mandatory:"true" json:"path"`
// The date and time the export was created, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
IsIdmapGroupsForSysAuth *bool `mandatory:"false" json:"isIdmapGroupsForSysAuth"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m ExportSummary) String() string
func (m ExportSummary) 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
ExportSummaryLifecycleStateEnum Enum with underlying type: string
type ExportSummaryLifecycleStateEnum string
Set of constants representing the allowable values for ExportSummaryLifecycleStateEnum
const (
ExportSummaryLifecycleStateCreating ExportSummaryLifecycleStateEnum = "CREATING"
ExportSummaryLifecycleStateActive ExportSummaryLifecycleStateEnum = "ACTIVE"
ExportSummaryLifecycleStateDeleting ExportSummaryLifecycleStateEnum = "DELETING"
ExportSummaryLifecycleStateDeleted ExportSummaryLifecycleStateEnum = "DELETED"
)
func GetExportSummaryLifecycleStateEnumValues() []ExportSummaryLifecycleStateEnum
GetExportSummaryLifecycleStateEnumValues Enumerates the set of values for ExportSummaryLifecycleStateEnum
func GetMappingExportSummaryLifecycleStateEnum(val string) (ExportSummaryLifecycleStateEnum, bool)
GetMappingExportSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
FileStorageClient a client for FileStorage
type FileStorageClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewFileStorageClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client FileStorageClient, err error)
NewFileStorageClientWithConfigurationProvider Creates a new default FileStorage client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewFileStorageClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client FileStorageClient, err error)
NewFileStorageClientWithOboToken Creates a new default FileStorage 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 FileStorageClient) AddExportLock(ctx context.Context, request AddExportLockRequest) (response AddExportLockResponse, err error)
AddExportLock Adds a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddExportLock.go.html to see an example of how to use AddExportLock API.
func (client FileStorageClient) AddFileSystemLock(ctx context.Context, request AddFileSystemLockRequest) (response AddFileSystemLockResponse, err error)
AddFileSystemLock Adds a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddFileSystemLock.go.html to see an example of how to use AddFileSystemLock API.
func (client FileStorageClient) AddFilesystemSnapshotPolicyLock(ctx context.Context, request AddFilesystemSnapshotPolicyLockRequest) (response AddFilesystemSnapshotPolicyLockResponse, err error)
AddFilesystemSnapshotPolicyLock Adds a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddFilesystemSnapshotPolicyLock.go.html to see an example of how to use AddFilesystemSnapshotPolicyLock API.
func (client FileStorageClient) AddMountTargetLock(ctx context.Context, request AddMountTargetLockRequest) (response AddMountTargetLockResponse, err error)
AddMountTargetLock Adds a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddMountTargetLock.go.html to see an example of how to use AddMountTargetLock API.
func (client FileStorageClient) AddOutboundConnectorLock(ctx context.Context, request AddOutboundConnectorLockRequest) (response AddOutboundConnectorLockResponse, err error)
AddOutboundConnectorLock Adds a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddOutboundConnectorLock.go.html to see an example of how to use AddOutboundConnectorLock API.
func (client FileStorageClient) AddReplicationLock(ctx context.Context, request AddReplicationLockRequest) (response AddReplicationLockResponse, err error)
AddReplicationLock Adds a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddReplicationLock.go.html to see an example of how to use AddReplicationLock API.
func (client FileStorageClient) AddSnapshotLock(ctx context.Context, request AddSnapshotLockRequest) (response AddSnapshotLockResponse, err error)
AddSnapshotLock Adds a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/AddSnapshotLock.go.html to see an example of how to use AddSnapshotLock API.
func (client FileStorageClient) CancelDowngradeShapeMountTarget(ctx context.Context, request CancelDowngradeShapeMountTargetRequest) (response CancelDowngradeShapeMountTargetResponse, err error)
CancelDowngradeShapeMountTarget Cancel scheduled downgrade shape request for mount target.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CancelDowngradeShapeMountTarget.go.html to see an example of how to use CancelDowngradeShapeMountTarget API.
func (client FileStorageClient) ChangeFileSystemCompartment(ctx context.Context, request ChangeFileSystemCompartmentRequest) (response ChangeFileSystemCompartmentResponse, err error)
ChangeFileSystemCompartment Moves a file system and its associated snapshots into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ChangeFileSystemCompartment.go.html to see an example of how to use ChangeFileSystemCompartment API.
func (client FileStorageClient) ChangeFilesystemSnapshotPolicyCompartment(ctx context.Context, request ChangeFilesystemSnapshotPolicyCompartmentRequest) (response ChangeFilesystemSnapshotPolicyCompartmentResponse, err error)
ChangeFilesystemSnapshotPolicyCompartment Moves a file system snapshot policy into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ChangeFilesystemSnapshotPolicyCompartment.go.html to see an example of how to use ChangeFilesystemSnapshotPolicyCompartment API.
func (client FileStorageClient) ChangeMountTargetCompartment(ctx context.Context, request ChangeMountTargetCompartmentRequest) (response ChangeMountTargetCompartmentResponse, err error)
ChangeMountTargetCompartment Moves a mount target and its associated export set or share set into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ChangeMountTargetCompartment.go.html to see an example of how to use ChangeMountTargetCompartment API.
func (client FileStorageClient) ChangeOutboundConnectorCompartment(ctx context.Context, request ChangeOutboundConnectorCompartmentRequest) (response ChangeOutboundConnectorCompartmentResponse, err error)
ChangeOutboundConnectorCompartment Moves an outbound connector into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ChangeOutboundConnectorCompartment.go.html to see an example of how to use ChangeOutboundConnectorCompartment API.
func (client FileStorageClient) ChangeReplicationCompartment(ctx context.Context, request ChangeReplicationCompartmentRequest) (response ChangeReplicationCompartmentResponse, err error)
ChangeReplicationCompartment Moves a replication and its replication target into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ChangeReplicationCompartment.go.html to see an example of how to use ChangeReplicationCompartment API.
func (client *FileStorageClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client FileStorageClient) CreateExport(ctx context.Context, request CreateExportRequest) (response CreateExportResponse, err error)
CreateExport Creates a new export in the specified export set, path, and file system.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateExport.go.html to see an example of how to use CreateExport API.
func (client FileStorageClient) CreateFileSystem(ctx context.Context, request CreateFileSystemRequest) (response CreateFileSystemResponse, err error)
CreateFileSystem Creates a new file system in the specified compartment and availability domain. Instances can mount file systems in another availability domain, but doing so might increase latency when compared to mounting instances in the same availability domain. After you create a file system, you can associate it with a mount target. Instances can then mount the file system by connecting to the mount target's IP address. You can associate a file system with more than one mount target at a time. For information about access control and compartments, see Overview of the IAM Service (https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about Network Security Groups access control, see Network Security Groups (https://docs.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm). For information about availability domains, see Regions and Availability Domains (https://docs.oracle.com/iaas/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure resources, including file systems, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type or by viewing the resource in the Console.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateFileSystem.go.html to see an example of how to use CreateFileSystem API.
func (client FileStorageClient) CreateFilesystemSnapshotPolicy(ctx context.Context, request CreateFilesystemSnapshotPolicyRequest) (response CreateFilesystemSnapshotPolicyResponse, err error)
CreateFilesystemSnapshotPolicy Creates a new file system snapshot policy in the specified compartment and availability domain. After you create a file system snapshot policy, you can associate it with file systems.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateFilesystemSnapshotPolicy.go.html to see an example of how to use CreateFilesystemSnapshotPolicy API.
func (client FileStorageClient) CreateMountTarget(ctx context.Context, request CreateMountTargetRequest) (response CreateMountTargetResponse, err error)
CreateMountTarget Creates a new mount target in the specified compartment and subnet. You can associate a file system with a mount target only when they exist in the same availability domain. Instances can connect to mount targets in another availablity domain, but you might see higher latency than with instances in the same availability domain as the mount target. Mount targets have one or more private IP addresses that you can provide as the host portion of remote target parameters in client mount commands. These private IP addresses are listed in the privateIpIds property of the mount target and are highly available. Mount targets also consume additional IP addresses in their subnet. Do not use /30 or smaller subnets for mount target creation because they do not have sufficient available IP addresses. Allow at least three IP addresses for each mount target. For information about access control and compartments, see Overview of the IAM Service (https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about availability domains, see Regions and Availability Domains (https://docs.oracle.com/iaas/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure Services resources, including mount targets, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateMountTarget.go.html to see an example of how to use CreateMountTarget API.
func (client FileStorageClient) CreateOutboundConnector(ctx context.Context, request CreateOutboundConnectorRequest) (response CreateOutboundConnectorResponse, err error)
CreateOutboundConnector Creates a new outbound connector in the specified compartment. You can associate an outbound connector with a mount target only when they exist in the same availability domain. For information about access control and compartments, see Overview of the IAM Service (https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about availability domains, see Regions and Availability Domains (https://docs.oracle.com/iaas/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure Services resources, including outbound connectors, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateOutboundConnector.go.html to see an example of how to use CreateOutboundConnector API.
func (client FileStorageClient) CreateQuotaRule(ctx context.Context, request CreateQuotaRuleRequest) (response CreateQuotaRuleResponse, err error)
CreateQuotaRule Create a file system, user, or group quota rule given the `fileSystemId`, `principalId`, `principalType` and `isHardQuota` parameters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateQuotaRule.go.html to see an example of how to use CreateQuotaRule API.
func (client FileStorageClient) CreateReplication(ctx context.Context, request CreateReplicationRequest) (response CreateReplicationResponse, err error)
CreateReplication Creates a new replication in the specified compartment. Replications are the primary resource that governs the policy of cross-region replication between source and target file systems. Replications are associated with a secondary resource called a ReplicationTarget located in another availability domain. The associated replication target resource is automatically created along with the replication resource. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated `ReplicationTarget`, which retrieves the delta and applies it to the target file system. Only unexported file systems can be used as target file systems. For more information, see Using Replication (https://docs.oracle.com/iaas/Content/File/Tasks/FSreplication.htm). For information about access control and compartments, see Overview of the IAM Service (https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about availability domains, see Regions and Availability Domains (https://docs.oracle.com/iaas/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure Services resources, including replications, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateReplication.go.html to see an example of how to use CreateReplication API.
func (client FileStorageClient) CreateSnapshot(ctx context.Context, request CreateSnapshotRequest) (response CreateSnapshotResponse, err error)
CreateSnapshot Creates a new snapshot of the specified file system. You can access the snapshot at `.snapshot/<name>`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/CreateSnapshot.go.html to see an example of how to use CreateSnapshot API.
func (client FileStorageClient) DeleteExport(ctx context.Context, request DeleteExportRequest) (response DeleteExportResponse, err error)
DeleteExport Deletes the specified export.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteExport.go.html to see an example of how to use DeleteExport API.
func (client FileStorageClient) DeleteFileSystem(ctx context.Context, request DeleteFileSystemRequest) (response DeleteFileSystemResponse, err error)
DeleteFileSystem Deletes the specified file system. Before you delete the file system, verify that no remaining export resources still reference it. Deleting a file system also deletes all of its snapshots.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteFileSystem.go.html to see an example of how to use DeleteFileSystem API.
func (client FileStorageClient) DeleteFilesystemSnapshotPolicy(ctx context.Context, request DeleteFilesystemSnapshotPolicyRequest) (response DeleteFilesystemSnapshotPolicyResponse, err error)
DeleteFilesystemSnapshotPolicy Deletes the specified file system snapshot policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteFilesystemSnapshotPolicy.go.html to see an example of how to use DeleteFilesystemSnapshotPolicy API.
func (client FileStorageClient) DeleteMountTarget(ctx context.Context, request DeleteMountTargetRequest) (response DeleteMountTargetResponse, err error)
DeleteMountTarget Deletes the specified mount target. This operation also deletes the mount target's VNICs.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteMountTarget.go.html to see an example of how to use DeleteMountTarget API.
func (client FileStorageClient) DeleteOutboundConnector(ctx context.Context, request DeleteOutboundConnectorRequest) (response DeleteOutboundConnectorResponse, err error)
DeleteOutboundConnector Deletes the specified outbound connector.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteOutboundConnector.go.html to see an example of how to use DeleteOutboundConnector API.
func (client FileStorageClient) DeleteQuotaRule(ctx context.Context, request DeleteQuotaRuleRequest) (response DeleteQuotaRuleResponse, err error)
DeleteQuotaRule Remove a file system, user, or group quota rule given the `fileSystemId` and `quotaRuleId` parameters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteQuotaRule.go.html to see an example of how to use DeleteQuotaRule API.
func (client FileStorageClient) DeleteReplication(ctx context.Context, request DeleteReplicationRequest) (response DeleteReplicationResponse, err error)
DeleteReplication Deletes the specified replication and the the associated replication target.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteReplication.go.html to see an example of how to use DeleteReplication API.
func (client FileStorageClient) DeleteReplicationTarget(ctx context.Context, request DeleteReplicationTargetRequest) (response DeleteReplicationTargetResponse, err error)
DeleteReplicationTarget Deletes the specified replication target. This operation causes the immediate release of the target file system if there are currently no delta application operations. If there is any current delta being applied the delete operation is blocked until the current delta has been completely applied.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteReplicationTarget.go.html to see an example of how to use DeleteReplicationTarget API.
func (client FileStorageClient) DeleteSnapshot(ctx context.Context, request DeleteSnapshotRequest) (response DeleteSnapshotResponse, err error)
DeleteSnapshot Deletes the specified snapshot.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DeleteSnapshot.go.html to see an example of how to use DeleteSnapshot API.
func (client FileStorageClient) DetachClone(ctx context.Context, request DetachCloneRequest) (response DetachCloneResponse, err error)
DetachClone Detaches the file system from its parent file system
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/DetachClone.go.html to see an example of how to use DetachClone API.
func (client FileStorageClient) EstimateReplication(ctx context.Context, request EstimateReplicationRequest) (response EstimateReplicationResponse, err error)
EstimateReplication Provides estimates for replication created using specific file system.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/EstimateReplication.go.html to see an example of how to use EstimateReplication API.
func (client FileStorageClient) GetExport(ctx context.Context, request GetExportRequest) (response GetExportResponse, err error)
GetExport Gets the specified export's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetExport.go.html to see an example of how to use GetExport API.
func (client FileStorageClient) GetExportSet(ctx context.Context, request GetExportSetRequest) (response GetExportSetResponse, err error)
GetExportSet Gets the specified export set's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetExportSet.go.html to see an example of how to use GetExportSet API.
func (client FileStorageClient) GetFileSystem(ctx context.Context, request GetFileSystemRequest) (response GetFileSystemResponse, err error)
GetFileSystem Gets the specified file system's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetFileSystem.go.html to see an example of how to use GetFileSystem API.
func (client FileStorageClient) GetFilesystemSnapshotPolicy(ctx context.Context, request GetFilesystemSnapshotPolicyRequest) (response GetFilesystemSnapshotPolicyResponse, err error)
GetFilesystemSnapshotPolicy Gets the specified file system snapshot policy's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetFilesystemSnapshotPolicy.go.html to see an example of how to use GetFilesystemSnapshotPolicy API.
func (client FileStorageClient) GetMountTarget(ctx context.Context, request GetMountTargetRequest) (response GetMountTargetResponse, err error)
GetMountTarget Gets the specified mount target's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetMountTarget.go.html to see an example of how to use GetMountTarget API.
func (client FileStorageClient) GetOutboundConnector(ctx context.Context, request GetOutboundConnectorRequest) (response GetOutboundConnectorResponse, err error)
GetOutboundConnector Gets the specified outbound connector's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetOutboundConnector.go.html to see an example of how to use GetOutboundConnector API.
func (client FileStorageClient) GetQuotaRule(ctx context.Context, request GetQuotaRuleRequest) (response GetQuotaRuleResponse, err error)
GetQuotaRule Get a file system, user, or group quota rule given the `fileSystemId` and `quotaRuleId` parameters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetQuotaRule.go.html to see an example of how to use GetQuotaRule API.
func (client FileStorageClient) GetReplication(ctx context.Context, request GetReplicationRequest) (response GetReplicationResponse, err error)
GetReplication Gets the specified replication's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetReplication.go.html to see an example of how to use GetReplication API.
func (client FileStorageClient) GetReplicationTarget(ctx context.Context, request GetReplicationTargetRequest) (response GetReplicationTargetResponse, err error)
GetReplicationTarget Gets the specified replication target's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetReplicationTarget.go.html to see an example of how to use GetReplicationTarget API.
func (client FileStorageClient) GetSnapshot(ctx context.Context, request GetSnapshotRequest) (response GetSnapshotResponse, err error)
GetSnapshot Gets the specified snapshot's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetSnapshot.go.html to see an example of how to use GetSnapshot API.
func (client FileStorageClient) ListExportSets(ctx context.Context, request ListExportSetsRequest) (response ListExportSetsResponse, err error)
ListExportSets Lists the export set resources in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListExportSets.go.html to see an example of how to use ListExportSets API.
func (client FileStorageClient) ListExports(ctx context.Context, request ListExportsRequest) (response ListExportsResponse, err error)
ListExports Lists export resources by compartment, file system, or export set. You must specify an export set ID, a file system ID, and / or a compartment ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListExports.go.html to see an example of how to use ListExports API.
func (client FileStorageClient) ListFileSystems(ctx context.Context, request ListFileSystemsRequest) (response ListFileSystemsResponse, err error)
ListFileSystems Lists the file system resources in the specified compartment, or by the specified compartment and file system snapshot policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListFileSystems.go.html to see an example of how to use ListFileSystems API.
func (client FileStorageClient) ListFilesystemSnapshotPolicies(ctx context.Context, request ListFilesystemSnapshotPoliciesRequest) (response ListFilesystemSnapshotPoliciesResponse, err error)
ListFilesystemSnapshotPolicies Lists file system snapshot policies in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListFilesystemSnapshotPolicies.go.html to see an example of how to use ListFilesystemSnapshotPolicies API.
func (client FileStorageClient) ListMountTargets(ctx context.Context, request ListMountTargetsRequest) (response ListMountTargetsResponse, err error)
ListMountTargets Lists the mount target resources in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListMountTargets.go.html to see an example of how to use ListMountTargets API.
func (client FileStorageClient) ListOutboundConnectors(ctx context.Context, request ListOutboundConnectorsRequest) (response ListOutboundConnectorsResponse, err error)
ListOutboundConnectors Lists the outbound connector resources in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListOutboundConnectors.go.html to see an example of how to use ListOutboundConnectors API.
func (client FileStorageClient) ListQuotaRules(ctx context.Context, request ListQuotaRulesRequest) (response ListQuotaRulesResponse, err error)
ListQuotaRules List user or group usages and their quota rules by certain principal type.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListQuotaRules.go.html to see an example of how to use ListQuotaRules API.
func (client FileStorageClient) ListReplicationTargets(ctx context.Context, request ListReplicationTargetsRequest) (response ListReplicationTargetsResponse, err error)
ListReplicationTargets Lists the replication target resources in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListReplicationTargets.go.html to see an example of how to use ListReplicationTargets API.
func (client FileStorageClient) ListReplications(ctx context.Context, request ListReplicationsRequest) (response ListReplicationsResponse, err error)
ListReplications Lists the replication resources in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListReplications.go.html to see an example of how to use ListReplications API.
func (client FileStorageClient) ListSnapshots(ctx context.Context, request ListSnapshotsRequest) (response ListSnapshotsResponse, err error)
ListSnapshots Lists snapshots of the specified file system, or by file system snapshot policy and compartment, or by file system snapshot policy and file system. If file system ID is not specified, a file system snapshot policy ID and compartment ID must be specified. Users can only sort by time created when listing snapshots by file system snapshot policy ID and compartment ID (sort by name is NOT supported for listing snapshots by policy and compartment).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListSnapshots.go.html to see an example of how to use ListSnapshots API.
func (client FileStorageClient) PauseFilesystemSnapshotPolicy(ctx context.Context, request PauseFilesystemSnapshotPolicyRequest) (response PauseFilesystemSnapshotPolicyResponse, err error)
PauseFilesystemSnapshotPolicy This operation pauses the scheduled snapshot creation and snapshot deletion of the policy and updates the lifecycle state of the file system snapshot policy from ACTIVE to INACTIVE. When a file system snapshot policy is paused, file systems that are associated with the policy will not have scheduled snapshots created or deleted. If the policy is already paused, or in the INACTIVE state, you cannot pause it again. You can't pause a policy that is in a DELETING, DELETED, FAILED, CREATING or INACTIVE state; attempts to pause a policy in these states result in a 409 conflict error.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/PauseFilesystemSnapshotPolicy.go.html to see an example of how to use PauseFilesystemSnapshotPolicy API.
func (client FileStorageClient) RemoveExportLock(ctx context.Context, request RemoveExportLockRequest) (response RemoveExportLockResponse, err error)
RemoveExportLock Removes a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveExportLock.go.html to see an example of how to use RemoveExportLock API.
func (client FileStorageClient) RemoveFileSystemLock(ctx context.Context, request RemoveFileSystemLockRequest) (response RemoveFileSystemLockResponse, err error)
RemoveFileSystemLock Removes a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveFileSystemLock.go.html to see an example of how to use RemoveFileSystemLock API.
func (client FileStorageClient) RemoveFilesystemSnapshotPolicyLock(ctx context.Context, request RemoveFilesystemSnapshotPolicyLockRequest) (response RemoveFilesystemSnapshotPolicyLockResponse, err error)
RemoveFilesystemSnapshotPolicyLock Removes a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveFilesystemSnapshotPolicyLock.go.html to see an example of how to use RemoveFilesystemSnapshotPolicyLock API.
func (client FileStorageClient) RemoveMountTargetLock(ctx context.Context, request RemoveMountTargetLockRequest) (response RemoveMountTargetLockResponse, err error)
RemoveMountTargetLock Removes a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveMountTargetLock.go.html to see an example of how to use RemoveMountTargetLock API.
func (client FileStorageClient) RemoveOutboundConnectorLock(ctx context.Context, request RemoveOutboundConnectorLockRequest) (response RemoveOutboundConnectorLockResponse, err error)
RemoveOutboundConnectorLock Removes a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveOutboundConnectorLock.go.html to see an example of how to use RemoveOutboundConnectorLock API.
func (client FileStorageClient) RemoveReplicationLock(ctx context.Context, request RemoveReplicationLockRequest) (response RemoveReplicationLockResponse, err error)
RemoveReplicationLock Removes a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveReplicationLock.go.html to see an example of how to use RemoveReplicationLock API.
func (client FileStorageClient) RemoveSnapshotLock(ctx context.Context, request RemoveSnapshotLockRequest) (response RemoveSnapshotLockResponse, err error)
RemoveSnapshotLock Removes a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveSnapshotLock.go.html to see an example of how to use RemoveSnapshotLock API.
func (client FileStorageClient) ScheduleDowngradeShapeMountTarget(ctx context.Context, request ScheduleDowngradeShapeMountTargetRequest) (response ScheduleDowngradeShapeMountTargetResponse, err error)
ScheduleDowngradeShapeMountTarget Schedule a downgrade shape of the mount target.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ScheduleDowngradeShapeMountTarget.go.html to see an example of how to use ScheduleDowngradeShapeMountTarget API.
func (client *FileStorageClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client FileStorageClient) ToggleQuotaRules(ctx context.Context, request ToggleQuotaRulesRequest) (response ToggleQuotaRulesResponse, err error)
ToggleQuotaRules Enable or disable quota enforcement for the file system. If `areQuotaRulesEnabled` = `true`, then the quota enforcement will be enabled. If `areQuotaRulesEnabled` = `false`, then the quota enforcement will be disabled.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ToggleQuotaRules.go.html to see an example of how to use ToggleQuotaRules API.
func (client FileStorageClient) UnpauseFilesystemSnapshotPolicy(ctx context.Context, request UnpauseFilesystemSnapshotPolicyRequest) (response UnpauseFilesystemSnapshotPolicyResponse, err error)
UnpauseFilesystemSnapshotPolicy This operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from INACTIVE to ACTIVE. By default, file system snapshot policies are in the ACTIVE state. When a file system snapshot policy is not paused, or in the ACTIVE state, file systems that are associated with the policy will have snapshots created and deleted according to the schedules defined in the policy. If the policy is already in the ACTIVE state, you cannot unpause it. You can't unpause a policy that is in a DELETING, DELETED, FAILED, CREATING, or ACTIVE state; attempts to unpause a policy in these states result in a 409 conflict error.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UnpauseFilesystemSnapshotPolicy.go.html to see an example of how to use UnpauseFilesystemSnapshotPolicy API.
func (client FileStorageClient) UpdateExport(ctx context.Context, request UpdateExportRequest) (response UpdateExportResponse, err error)
UpdateExport Updates the specified export's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateExport.go.html to see an example of how to use UpdateExport API.
func (client FileStorageClient) UpdateExportSet(ctx context.Context, request UpdateExportSetRequest) (response UpdateExportSetResponse, err error)
UpdateExportSet Updates the specified export set's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateExportSet.go.html to see an example of how to use UpdateExportSet API.
func (client FileStorageClient) UpdateFileSystem(ctx context.Context, request UpdateFileSystemRequest) (response UpdateFileSystemResponse, err error)
UpdateFileSystem Updates the specified file system's information. You can use this operation to rename a file system.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateFileSystem.go.html to see an example of how to use UpdateFileSystem API.
func (client FileStorageClient) UpdateFilesystemSnapshotPolicy(ctx context.Context, request UpdateFilesystemSnapshotPolicyRequest) (response UpdateFilesystemSnapshotPolicyResponse, err error)
UpdateFilesystemSnapshotPolicy Updates the specified file system snapshot policy's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateFilesystemSnapshotPolicy.go.html to see an example of how to use UpdateFilesystemSnapshotPolicy API.
func (client FileStorageClient) UpdateMountTarget(ctx context.Context, request UpdateMountTargetRequest) (response UpdateMountTargetResponse, err error)
UpdateMountTarget Updates the specified mount target's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateMountTarget.go.html to see an example of how to use UpdateMountTarget API.
func (client FileStorageClient) UpdateOutboundConnector(ctx context.Context, request UpdateOutboundConnectorRequest) (response UpdateOutboundConnectorResponse, err error)
UpdateOutboundConnector Updates the specified outbound connector's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateOutboundConnector.go.html to see an example of how to use UpdateOutboundConnector API.
func (client FileStorageClient) UpdateQuotaRule(ctx context.Context, request UpdateQuotaRuleRequest) (response UpdateQuotaRuleResponse, err error)
UpdateQuotaRule Edit a file system, user, or group quota rule given the `fileSystemId` and `quotaRuleId` parameters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateQuotaRule.go.html to see an example of how to use UpdateQuotaRule API.
func (client FileStorageClient) UpdateReplication(ctx context.Context, request UpdateReplicationRequest) (response UpdateReplicationResponse, err error)
UpdateReplication Updates the information for the specified replication and its associated replication target.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateReplication.go.html to see an example of how to use UpdateReplication API.
func (client FileStorageClient) UpdateSnapshot(ctx context.Context, request UpdateSnapshotRequest) (response UpdateSnapshotResponse, err error)
UpdateSnapshot Updates the specified snapshot's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateSnapshot.go.html to see an example of how to use UpdateSnapshot API.
func (client FileStorageClient) UpgradeShapeMountTarget(ctx context.Context, request UpgradeShapeMountTargetRequest) (response UpgradeShapeMountTargetResponse, err error)
UpgradeShapeMountTarget Upgrade shape request for mount target.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpgradeShapeMountTarget.go.html to see an example of how to use UpgradeShapeMountTarget API.
func (client FileStorageClient) ValidateKeyTabs(ctx context.Context, request ValidateKeyTabsRequest) (response ValidateKeyTabsResponse, err error)
ValidateKeyTabs Validates keytab contents for the secret details passed on the request or validte keytab contents associated with the mount target passed in the request. The keytabs are deserialized, the contents are validated for compatibility and the principal, key version number and encryption type of each entry is provided as part of the response.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ValidateKeyTabs.go.html to see an example of how to use ValidateKeyTabs API.
FileSystem An NFS file system. To allow access to a file system, add it to an export set and associate the export set with a mount target. The same file system can be in multiple export sets and associated with multiple mount targets. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type FileSystem struct {
// The number of bytes consumed by the file system, including
// any snapshots. This number reflects the metered size of the file
// system and is updated asynchronously with respect to
// updates to the file system.
// For more information, see File System Usage and Metering (https://docs.oracle.com/iaas/Content/File/Concepts/FSutilization.htm).
MeteredBytes *int64 `mandatory:"true" json:"meteredBytes"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My file system`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
Id *string `mandatory:"true" json:"id"`
// The current state of the file system.
LifecycleState FileSystemLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the file system was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The availability domain the file system is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KMS key which is the master encryption key for the file system.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
SourceDetails *SourceDetails `mandatory:"false" json:"sourceDetails"`
// Specifies whether the file system has been cloned.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
IsCloneParent *bool `mandatory:"false" json:"isCloneParent"`
// Specifies whether the data has finished copying from the source to the clone.
// Hydration can take up to several hours to complete depending on the size of the source.
// The source and clone remain available during hydration, but there may be some performance impact.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm#hydration).
IsHydrated *bool `mandatory:"false" json:"isHydrated"`
// Specifies the total number of children of a file system.
CloneCount *int `mandatory:"false" json:"cloneCount"`
// Specifies whether the file system is attached to its parent file system.
CloneAttachStatus FileSystemCloneAttachStatusEnum `mandatory:"false" json:"cloneAttachStatus,omitempty"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Additional information about the current 'lifecycleState'.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Specifies whether the file system can be used as a target file system for replication. The system sets this value to `true` if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to `false`.
// For more information, see Using Replication (https://docs.oracle.com/iaas/Content/File/Tasks/using-replication.htm).
IsTargetable *bool `mandatory:"false" json:"isTargetable"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication target associated with the file system.
// Empty if the file system is not being used as target in a replication.
ReplicationTargetId *string `mandatory:"false" json:"replicationTargetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated file system snapshot policy, which
// controls the frequency of snapshot creation and retention period of the taken snapshots.
FilesystemSnapshotPolicyId *string `mandatory:"false" json:"filesystemSnapshotPolicyId"`
// Specifies the enforcement of quota rules on the file system.
AreQuotaRulesEnabled *bool `mandatory:"false" json:"areQuotaRulesEnabled"`
// Displays the state of enforcement of quota rules on the file system.
QuotaEnforcementState FileSystemQuotaEnforcementStateEnum `mandatory:"false" json:"quotaEnforcementState,omitempty"`
// Specifies the total number of replications for which this file system is a source.
ReplicationSourceCount *int `mandatory:"false" json:"replicationSourceCount"`
}
func (m FileSystem) String() string
func (m FileSystem) 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
FileSystemCloneAttachStatusEnum Enum with underlying type: string
type FileSystemCloneAttachStatusEnum string
Set of constants representing the allowable values for FileSystemCloneAttachStatusEnum
const (
FileSystemCloneAttachStatusAttached FileSystemCloneAttachStatusEnum = "ATTACHED"
FileSystemCloneAttachStatusDetaching FileSystemCloneAttachStatusEnum = "DETACHING"
FileSystemCloneAttachStatusDetached FileSystemCloneAttachStatusEnum = "DETACHED"
)
func GetFileSystemCloneAttachStatusEnumValues() []FileSystemCloneAttachStatusEnum
GetFileSystemCloneAttachStatusEnumValues Enumerates the set of values for FileSystemCloneAttachStatusEnum
func GetMappingFileSystemCloneAttachStatusEnum(val string) (FileSystemCloneAttachStatusEnum, bool)
GetMappingFileSystemCloneAttachStatusEnum performs case Insensitive comparison on enum value and return the desired enum
FileSystemLifecycleStateEnum Enum with underlying type: string
type FileSystemLifecycleStateEnum string
Set of constants representing the allowable values for FileSystemLifecycleStateEnum
const (
FileSystemLifecycleStateCreating FileSystemLifecycleStateEnum = "CREATING"
FileSystemLifecycleStateActive FileSystemLifecycleStateEnum = "ACTIVE"
FileSystemLifecycleStateUpdating FileSystemLifecycleStateEnum = "UPDATING"
FileSystemLifecycleStateDeleting FileSystemLifecycleStateEnum = "DELETING"
FileSystemLifecycleStateDeleted FileSystemLifecycleStateEnum = "DELETED"
FileSystemLifecycleStateFailed FileSystemLifecycleStateEnum = "FAILED"
)
func GetFileSystemLifecycleStateEnumValues() []FileSystemLifecycleStateEnum
GetFileSystemLifecycleStateEnumValues Enumerates the set of values for FileSystemLifecycleStateEnum
func GetMappingFileSystemLifecycleStateEnum(val string) (FileSystemLifecycleStateEnum, bool)
GetMappingFileSystemLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
FileSystemQuotaEnforcementStateEnum Enum with underlying type: string
type FileSystemQuotaEnforcementStateEnum string
Set of constants representing the allowable values for FileSystemQuotaEnforcementStateEnum
const (
FileSystemQuotaEnforcementStateEnabling FileSystemQuotaEnforcementStateEnum = "ENABLING"
FileSystemQuotaEnforcementStateEnabled FileSystemQuotaEnforcementStateEnum = "ENABLED"
FileSystemQuotaEnforcementStateDisabling FileSystemQuotaEnforcementStateEnum = "DISABLING"
FileSystemQuotaEnforcementStateDisabled FileSystemQuotaEnforcementStateEnum = "DISABLED"
FileSystemQuotaEnforcementStateSyncing FileSystemQuotaEnforcementStateEnum = "SYNCING"
FileSystemQuotaEnforcementStateFailed FileSystemQuotaEnforcementStateEnum = "FAILED"
)
func GetFileSystemQuotaEnforcementStateEnumValues() []FileSystemQuotaEnforcementStateEnum
GetFileSystemQuotaEnforcementStateEnumValues Enumerates the set of values for FileSystemQuotaEnforcementStateEnum
func GetMappingFileSystemQuotaEnforcementStateEnum(val string) (FileSystemQuotaEnforcementStateEnum, bool)
GetMappingFileSystemQuotaEnforcementStateEnum performs case Insensitive comparison on enum value and return the desired enum
FileSystemSummary Summary information for a file system.
type FileSystemSummary struct {
// The number of bytes consumed by the file system, including
// any snapshots. This number reflects the metered size of the file
// system and is updated asynchronously with respect to
// updates to the file system.
MeteredBytes *int64 `mandatory:"true" json:"meteredBytes"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My file system`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
Id *string `mandatory:"true" json:"id"`
// The current state of the file system.
LifecycleState FileSystemSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the file system was created, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The availability domain the file system is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Specifies the total number of replications for which this file system is a source.
ReplicationSourceCount *int `mandatory:"false" json:"replicationSourceCount"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
SourceDetails *SourceDetails `mandatory:"false" json:"sourceDetails"`
// Specifies whether the file system has been cloned.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
IsCloneParent *bool `mandatory:"false" json:"isCloneParent"`
// Specifies whether the data has finished copying from the source to the clone.
// Hydration can take up to several hours to complete depending on the size of the source.
// The source and clone remain available during hydration, but there may be some performance impact.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm#hydration).
IsHydrated *bool `mandatory:"false" json:"isHydrated"`
// Additional information about the current 'lifecycleState'.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Specifies whether the file system is attached to its parent file system.
CloneAttachStatus FileSystemSummaryCloneAttachStatusEnum `mandatory:"false" json:"cloneAttachStatus,omitempty"`
// Displays the state of enforcement of quota rules on the file system.
QuotaEnforcementState FileSystemSummaryQuotaEnforcementStateEnum `mandatory:"false" json:"quotaEnforcementState,omitempty"`
}
func (m FileSystemSummary) String() string
func (m FileSystemSummary) 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
FileSystemSummaryCloneAttachStatusEnum Enum with underlying type: string
type FileSystemSummaryCloneAttachStatusEnum string
Set of constants representing the allowable values for FileSystemSummaryCloneAttachStatusEnum
const (
FileSystemSummaryCloneAttachStatusAttached FileSystemSummaryCloneAttachStatusEnum = "ATTACHED"
FileSystemSummaryCloneAttachStatusDetaching FileSystemSummaryCloneAttachStatusEnum = "DETACHING"
FileSystemSummaryCloneAttachStatusDetached FileSystemSummaryCloneAttachStatusEnum = "DETACHED"
)
func GetFileSystemSummaryCloneAttachStatusEnumValues() []FileSystemSummaryCloneAttachStatusEnum
GetFileSystemSummaryCloneAttachStatusEnumValues Enumerates the set of values for FileSystemSummaryCloneAttachStatusEnum
func GetMappingFileSystemSummaryCloneAttachStatusEnum(val string) (FileSystemSummaryCloneAttachStatusEnum, bool)
GetMappingFileSystemSummaryCloneAttachStatusEnum performs case Insensitive comparison on enum value and return the desired enum
FileSystemSummaryLifecycleStateEnum Enum with underlying type: string
type FileSystemSummaryLifecycleStateEnum string
Set of constants representing the allowable values for FileSystemSummaryLifecycleStateEnum
const (
FileSystemSummaryLifecycleStateCreating FileSystemSummaryLifecycleStateEnum = "CREATING"
FileSystemSummaryLifecycleStateActive FileSystemSummaryLifecycleStateEnum = "ACTIVE"
FileSystemSummaryLifecycleStateUpdating FileSystemSummaryLifecycleStateEnum = "UPDATING"
FileSystemSummaryLifecycleStateDeleting FileSystemSummaryLifecycleStateEnum = "DELETING"
FileSystemSummaryLifecycleStateDeleted FileSystemSummaryLifecycleStateEnum = "DELETED"
FileSystemSummaryLifecycleStateFailed FileSystemSummaryLifecycleStateEnum = "FAILED"
)
func GetFileSystemSummaryLifecycleStateEnumValues() []FileSystemSummaryLifecycleStateEnum
GetFileSystemSummaryLifecycleStateEnumValues Enumerates the set of values for FileSystemSummaryLifecycleStateEnum
func GetMappingFileSystemSummaryLifecycleStateEnum(val string) (FileSystemSummaryLifecycleStateEnum, bool)
GetMappingFileSystemSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
FileSystemSummaryQuotaEnforcementStateEnum Enum with underlying type: string
type FileSystemSummaryQuotaEnforcementStateEnum string
Set of constants representing the allowable values for FileSystemSummaryQuotaEnforcementStateEnum
const (
FileSystemSummaryQuotaEnforcementStateEnabling FileSystemSummaryQuotaEnforcementStateEnum = "ENABLING"
FileSystemSummaryQuotaEnforcementStateEnabled FileSystemSummaryQuotaEnforcementStateEnum = "ENABLED"
FileSystemSummaryQuotaEnforcementStateDisabling FileSystemSummaryQuotaEnforcementStateEnum = "DISABLING"
FileSystemSummaryQuotaEnforcementStateDisabled FileSystemSummaryQuotaEnforcementStateEnum = "DISABLED"
FileSystemSummaryQuotaEnforcementStateSyncing FileSystemSummaryQuotaEnforcementStateEnum = "SYNCING"
FileSystemSummaryQuotaEnforcementStateFailed FileSystemSummaryQuotaEnforcementStateEnum = "FAILED"
)
func GetFileSystemSummaryQuotaEnforcementStateEnumValues() []FileSystemSummaryQuotaEnforcementStateEnum
GetFileSystemSummaryQuotaEnforcementStateEnumValues Enumerates the set of values for FileSystemSummaryQuotaEnforcementStateEnum
func GetMappingFileSystemSummaryQuotaEnforcementStateEnum(val string) (FileSystemSummaryQuotaEnforcementStateEnum, bool)
GetMappingFileSystemSummaryQuotaEnforcementStateEnum performs case Insensitive comparison on enum value and return the desired enum
FilesystemSnapshotPolicy A file system snapshot policy is used to automate snapshot creation and deletion. It contains a list of snapshot schedules that define the frequency of snapshot creation for the associated file systems and the retention period of snapshots taken on schedule. For more information, see Snapshot Scheduling (https://docs.oracle.com/iaas/Content/File/Tasks/snapshot-policies-and-schedules.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type FilesystemSnapshotPolicy struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value.
// Example: `Uocm:PHX-AD-2`
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
Id *string `mandatory:"true" json:"id"`
// The current state of the file system snapshot policy.
LifecycleState FilesystemSnapshotPolicyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the file system snapshot policy was created, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `policy1`
DisplayName *string `mandatory:"false" json:"displayName"`
// The prefix to apply to all snapshots created by this policy.
// Example: `acme`
PolicyPrefix *string `mandatory:"false" json:"policyPrefix"`
// The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
Schedules []SnapshotSchedule `mandatory:"false" json:"schedules"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m FilesystemSnapshotPolicy) String() string
func (m FilesystemSnapshotPolicy) 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
FilesystemSnapshotPolicyLifecycleStateEnum Enum with underlying type: string
type FilesystemSnapshotPolicyLifecycleStateEnum string
Set of constants representing the allowable values for FilesystemSnapshotPolicyLifecycleStateEnum
const (
FilesystemSnapshotPolicyLifecycleStateCreating FilesystemSnapshotPolicyLifecycleStateEnum = "CREATING"
FilesystemSnapshotPolicyLifecycleStateActive FilesystemSnapshotPolicyLifecycleStateEnum = "ACTIVE"
FilesystemSnapshotPolicyLifecycleStateDeleting FilesystemSnapshotPolicyLifecycleStateEnum = "DELETING"
FilesystemSnapshotPolicyLifecycleStateDeleted FilesystemSnapshotPolicyLifecycleStateEnum = "DELETED"
FilesystemSnapshotPolicyLifecycleStateInactive FilesystemSnapshotPolicyLifecycleStateEnum = "INACTIVE"
FilesystemSnapshotPolicyLifecycleStateFailed FilesystemSnapshotPolicyLifecycleStateEnum = "FAILED"
)
func GetFilesystemSnapshotPolicyLifecycleStateEnumValues() []FilesystemSnapshotPolicyLifecycleStateEnum
GetFilesystemSnapshotPolicyLifecycleStateEnumValues Enumerates the set of values for FilesystemSnapshotPolicyLifecycleStateEnum
func GetMappingFilesystemSnapshotPolicyLifecycleStateEnum(val string) (FilesystemSnapshotPolicyLifecycleStateEnum, bool)
GetMappingFilesystemSnapshotPolicyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
FilesystemSnapshotPolicySummary Summary information for a file system snapshot policy.
type FilesystemSnapshotPolicySummary struct {
// The availability domain that the file system snapshot policy is in.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
Id *string `mandatory:"true" json:"id"`
// The current state of this file system snapshot policy.
LifecycleState FilesystemSnapshotPolicySummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time that the file system snapshot policy was created
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2020-02-04T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My Filesystem Snapshot Policy`
DisplayName *string `mandatory:"false" json:"displayName"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// The prefix to apply to all snapshots created by this policy.
// Example: `acme`
PolicyPrefix *string `mandatory:"false" json:"policyPrefix"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m FilesystemSnapshotPolicySummary) String() string
func (m FilesystemSnapshotPolicySummary) 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
FilesystemSnapshotPolicySummaryLifecycleStateEnum Enum with underlying type: string
type FilesystemSnapshotPolicySummaryLifecycleStateEnum string
Set of constants representing the allowable values for FilesystemSnapshotPolicySummaryLifecycleStateEnum
const (
FilesystemSnapshotPolicySummaryLifecycleStateCreating FilesystemSnapshotPolicySummaryLifecycleStateEnum = "CREATING"
FilesystemSnapshotPolicySummaryLifecycleStateActive FilesystemSnapshotPolicySummaryLifecycleStateEnum = "ACTIVE"
FilesystemSnapshotPolicySummaryLifecycleStateDeleting FilesystemSnapshotPolicySummaryLifecycleStateEnum = "DELETING"
FilesystemSnapshotPolicySummaryLifecycleStateDeleted FilesystemSnapshotPolicySummaryLifecycleStateEnum = "DELETED"
FilesystemSnapshotPolicySummaryLifecycleStateInactive FilesystemSnapshotPolicySummaryLifecycleStateEnum = "INACTIVE"
FilesystemSnapshotPolicySummaryLifecycleStateFailed FilesystemSnapshotPolicySummaryLifecycleStateEnum = "FAILED"
)
func GetFilesystemSnapshotPolicySummaryLifecycleStateEnumValues() []FilesystemSnapshotPolicySummaryLifecycleStateEnum
GetFilesystemSnapshotPolicySummaryLifecycleStateEnumValues Enumerates the set of values for FilesystemSnapshotPolicySummaryLifecycleStateEnum
func GetMappingFilesystemSnapshotPolicySummaryLifecycleStateEnum(val string) (FilesystemSnapshotPolicySummaryLifecycleStateEnum, bool)
GetMappingFilesystemSnapshotPolicySummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
GetExportRequest wrapper for the GetExport operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetExport.go.html to see an example of how to use GetExportRequest.
type GetExportRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export.
ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 GetExportRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetExportRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetExportRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetExportRequest) String() string
func (request GetExportRequest) 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
GetExportResponse wrapper for the GetExport operation
type GetExportResponse struct {
// The underlying http response
RawResponse *http.Response
// The Export instance
Export `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 GetExportResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetExportResponse) String() string
GetExportSetRequest wrapper for the GetExportSet operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetExportSet.go.html to see an example of how to use GetExportSetRequest.
type GetExportSetRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export set.
ExportSetId *string `mandatory:"true" contributesTo:"path" name:"exportSetId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 GetExportSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetExportSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetExportSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetExportSetRequest) String() string
func (request GetExportSetRequest) 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
GetExportSetResponse wrapper for the GetExportSet operation
type GetExportSetResponse struct {
// The underlying http response
RawResponse *http.Response
// The ExportSet instance
ExportSet `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 GetExportSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetExportSetResponse) String() string
GetFileSystemRequest wrapper for the GetFileSystem operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetFileSystem.go.html to see an example of how to use GetFileSystemRequest.
type GetFileSystemRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 GetFileSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetFileSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetFileSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetFileSystemRequest) String() string
func (request GetFileSystemRequest) 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
GetFileSystemResponse wrapper for the GetFileSystem operation
type GetFileSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// The FileSystem instance
FileSystem `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 GetFileSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetFileSystemResponse) String() string
GetFilesystemSnapshotPolicyRequest wrapper for the GetFilesystemSnapshotPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetFilesystemSnapshotPolicy.go.html to see an example of how to use GetFilesystemSnapshotPolicyRequest.
type GetFilesystemSnapshotPolicyRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
FilesystemSnapshotPolicyId *string `mandatory:"true" contributesTo:"path" name:"filesystemSnapshotPolicyId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 GetFilesystemSnapshotPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetFilesystemSnapshotPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetFilesystemSnapshotPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetFilesystemSnapshotPolicyRequest) String() string
func (request GetFilesystemSnapshotPolicyRequest) 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
GetFilesystemSnapshotPolicyResponse wrapper for the GetFilesystemSnapshotPolicy operation
type GetFilesystemSnapshotPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The FilesystemSnapshotPolicy instance
FilesystemSnapshotPolicy `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 GetFilesystemSnapshotPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetFilesystemSnapshotPolicyResponse) String() string
GetMountTargetRequest wrapper for the GetMountTarget operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetMountTarget.go.html to see an example of how to use GetMountTargetRequest.
type GetMountTargetRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 GetMountTargetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetMountTargetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetMountTargetRequest) String() string
func (request GetMountTargetRequest) 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
GetMountTargetResponse wrapper for the GetMountTarget operation
type GetMountTargetResponse struct {
// The underlying http response
RawResponse *http.Response
// The MountTarget instance
MountTarget `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 GetMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetMountTargetResponse) String() string
GetOutboundConnectorRequest wrapper for the GetOutboundConnector operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetOutboundConnector.go.html to see an example of how to use GetOutboundConnectorRequest.
type GetOutboundConnectorRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector.
OutboundConnectorId *string `mandatory:"true" contributesTo:"path" name:"outboundConnectorId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 GetOutboundConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOutboundConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOutboundConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOutboundConnectorRequest) String() string
func (request GetOutboundConnectorRequest) 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
GetOutboundConnectorResponse wrapper for the GetOutboundConnector operation
type GetOutboundConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// The OutboundConnector instance
OutboundConnector `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 GetOutboundConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOutboundConnectorResponse) String() string
GetQuotaRuleRequest wrapper for the GetQuotaRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetQuotaRule.go.html to see an example of how to use GetQuotaRuleRequest.
type GetQuotaRuleRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
QuotaRuleId *string `mandatory:"true" contributesTo:"path" name:"quotaRuleId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 GetQuotaRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetQuotaRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetQuotaRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetQuotaRuleRequest) String() string
func (request GetQuotaRuleRequest) 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
GetQuotaRuleResponse wrapper for the GetQuotaRule operation
type GetQuotaRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The QuotaRule instance
QuotaRule `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 GetQuotaRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetQuotaRuleResponse) String() string
GetReplicationRequest wrapper for the GetReplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetReplication.go.html to see an example of how to use GetReplicationRequest.
type GetReplicationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication.
ReplicationId *string `mandatory:"true" contributesTo:"path" name:"replicationId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 GetReplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetReplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetReplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetReplicationRequest) String() string
func (request GetReplicationRequest) 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
GetReplicationResponse wrapper for the GetReplication operation
type GetReplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Replication instance
Replication `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 GetReplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetReplicationResponse) String() string
GetReplicationTargetRequest wrapper for the GetReplicationTarget operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetReplicationTarget.go.html to see an example of how to use GetReplicationTargetRequest.
type GetReplicationTargetRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication target.
ReplicationTargetId *string `mandatory:"true" contributesTo:"path" name:"replicationTargetId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 GetReplicationTargetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetReplicationTargetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetReplicationTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetReplicationTargetRequest) String() string
func (request GetReplicationTargetRequest) 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
GetReplicationTargetResponse wrapper for the GetReplicationTarget operation
type GetReplicationTargetResponse struct {
// The underlying http response
RawResponse *http.Response
// The ReplicationTarget instance
ReplicationTarget `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 GetReplicationTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetReplicationTargetResponse) String() string
GetSnapshotRequest wrapper for the GetSnapshot operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/GetSnapshot.go.html to see an example of how to use GetSnapshotRequest.
type GetSnapshotRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot.
SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 GetSnapshotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSnapshotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSnapshotRequest) String() string
func (request GetSnapshotRequest) 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
GetSnapshotResponse wrapper for the GetSnapshot operation
type GetSnapshotResponse struct {
// The underlying http response
RawResponse *http.Response
// The Snapshot instance
Snapshot `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 GetSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSnapshotResponse) String() string
Kerberos Allows administrator to configure a mount target to interact with the administrator's Kerberos infrastructure.
type Kerberos struct {
// The Kerberos realm that the mount target will join.
KerberosRealm *string `mandatory:"true" json:"kerberosRealm"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the keytab secret in the Vault.
KeyTabSecretId *string `mandatory:"false" json:"keyTabSecretId"`
// Version of the keytab secret in the Vault to use.
CurrentKeyTabSecretVersion *int `mandatory:"false" json:"currentKeyTabSecretVersion"`
// Version of the keytab secert in the Vault to use as a backup.
BackupKeyTabSecretVersion *int `mandatory:"false" json:"backupKeyTabSecretVersion"`
// Specifies whether to enable or disable Kerberos.
IsKerberosEnabled *bool `mandatory:"false" json:"isKerberosEnabled"`
}
func (m Kerberos) String() string
func (m Kerberos) 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
KerberosKeytabEntry Details of each keytab entry read from the keytab file.
type KerberosKeytabEntry struct {
// Keytab principal.
Principal *string `mandatory:"true" json:"principal"`
// Encryption type with with keytab was generated.
// Secure: aes128-cts-hmac-sha256-128
// Secure: aes256-cts-hmac-sha384-192
// Less Secure: aes128-cts-hmac-sha1-96
// Less Secure: aes256-cts-hmac-sha1-96
EncryptionType KerberosKeytabEntryEncryptionTypeEnum `mandatory:"true" json:"encryptionType"`
// Kerberos KVNO (key version number) for key in keytab entry.
KeyVersionNumber *int64 `mandatory:"true" json:"keyVersionNumber"`
}
func (m KerberosKeytabEntry) String() string
func (m KerberosKeytabEntry) 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
KerberosKeytabEntryEncryptionTypeEnum Enum with underlying type: string
type KerberosKeytabEntryEncryptionTypeEnum string
Set of constants representing the allowable values for KerberosKeytabEntryEncryptionTypeEnum
const (
KerberosKeytabEntryEncryptionTypeAes128CtsHmacSha256128 KerberosKeytabEntryEncryptionTypeEnum = "AES128_CTS_HMAC_SHA256_128"
KerberosKeytabEntryEncryptionTypeAes256CtsHmacSha384192 KerberosKeytabEntryEncryptionTypeEnum = "AES256_CTS_HMAC_SHA384_192"
KerberosKeytabEntryEncryptionTypeAes128CtsHmacSha196 KerberosKeytabEntryEncryptionTypeEnum = "AES128_CTS_HMAC_SHA1_96"
KerberosKeytabEntryEncryptionTypeAes256CtsHmacSha196 KerberosKeytabEntryEncryptionTypeEnum = "AES256_CTS_HMAC_SHA1_96"
)
func GetKerberosKeytabEntryEncryptionTypeEnumValues() []KerberosKeytabEntryEncryptionTypeEnum
GetKerberosKeytabEntryEncryptionTypeEnumValues Enumerates the set of values for KerberosKeytabEntryEncryptionTypeEnum
func GetMappingKerberosKeytabEntryEncryptionTypeEnum(val string) (KerberosKeytabEntryEncryptionTypeEnum, bool)
GetMappingKerberosKeytabEntryEncryptionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
KeyTabSecretDetails Secret details of keytabs in Vault.
type KeyTabSecretDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the keytab secret in the Vault.
KeyTabSecretId *string `mandatory:"true" json:"keyTabSecretId"`
// Version of the keytab secret in the Vault to use.
CurrentKeyTabSecretVersion *int `mandatory:"true" json:"currentKeyTabSecretVersion"`
// Version of the keytab secret in the Vault to use as a backup.
BackupKeyTabSecretVersion *int `mandatory:"false" json:"backupKeyTabSecretVersion"`
}
func (m KeyTabSecretDetails) String() string
func (m KeyTabSecretDetails) 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
LdapBindAccount Account details for the LDAP bind account used by the outbound connector.
type LdapBindAccount struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My outbound connector`
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time the outbound connector was created
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Array of server endpoints to use when connecting with the LDAP bind account.
Endpoints []Endpoint `mandatory:"true" json:"endpoints"`
// The LDAP Distinguished Name of the account.
BindDistinguishedName *string `mandatory:"true" json:"bindDistinguishedName"`
// The availability domain the outbound connector is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the password for the LDAP bind account in the Vault.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Version of the password secret in the Vault to use.
PasswordSecretVersion *int `mandatory:"false" json:"passwordSecretVersion"`
// The current state of this outbound connector.
LifecycleState OutboundConnectorLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m LdapBindAccount) GetAvailabilityDomain() *string
GetAvailabilityDomain returns AvailabilityDomain
func (m LdapBindAccount) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m LdapBindAccount) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m LdapBindAccount) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m LdapBindAccount) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m LdapBindAccount) GetId() *string
GetId returns Id
func (m LdapBindAccount) GetLifecycleState() OutboundConnectorLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m LdapBindAccount) GetLocks() []ResourceLock
GetLocks returns Locks
func (m LdapBindAccount) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m LdapBindAccount) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m LdapBindAccount) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LdapBindAccount) String() string
func (m LdapBindAccount) 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
LdapBindAccountSummary Summary information for the LDAP bind account used by the outbound connector.
type LdapBindAccountSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My outbound connector`
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time the outbound connector was created
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Array of server endpoints to use when connecting with the LDAP bind account.
Endpoints []Endpoint `mandatory:"true" json:"endpoints"`
// The LDAP Distinguished Name of the account.
BindDistinguishedName *string `mandatory:"true" json:"bindDistinguishedName"`
// The availability domain the outbound connector is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The current state of this outbound connector.
LifecycleState OutboundConnectorSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m LdapBindAccountSummary) GetAvailabilityDomain() *string
GetAvailabilityDomain returns AvailabilityDomain
func (m LdapBindAccountSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m LdapBindAccountSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m LdapBindAccountSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m LdapBindAccountSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m LdapBindAccountSummary) GetId() *string
GetId returns Id
func (m LdapBindAccountSummary) GetLifecycleState() OutboundConnectorSummaryLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m LdapBindAccountSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m LdapBindAccountSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m LdapBindAccountSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m LdapBindAccountSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LdapBindAccountSummary) String() string
func (m LdapBindAccountSummary) 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
LdapIdmap Mount target details about the LDAP ID mapping configuration.
type LdapIdmap struct {
// Schema type of the LDAP account.
SchemaType LdapIdmapSchemaTypeEnum `mandatory:"false" json:"schemaType,omitempty"`
// The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry.
CacheRefreshIntervalSeconds *int `mandatory:"false" json:"cacheRefreshIntervalSeconds"`
// The maximum amount of time the mount target is allowed to use a cached entry.
CacheLifetimeSeconds *int `mandatory:"false" json:"cacheLifetimeSeconds"`
// The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration.
NegativeCacheLifetimeSeconds *int `mandatory:"false" json:"negativeCacheLifetimeSeconds"`
// All LDAP searches are recursive starting at this user.
// Example: `CN=User,DC=domain,DC=com`
UserSearchBase *string `mandatory:"false" json:"userSearchBase"`
// All LDAP searches are recursive starting at this group.
// Example: `CN=Group,DC=domain,DC=com`
GroupSearchBase *string `mandatory:"false" json:"groupSearchBase"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first connector to use to communicate with the LDAP server.
OutboundConnector1Id *string `mandatory:"false" json:"outboundConnector1Id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second connector to use to communicate with the LDAP server.
OutboundConnector2Id *string `mandatory:"false" json:"outboundConnector2Id"`
}
func (m LdapIdmap) String() string
func (m LdapIdmap) 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
LdapIdmapSchemaTypeEnum Enum with underlying type: string
type LdapIdmapSchemaTypeEnum string
Set of constants representing the allowable values for LdapIdmapSchemaTypeEnum
const (
LdapIdmapSchemaTypeRfc2307 LdapIdmapSchemaTypeEnum = "RFC2307"
)
func GetLdapIdmapSchemaTypeEnumValues() []LdapIdmapSchemaTypeEnum
GetLdapIdmapSchemaTypeEnumValues Enumerates the set of values for LdapIdmapSchemaTypeEnum
func GetMappingLdapIdmapSchemaTypeEnum(val string) (LdapIdmapSchemaTypeEnum, bool)
GetMappingLdapIdmapSchemaTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListExportSetsLifecycleStateEnum Enum with underlying type: string
type ListExportSetsLifecycleStateEnum string
Set of constants representing the allowable values for ListExportSetsLifecycleStateEnum
const (
ListExportSetsLifecycleStateCreating ListExportSetsLifecycleStateEnum = "CREATING"
ListExportSetsLifecycleStateActive ListExportSetsLifecycleStateEnum = "ACTIVE"
ListExportSetsLifecycleStateUpdating ListExportSetsLifecycleStateEnum = "UPDATING"
ListExportSetsLifecycleStateDeleting ListExportSetsLifecycleStateEnum = "DELETING"
ListExportSetsLifecycleStateDeleted ListExportSetsLifecycleStateEnum = "DELETED"
ListExportSetsLifecycleStateFailed ListExportSetsLifecycleStateEnum = "FAILED"
)
func GetListExportSetsLifecycleStateEnumValues() []ListExportSetsLifecycleStateEnum
GetListExportSetsLifecycleStateEnumValues Enumerates the set of values for ListExportSetsLifecycleStateEnum
func GetMappingListExportSetsLifecycleStateEnum(val string) (ListExportSetsLifecycleStateEnum, bool)
GetMappingListExportSetsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListExportSetsRequest wrapper for the ListExportSets operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListExportSets.go.html to see an example of how to use ListExportSetsRequest.
type ListExportSetsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 4096 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Example: `My resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListExportSetsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Filter results by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
// the resouce type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The field to sort by. You can provide either value, but not both.
// By default, when you sort by time created, results are shown
// in descending order. When you sort by display name, results are
// shown in ascending order.
SortBy ListExportSetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListExportSetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ListExportSetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListExportSetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListExportSetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListExportSetsRequest) String() string
func (request ListExportSetsRequest) 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
ListExportSetsResponse wrapper for the ListExportSets operation
type ListExportSetsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ExportSetSummary instances
Items []ExportSetSummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListExportSetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListExportSetsResponse) String() string
ListExportSetsSortByEnum Enum with underlying type: string
type ListExportSetsSortByEnum string
Set of constants representing the allowable values for ListExportSetsSortByEnum
const (
ListExportSetsSortByTimecreated ListExportSetsSortByEnum = "TIMECREATED"
ListExportSetsSortByDisplayname ListExportSetsSortByEnum = "DISPLAYNAME"
)
func GetListExportSetsSortByEnumValues() []ListExportSetsSortByEnum
GetListExportSetsSortByEnumValues Enumerates the set of values for ListExportSetsSortByEnum
func GetMappingListExportSetsSortByEnum(val string) (ListExportSetsSortByEnum, bool)
GetMappingListExportSetsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListExportSetsSortOrderEnum Enum with underlying type: string
type ListExportSetsSortOrderEnum string
Set of constants representing the allowable values for ListExportSetsSortOrderEnum
const (
ListExportSetsSortOrderAsc ListExportSetsSortOrderEnum = "ASC"
ListExportSetsSortOrderDesc ListExportSetsSortOrderEnum = "DESC"
)
func GetListExportSetsSortOrderEnumValues() []ListExportSetsSortOrderEnum
GetListExportSetsSortOrderEnumValues Enumerates the set of values for ListExportSetsSortOrderEnum
func GetMappingListExportSetsSortOrderEnum(val string) (ListExportSetsSortOrderEnum, bool)
GetMappingListExportSetsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListExportsLifecycleStateEnum Enum with underlying type: string
type ListExportsLifecycleStateEnum string
Set of constants representing the allowable values for ListExportsLifecycleStateEnum
const (
ListExportsLifecycleStateCreating ListExportsLifecycleStateEnum = "CREATING"
ListExportsLifecycleStateActive ListExportsLifecycleStateEnum = "ACTIVE"
ListExportsLifecycleStateUpdating ListExportsLifecycleStateEnum = "UPDATING"
ListExportsLifecycleStateDeleting ListExportsLifecycleStateEnum = "DELETING"
ListExportsLifecycleStateDeleted ListExportsLifecycleStateEnum = "DELETED"
ListExportsLifecycleStateFailed ListExportsLifecycleStateEnum = "FAILED"
)
func GetListExportsLifecycleStateEnumValues() []ListExportsLifecycleStateEnum
GetListExportsLifecycleStateEnumValues Enumerates the set of values for ListExportsLifecycleStateEnum
func GetMappingListExportsLifecycleStateEnum(val string) (ListExportsLifecycleStateEnum, bool)
GetMappingListExportsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListExportsRequest wrapper for the ListExports operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListExports.go.html to see an example of how to use ListExportsRequest.
type ListExportsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 4096 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export set.
ExportSetId *string `mandatory:"false" contributesTo:"query" name:"exportSetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"false" contributesTo:"query" name:"fileSystemId"`
// Filter results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListExportsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Filter results by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
// the resouce type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The field to sort by. You can provide either value, but not both.
// By default, when you sort by time created, results are shown
// in descending order. When you sort by path, results are
// shown in ascending alphanumeric order.
SortBy ListExportsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListExportsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ListExportsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListExportsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListExportsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListExportsRequest) String() string
func (request ListExportsRequest) 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
ListExportsResponse wrapper for the ListExports operation
type ListExportsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ExportSummary instances
Items []ExportSummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListExportsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListExportsResponse) String() string
ListExportsSortByEnum Enum with underlying type: string
type ListExportsSortByEnum string
Set of constants representing the allowable values for ListExportsSortByEnum
const (
ListExportsSortByTimecreated ListExportsSortByEnum = "TIMECREATED"
ListExportsSortByPath ListExportsSortByEnum = "PATH"
)
func GetListExportsSortByEnumValues() []ListExportsSortByEnum
GetListExportsSortByEnumValues Enumerates the set of values for ListExportsSortByEnum
func GetMappingListExportsSortByEnum(val string) (ListExportsSortByEnum, bool)
GetMappingListExportsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListExportsSortOrderEnum Enum with underlying type: string
type ListExportsSortOrderEnum string
Set of constants representing the allowable values for ListExportsSortOrderEnum
const (
ListExportsSortOrderAsc ListExportsSortOrderEnum = "ASC"
ListExportsSortOrderDesc ListExportsSortOrderEnum = "DESC"
)
func GetListExportsSortOrderEnumValues() []ListExportsSortOrderEnum
GetListExportsSortOrderEnumValues Enumerates the set of values for ListExportsSortOrderEnum
func GetMappingListExportsSortOrderEnum(val string) (ListExportsSortOrderEnum, bool)
GetMappingListExportsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListFileSystemsLifecycleStateEnum Enum with underlying type: string
type ListFileSystemsLifecycleStateEnum string
Set of constants representing the allowable values for ListFileSystemsLifecycleStateEnum
const (
ListFileSystemsLifecycleStateCreating ListFileSystemsLifecycleStateEnum = "CREATING"
ListFileSystemsLifecycleStateActive ListFileSystemsLifecycleStateEnum = "ACTIVE"
ListFileSystemsLifecycleStateUpdating ListFileSystemsLifecycleStateEnum = "UPDATING"
ListFileSystemsLifecycleStateDeleting ListFileSystemsLifecycleStateEnum = "DELETING"
ListFileSystemsLifecycleStateDeleted ListFileSystemsLifecycleStateEnum = "DELETED"
ListFileSystemsLifecycleStateFailed ListFileSystemsLifecycleStateEnum = "FAILED"
)
func GetListFileSystemsLifecycleStateEnumValues() []ListFileSystemsLifecycleStateEnum
GetListFileSystemsLifecycleStateEnumValues Enumerates the set of values for ListFileSystemsLifecycleStateEnum
func GetMappingListFileSystemsLifecycleStateEnum(val string) (ListFileSystemsLifecycleStateEnum, bool)
GetMappingListFileSystemsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListFileSystemsRequest wrapper for the ListFileSystems operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListFileSystems.go.html to see an example of how to use ListFileSystemsRequest.
type ListFileSystemsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 4096 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Example: `My resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListFileSystemsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Filter results by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
// the resouce type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system. See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
SourceSnapshotId *string `mandatory:"false" contributesTo:"query" name:"sourceSnapshotId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system that contains the source snapshot of a cloned file system. See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
ParentFileSystemId *string `mandatory:"false" contributesTo:"query" name:"parentFileSystemId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy
// that is associated with the file systems.
FilesystemSnapshotPolicyId *string `mandatory:"false" contributesTo:"query" name:"filesystemSnapshotPolicyId"`
// The field to sort by. You can provide either value, but not both.
// By default, when you sort by time created, results are shown
// in descending order. When you sort by display name, results are
// shown in ascending order.
SortBy ListFileSystemsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListFileSystemsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ListFileSystemsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListFileSystemsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListFileSystemsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListFileSystemsRequest) String() string
func (request ListFileSystemsRequest) 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
ListFileSystemsResponse wrapper for the ListFileSystems operation
type ListFileSystemsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []FileSystemSummary instances
Items []FileSystemSummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListFileSystemsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListFileSystemsResponse) String() string
ListFileSystemsSortByEnum Enum with underlying type: string
type ListFileSystemsSortByEnum string
Set of constants representing the allowable values for ListFileSystemsSortByEnum
const (
ListFileSystemsSortByTimecreated ListFileSystemsSortByEnum = "TIMECREATED"
ListFileSystemsSortByDisplayname ListFileSystemsSortByEnum = "DISPLAYNAME"
)
func GetListFileSystemsSortByEnumValues() []ListFileSystemsSortByEnum
GetListFileSystemsSortByEnumValues Enumerates the set of values for ListFileSystemsSortByEnum
func GetMappingListFileSystemsSortByEnum(val string) (ListFileSystemsSortByEnum, bool)
GetMappingListFileSystemsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListFileSystemsSortOrderEnum Enum with underlying type: string
type ListFileSystemsSortOrderEnum string
Set of constants representing the allowable values for ListFileSystemsSortOrderEnum
const (
ListFileSystemsSortOrderAsc ListFileSystemsSortOrderEnum = "ASC"
ListFileSystemsSortOrderDesc ListFileSystemsSortOrderEnum = "DESC"
)
func GetListFileSystemsSortOrderEnumValues() []ListFileSystemsSortOrderEnum
GetListFileSystemsSortOrderEnumValues Enumerates the set of values for ListFileSystemsSortOrderEnum
func GetMappingListFileSystemsSortOrderEnum(val string) (ListFileSystemsSortOrderEnum, bool)
GetMappingListFileSystemsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListFilesystemSnapshotPoliciesLifecycleStateEnum Enum with underlying type: string
type ListFilesystemSnapshotPoliciesLifecycleStateEnum string
Set of constants representing the allowable values for ListFilesystemSnapshotPoliciesLifecycleStateEnum
const (
ListFilesystemSnapshotPoliciesLifecycleStateCreating ListFilesystemSnapshotPoliciesLifecycleStateEnum = "CREATING"
ListFilesystemSnapshotPoliciesLifecycleStateActive ListFilesystemSnapshotPoliciesLifecycleStateEnum = "ACTIVE"
ListFilesystemSnapshotPoliciesLifecycleStateDeleting ListFilesystemSnapshotPoliciesLifecycleStateEnum = "DELETING"
ListFilesystemSnapshotPoliciesLifecycleStateDeleted ListFilesystemSnapshotPoliciesLifecycleStateEnum = "DELETED"
ListFilesystemSnapshotPoliciesLifecycleStateFailed ListFilesystemSnapshotPoliciesLifecycleStateEnum = "FAILED"
ListFilesystemSnapshotPoliciesLifecycleStateInactive ListFilesystemSnapshotPoliciesLifecycleStateEnum = "INACTIVE"
)
func GetListFilesystemSnapshotPoliciesLifecycleStateEnumValues() []ListFilesystemSnapshotPoliciesLifecycleStateEnum
GetListFilesystemSnapshotPoliciesLifecycleStateEnumValues Enumerates the set of values for ListFilesystemSnapshotPoliciesLifecycleStateEnum
func GetMappingListFilesystemSnapshotPoliciesLifecycleStateEnum(val string) (ListFilesystemSnapshotPoliciesLifecycleStateEnum, bool)
GetMappingListFilesystemSnapshotPoliciesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListFilesystemSnapshotPoliciesRequest wrapper for the ListFilesystemSnapshotPolicies operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListFilesystemSnapshotPolicies.go.html to see an example of how to use ListFilesystemSnapshotPoliciesRequest.
type ListFilesystemSnapshotPoliciesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 4096 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Example: `My resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListFilesystemSnapshotPoliciesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Filter results by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
// the resouce type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The field to sort by. You can provide either value, but not both.
// By default, when you sort by time created, results are shown
// in descending order. When you sort by displayName, results are
// shown in ascending alphanumeric order.
SortBy ListFilesystemSnapshotPoliciesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListFilesystemSnapshotPoliciesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ListFilesystemSnapshotPoliciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListFilesystemSnapshotPoliciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListFilesystemSnapshotPoliciesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListFilesystemSnapshotPoliciesRequest) String() string
func (request ListFilesystemSnapshotPoliciesRequest) 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
ListFilesystemSnapshotPoliciesResponse wrapper for the ListFilesystemSnapshotPolicies operation
type ListFilesystemSnapshotPoliciesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []FilesystemSnapshotPolicySummary instances
Items []FilesystemSnapshotPolicySummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListFilesystemSnapshotPoliciesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListFilesystemSnapshotPoliciesResponse) String() string
ListFilesystemSnapshotPoliciesSortByEnum Enum with underlying type: string
type ListFilesystemSnapshotPoliciesSortByEnum string
Set of constants representing the allowable values for ListFilesystemSnapshotPoliciesSortByEnum
const (
ListFilesystemSnapshotPoliciesSortByTimecreated ListFilesystemSnapshotPoliciesSortByEnum = "TIMECREATED"
ListFilesystemSnapshotPoliciesSortByDisplayname ListFilesystemSnapshotPoliciesSortByEnum = "DISPLAYNAME"
)
func GetListFilesystemSnapshotPoliciesSortByEnumValues() []ListFilesystemSnapshotPoliciesSortByEnum
GetListFilesystemSnapshotPoliciesSortByEnumValues Enumerates the set of values for ListFilesystemSnapshotPoliciesSortByEnum
func GetMappingListFilesystemSnapshotPoliciesSortByEnum(val string) (ListFilesystemSnapshotPoliciesSortByEnum, bool)
GetMappingListFilesystemSnapshotPoliciesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListFilesystemSnapshotPoliciesSortOrderEnum Enum with underlying type: string
type ListFilesystemSnapshotPoliciesSortOrderEnum string
Set of constants representing the allowable values for ListFilesystemSnapshotPoliciesSortOrderEnum
const (
ListFilesystemSnapshotPoliciesSortOrderAsc ListFilesystemSnapshotPoliciesSortOrderEnum = "ASC"
ListFilesystemSnapshotPoliciesSortOrderDesc ListFilesystemSnapshotPoliciesSortOrderEnum = "DESC"
)
func GetListFilesystemSnapshotPoliciesSortOrderEnumValues() []ListFilesystemSnapshotPoliciesSortOrderEnum
GetListFilesystemSnapshotPoliciesSortOrderEnumValues Enumerates the set of values for ListFilesystemSnapshotPoliciesSortOrderEnum
func GetMappingListFilesystemSnapshotPoliciesSortOrderEnum(val string) (ListFilesystemSnapshotPoliciesSortOrderEnum, bool)
GetMappingListFilesystemSnapshotPoliciesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListMountTargetsLifecycleStateEnum Enum with underlying type: string
type ListMountTargetsLifecycleStateEnum string
Set of constants representing the allowable values for ListMountTargetsLifecycleStateEnum
const (
ListMountTargetsLifecycleStateCreating ListMountTargetsLifecycleStateEnum = "CREATING"
ListMountTargetsLifecycleStateActive ListMountTargetsLifecycleStateEnum = "ACTIVE"
ListMountTargetsLifecycleStateUpdating ListMountTargetsLifecycleStateEnum = "UPDATING"
ListMountTargetsLifecycleStateDeleting ListMountTargetsLifecycleStateEnum = "DELETING"
ListMountTargetsLifecycleStateDeleted ListMountTargetsLifecycleStateEnum = "DELETED"
ListMountTargetsLifecycleStateFailed ListMountTargetsLifecycleStateEnum = "FAILED"
)
func GetListMountTargetsLifecycleStateEnumValues() []ListMountTargetsLifecycleStateEnum
GetListMountTargetsLifecycleStateEnumValues Enumerates the set of values for ListMountTargetsLifecycleStateEnum
func GetMappingListMountTargetsLifecycleStateEnum(val string) (ListMountTargetsLifecycleStateEnum, bool)
GetMappingListMountTargetsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListMountTargetsRequest wrapper for the ListMountTargets operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListMountTargets.go.html to see an example of how to use ListMountTargetsRequest.
type ListMountTargetsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 4096 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Example: `My resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export set.
ExportSetId *string `mandatory:"false" contributesTo:"query" name:"exportSetId"`
// Filter results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListMountTargetsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Filter results by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
// the resouce type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The field to sort by. You can choose either value, but not both.
// By default, when you sort by time created, results are shown
// in descending order. When you sort by display name, results are
// shown in ascending order.
SortBy ListMountTargetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListMountTargetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ListMountTargetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListMountTargetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListMountTargetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListMountTargetsRequest) String() string
func (request ListMountTargetsRequest) 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
ListMountTargetsResponse wrapper for the ListMountTargets operation
type ListMountTargetsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []MountTargetSummary instances
Items []MountTargetSummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListMountTargetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListMountTargetsResponse) String() string
ListMountTargetsSortByEnum Enum with underlying type: string
type ListMountTargetsSortByEnum string
Set of constants representing the allowable values for ListMountTargetsSortByEnum
const (
ListMountTargetsSortByTimecreated ListMountTargetsSortByEnum = "TIMECREATED"
ListMountTargetsSortByDisplayname ListMountTargetsSortByEnum = "DISPLAYNAME"
)
func GetListMountTargetsSortByEnumValues() []ListMountTargetsSortByEnum
GetListMountTargetsSortByEnumValues Enumerates the set of values for ListMountTargetsSortByEnum
func GetMappingListMountTargetsSortByEnum(val string) (ListMountTargetsSortByEnum, bool)
GetMappingListMountTargetsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListMountTargetsSortOrderEnum Enum with underlying type: string
type ListMountTargetsSortOrderEnum string
Set of constants representing the allowable values for ListMountTargetsSortOrderEnum
const (
ListMountTargetsSortOrderAsc ListMountTargetsSortOrderEnum = "ASC"
ListMountTargetsSortOrderDesc ListMountTargetsSortOrderEnum = "DESC"
)
func GetListMountTargetsSortOrderEnumValues() []ListMountTargetsSortOrderEnum
GetListMountTargetsSortOrderEnumValues Enumerates the set of values for ListMountTargetsSortOrderEnum
func GetMappingListMountTargetsSortOrderEnum(val string) (ListMountTargetsSortOrderEnum, bool)
GetMappingListMountTargetsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOutboundConnectorsLifecycleStateEnum Enum with underlying type: string
type ListOutboundConnectorsLifecycleStateEnum string
Set of constants representing the allowable values for ListOutboundConnectorsLifecycleStateEnum
const (
ListOutboundConnectorsLifecycleStateCreating ListOutboundConnectorsLifecycleStateEnum = "CREATING"
ListOutboundConnectorsLifecycleStateActive ListOutboundConnectorsLifecycleStateEnum = "ACTIVE"
ListOutboundConnectorsLifecycleStateUpdating ListOutboundConnectorsLifecycleStateEnum = "UPDATING"
ListOutboundConnectorsLifecycleStateDeleting ListOutboundConnectorsLifecycleStateEnum = "DELETING"
ListOutboundConnectorsLifecycleStateDeleted ListOutboundConnectorsLifecycleStateEnum = "DELETED"
ListOutboundConnectorsLifecycleStateFailed ListOutboundConnectorsLifecycleStateEnum = "FAILED"
)
func GetListOutboundConnectorsLifecycleStateEnumValues() []ListOutboundConnectorsLifecycleStateEnum
GetListOutboundConnectorsLifecycleStateEnumValues Enumerates the set of values for ListOutboundConnectorsLifecycleStateEnum
func GetMappingListOutboundConnectorsLifecycleStateEnum(val string) (ListOutboundConnectorsLifecycleStateEnum, bool)
GetMappingListOutboundConnectorsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListOutboundConnectorsRequest wrapper for the ListOutboundConnectors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListOutboundConnectors.go.html to see an example of how to use ListOutboundConnectorsRequest.
type ListOutboundConnectorsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 4096 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Filter results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListOutboundConnectorsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Example: `My resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter results by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
// the resouce type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The field to sort by. You can choose either value, but not both.
// By default, when you sort by time created, results are shown
// in descending order. When you sort by display name, results are
// shown in ascending order.
SortBy ListOutboundConnectorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListOutboundConnectorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ListOutboundConnectorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOutboundConnectorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOutboundConnectorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOutboundConnectorsRequest) String() string
func (request ListOutboundConnectorsRequest) 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
ListOutboundConnectorsResponse wrapper for the ListOutboundConnectors operation
type ListOutboundConnectorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []OutboundConnectorSummary instances
Items []OutboundConnectorSummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListOutboundConnectorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOutboundConnectorsResponse) String() string
ListOutboundConnectorsSortByEnum Enum with underlying type: string
type ListOutboundConnectorsSortByEnum string
Set of constants representing the allowable values for ListOutboundConnectorsSortByEnum
const (
ListOutboundConnectorsSortByTimecreated ListOutboundConnectorsSortByEnum = "TIMECREATED"
ListOutboundConnectorsSortByDisplayname ListOutboundConnectorsSortByEnum = "DISPLAYNAME"
)
func GetListOutboundConnectorsSortByEnumValues() []ListOutboundConnectorsSortByEnum
GetListOutboundConnectorsSortByEnumValues Enumerates the set of values for ListOutboundConnectorsSortByEnum
func GetMappingListOutboundConnectorsSortByEnum(val string) (ListOutboundConnectorsSortByEnum, bool)
GetMappingListOutboundConnectorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOutboundConnectorsSortOrderEnum Enum with underlying type: string
type ListOutboundConnectorsSortOrderEnum string
Set of constants representing the allowable values for ListOutboundConnectorsSortOrderEnum
const (
ListOutboundConnectorsSortOrderAsc ListOutboundConnectorsSortOrderEnum = "ASC"
ListOutboundConnectorsSortOrderDesc ListOutboundConnectorsSortOrderEnum = "DESC"
)
func GetListOutboundConnectorsSortOrderEnumValues() []ListOutboundConnectorsSortOrderEnum
GetListOutboundConnectorsSortOrderEnumValues Enumerates the set of values for ListOutboundConnectorsSortOrderEnum
func GetMappingListOutboundConnectorsSortOrderEnum(val string) (ListOutboundConnectorsSortOrderEnum, bool)
GetMappingListOutboundConnectorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListQuotaRulesPrincipalTypeEnum Enum with underlying type: string
type ListQuotaRulesPrincipalTypeEnum string
Set of constants representing the allowable values for ListQuotaRulesPrincipalTypeEnum
const (
ListQuotaRulesPrincipalTypeFileSystemLevel ListQuotaRulesPrincipalTypeEnum = "FILE_SYSTEM_LEVEL"
ListQuotaRulesPrincipalTypeDefaultGroup ListQuotaRulesPrincipalTypeEnum = "DEFAULT_GROUP"
ListQuotaRulesPrincipalTypeDefaultUser ListQuotaRulesPrincipalTypeEnum = "DEFAULT_USER"
ListQuotaRulesPrincipalTypeIndividualGroup ListQuotaRulesPrincipalTypeEnum = "INDIVIDUAL_GROUP"
ListQuotaRulesPrincipalTypeIndividualUser ListQuotaRulesPrincipalTypeEnum = "INDIVIDUAL_USER"
)
func GetListQuotaRulesPrincipalTypeEnumValues() []ListQuotaRulesPrincipalTypeEnum
GetListQuotaRulesPrincipalTypeEnumValues Enumerates the set of values for ListQuotaRulesPrincipalTypeEnum
func GetMappingListQuotaRulesPrincipalTypeEnum(val string) (ListQuotaRulesPrincipalTypeEnum, bool)
GetMappingListQuotaRulesPrincipalTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListQuotaRulesRequest wrapper for the ListQuotaRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListQuotaRules.go.html to see an example of how to use ListQuotaRulesRequest.
type ListQuotaRulesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// The type of the owner of this quota rule and usage.
PrincipalType ListQuotaRulesPrincipalTypeEnum `mandatory:"true" contributesTo:"query" name:"principalType" omitEmpty:"true"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 4096 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to
// identify a user or group to manage access control.
PrincipalId *int `mandatory:"false" contributesTo:"query" name:"principalId"`
// An option to display only the users or groups that violate their quota rules.
// If `areViolatorsOnly` is false, results report all the quota and usage.
// If `areViolatorsOnly` is true, results only report the quota and usage for
// the users or groups that violate their quota rules.
AreViolatorsOnly *bool `mandatory:"false" contributesTo:"query" name:"areViolatorsOnly"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListQuotaRulesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ListQuotaRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListQuotaRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListQuotaRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListQuotaRulesRequest) String() string
func (request ListQuotaRulesRequest) 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
ListQuotaRulesResponse wrapper for the ListQuotaRules operation
type ListQuotaRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []QuotaRuleSummary instances
Items []QuotaRuleSummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListQuotaRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListQuotaRulesResponse) String() string
ListQuotaRulesSortOrderEnum Enum with underlying type: string
type ListQuotaRulesSortOrderEnum string
Set of constants representing the allowable values for ListQuotaRulesSortOrderEnum
const (
ListQuotaRulesSortOrderAsc ListQuotaRulesSortOrderEnum = "ASC"
ListQuotaRulesSortOrderDesc ListQuotaRulesSortOrderEnum = "DESC"
)
func GetListQuotaRulesSortOrderEnumValues() []ListQuotaRulesSortOrderEnum
GetListQuotaRulesSortOrderEnumValues Enumerates the set of values for ListQuotaRulesSortOrderEnum
func GetMappingListQuotaRulesSortOrderEnum(val string) (ListQuotaRulesSortOrderEnum, bool)
GetMappingListQuotaRulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListReplicationTargetsLifecycleStateEnum Enum with underlying type: string
type ListReplicationTargetsLifecycleStateEnum string
Set of constants representing the allowable values for ListReplicationTargetsLifecycleStateEnum
const (
ListReplicationTargetsLifecycleStateCreating ListReplicationTargetsLifecycleStateEnum = "CREATING"
ListReplicationTargetsLifecycleStateActive ListReplicationTargetsLifecycleStateEnum = "ACTIVE"
ListReplicationTargetsLifecycleStateUpdating ListReplicationTargetsLifecycleStateEnum = "UPDATING"
ListReplicationTargetsLifecycleStateDeleting ListReplicationTargetsLifecycleStateEnum = "DELETING"
ListReplicationTargetsLifecycleStateDeleted ListReplicationTargetsLifecycleStateEnum = "DELETED"
ListReplicationTargetsLifecycleStateFailed ListReplicationTargetsLifecycleStateEnum = "FAILED"
)
func GetListReplicationTargetsLifecycleStateEnumValues() []ListReplicationTargetsLifecycleStateEnum
GetListReplicationTargetsLifecycleStateEnumValues Enumerates the set of values for ListReplicationTargetsLifecycleStateEnum
func GetMappingListReplicationTargetsLifecycleStateEnum(val string) (ListReplicationTargetsLifecycleStateEnum, bool)
GetMappingListReplicationTargetsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListReplicationTargetsRequest wrapper for the ListReplicationTargets operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListReplicationTargets.go.html to see an example of how to use ListReplicationTargetsRequest.
type ListReplicationTargetsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 4096 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Filter results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListReplicationTargetsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Example: `My resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter results by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
// the resouce type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The field to sort by. You can choose either value, but not both.
// By default, when you sort by `timeCreated`, results are shown
// in descending order. When you sort by `displayName`, results are
// shown in ascending order.
SortBy ListReplicationTargetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListReplicationTargetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ListReplicationTargetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListReplicationTargetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListReplicationTargetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListReplicationTargetsRequest) String() string
func (request ListReplicationTargetsRequest) 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
ListReplicationTargetsResponse wrapper for the ListReplicationTargets operation
type ListReplicationTargetsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ReplicationTargetSummary instances
Items []ReplicationTargetSummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListReplicationTargetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListReplicationTargetsResponse) String() string
ListReplicationTargetsSortByEnum Enum with underlying type: string
type ListReplicationTargetsSortByEnum string
Set of constants representing the allowable values for ListReplicationTargetsSortByEnum
const (
ListReplicationTargetsSortByTimecreated ListReplicationTargetsSortByEnum = "timeCreated"
ListReplicationTargetsSortByDisplayname ListReplicationTargetsSortByEnum = "displayName"
)
func GetListReplicationTargetsSortByEnumValues() []ListReplicationTargetsSortByEnum
GetListReplicationTargetsSortByEnumValues Enumerates the set of values for ListReplicationTargetsSortByEnum
func GetMappingListReplicationTargetsSortByEnum(val string) (ListReplicationTargetsSortByEnum, bool)
GetMappingListReplicationTargetsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListReplicationTargetsSortOrderEnum Enum with underlying type: string
type ListReplicationTargetsSortOrderEnum string
Set of constants representing the allowable values for ListReplicationTargetsSortOrderEnum
const (
ListReplicationTargetsSortOrderAsc ListReplicationTargetsSortOrderEnum = "ASC"
ListReplicationTargetsSortOrderDesc ListReplicationTargetsSortOrderEnum = "DESC"
)
func GetListReplicationTargetsSortOrderEnumValues() []ListReplicationTargetsSortOrderEnum
GetListReplicationTargetsSortOrderEnumValues Enumerates the set of values for ListReplicationTargetsSortOrderEnum
func GetMappingListReplicationTargetsSortOrderEnum(val string) (ListReplicationTargetsSortOrderEnum, bool)
GetMappingListReplicationTargetsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListReplicationsLifecycleStateEnum Enum with underlying type: string
type ListReplicationsLifecycleStateEnum string
Set of constants representing the allowable values for ListReplicationsLifecycleStateEnum
const (
ListReplicationsLifecycleStateCreating ListReplicationsLifecycleStateEnum = "CREATING"
ListReplicationsLifecycleStateActive ListReplicationsLifecycleStateEnum = "ACTIVE"
ListReplicationsLifecycleStateUpdating ListReplicationsLifecycleStateEnum = "UPDATING"
ListReplicationsLifecycleStateDeleting ListReplicationsLifecycleStateEnum = "DELETING"
ListReplicationsLifecycleStateDeleted ListReplicationsLifecycleStateEnum = "DELETED"
ListReplicationsLifecycleStateFailed ListReplicationsLifecycleStateEnum = "FAILED"
)
func GetListReplicationsLifecycleStateEnumValues() []ListReplicationsLifecycleStateEnum
GetListReplicationsLifecycleStateEnumValues Enumerates the set of values for ListReplicationsLifecycleStateEnum
func GetMappingListReplicationsLifecycleStateEnum(val string) (ListReplicationsLifecycleStateEnum, bool)
GetMappingListReplicationsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListReplicationsRequest wrapper for the ListReplications operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListReplications.go.html to see an example of how to use ListReplicationsRequest.
type ListReplicationsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 4096 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Filter results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListReplicationsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Example: `My resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter results by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
// the resouce type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The field to sort by. You can choose either value, but not both.
// By default, when you sort by time created, results are shown
// in descending order. When you sort by display name, results are
// shown in ascending order.
SortBy ListReplicationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListReplicationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source file system.
FileSystemId *string `mandatory:"false" contributesTo:"query" name:"fileSystemId"`
// 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 ListReplicationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListReplicationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListReplicationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListReplicationsRequest) String() string
func (request ListReplicationsRequest) 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
ListReplicationsResponse wrapper for the ListReplications operation
type ListReplicationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ReplicationSummary instances
Items []ReplicationSummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListReplicationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListReplicationsResponse) String() string
ListReplicationsSortByEnum Enum with underlying type: string
type ListReplicationsSortByEnum string
Set of constants representing the allowable values for ListReplicationsSortByEnum
const (
ListReplicationsSortByTimecreated ListReplicationsSortByEnum = "timeCreated"
ListReplicationsSortByDisplayname ListReplicationsSortByEnum = "displayName"
)
func GetListReplicationsSortByEnumValues() []ListReplicationsSortByEnum
GetListReplicationsSortByEnumValues Enumerates the set of values for ListReplicationsSortByEnum
func GetMappingListReplicationsSortByEnum(val string) (ListReplicationsSortByEnum, bool)
GetMappingListReplicationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListReplicationsSortOrderEnum Enum with underlying type: string
type ListReplicationsSortOrderEnum string
Set of constants representing the allowable values for ListReplicationsSortOrderEnum
const (
ListReplicationsSortOrderAsc ListReplicationsSortOrderEnum = "ASC"
ListReplicationsSortOrderDesc ListReplicationsSortOrderEnum = "DESC"
)
func GetListReplicationsSortOrderEnumValues() []ListReplicationsSortOrderEnum
GetListReplicationsSortOrderEnumValues Enumerates the set of values for ListReplicationsSortOrderEnum
func GetMappingListReplicationsSortOrderEnum(val string) (ListReplicationsSortOrderEnum, bool)
GetMappingListReplicationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSnapshotsLifecycleStateEnum Enum with underlying type: string
type ListSnapshotsLifecycleStateEnum string
Set of constants representing the allowable values for ListSnapshotsLifecycleStateEnum
const (
ListSnapshotsLifecycleStateCreating ListSnapshotsLifecycleStateEnum = "CREATING"
ListSnapshotsLifecycleStateActive ListSnapshotsLifecycleStateEnum = "ACTIVE"
ListSnapshotsLifecycleStateUpdating ListSnapshotsLifecycleStateEnum = "UPDATING"
ListSnapshotsLifecycleStateDeleting ListSnapshotsLifecycleStateEnum = "DELETING"
ListSnapshotsLifecycleStateDeleted ListSnapshotsLifecycleStateEnum = "DELETED"
ListSnapshotsLifecycleStateFailed ListSnapshotsLifecycleStateEnum = "FAILED"
)
func GetListSnapshotsLifecycleStateEnumValues() []ListSnapshotsLifecycleStateEnum
GetListSnapshotsLifecycleStateEnumValues Enumerates the set of values for ListSnapshotsLifecycleStateEnum
func GetMappingListSnapshotsLifecycleStateEnum(val string) (ListSnapshotsLifecycleStateEnum, bool)
GetMappingListSnapshotsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListSnapshotsRequest wrapper for the ListSnapshots operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ListSnapshots.go.html to see an example of how to use ListSnapshotsRequest.
type ListSnapshotsRequest struct {
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 100 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `100`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Filter results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListSnapshotsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Filter results by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
// the resouce type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy
// that is used to create the snapshots.
FilesystemSnapshotPolicyId *string `mandatory:"false" contributesTo:"query" name:"filesystemSnapshotPolicyId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"false" contributesTo:"query" name:"fileSystemId"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListSnapshotsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ListSnapshotsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSnapshotsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSnapshotsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSnapshotsRequest) String() string
func (request ListSnapshotsRequest) 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
ListSnapshotsResponse wrapper for the ListSnapshots operation
type ListSnapshotsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []SnapshotSummary instances
Items []SnapshotSummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListSnapshotsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSnapshotsResponse) String() string
ListSnapshotsSortOrderEnum Enum with underlying type: string
type ListSnapshotsSortOrderEnum string
Set of constants representing the allowable values for ListSnapshotsSortOrderEnum
const (
ListSnapshotsSortOrderAsc ListSnapshotsSortOrderEnum = "ASC"
ListSnapshotsSortOrderDesc ListSnapshotsSortOrderEnum = "DESC"
)
func GetListSnapshotsSortOrderEnumValues() []ListSnapshotsSortOrderEnum
GetListSnapshotsSortOrderEnumValues Enumerates the set of values for ListSnapshotsSortOrderEnum
func GetMappingListSnapshotsSortOrderEnum(val string) (ListSnapshotsSortOrderEnum, bool)
GetMappingListSnapshotsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
MountTarget Provides access to a collection of file systems through one or more VNICs on a specified subnet. The set of file systems is controlled through the referenced export set.
type MountTarget struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the mount target.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My mount target`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
Id *string `mandatory:"true" json:"id"`
// Additional information about the current 'lifecycleState'.
LifecycleDetails *string `mandatory:"true" json:"lifecycleDetails"`
// The current state of the mount target.
LifecycleState MountTargetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCIDs of the private IP addresses associated with this mount target.
PrivateIpIds []string `mandatory:"true" json:"privateIpIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the mount target is in.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The date and time the mount target was created, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The availability domain the mount target is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated export set. Controls what file
// systems will be exported through Network File System (NFS) protocol on this
// mount target.
ExportSetId *string `mandatory:"false" json:"exportSetId"`
// The method used to map a Unix UID to secondary groups. If NONE, the mount target will not use the Unix UID for ID mapping.
IdmapType MountTargetIdmapTypeEnum `mandatory:"false" json:"idmapType,omitempty"`
LdapIdmap *LdapIdmap `mandatory:"false" json:"ldapIdmap"`
// A list of Network Security Group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this mount target.
// A maximum of 5 is allowed.
// Setting this to an empty array after the list is created removes the mount target from all NSGs.
// For more information about NSGs, see Security Rules (https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm).
NsgIds []string `mandatory:"false" json:"nsgIds"`
Kerberos *Kerberos `mandatory:"false" json:"kerberos"`
// The date and time the mount target current billing cycle will end and next one starts, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeBillingCycleEnd *common.SDKTime `mandatory:"false" json:"timeBillingCycleEnd"`
// Current billed throughput for mount target in Gbps. This corresponds to shape of mount target.
// Available shapes and corresponding throughput are listed at Mount Target Performance (https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
ObservedThroughput *int64 `mandatory:"false" json:"observedThroughput"`
// - New throughput for mount target at the end of billing cycle in Gbps.
RequestedThroughput *int64 `mandatory:"false" json:"requestedThroughput"`
// - Reserved capacity (GB) associated with this mount target. Reserved capacity depends on observedThroughput value
// of mount target. Value is listed at Mount Target Performance (https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
ReservedStorageCapacity *int64 `mandatory:"false" json:"reservedStorageCapacity"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m MountTarget) String() string
func (m MountTarget) 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
MountTargetIdmapTypeEnum Enum with underlying type: string
type MountTargetIdmapTypeEnum string
Set of constants representing the allowable values for MountTargetIdmapTypeEnum
const (
MountTargetIdmapTypeLdap MountTargetIdmapTypeEnum = "LDAP"
MountTargetIdmapTypeNone MountTargetIdmapTypeEnum = "NONE"
)
func GetMappingMountTargetIdmapTypeEnum(val string) (MountTargetIdmapTypeEnum, bool)
GetMappingMountTargetIdmapTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMountTargetIdmapTypeEnumValues() []MountTargetIdmapTypeEnum
GetMountTargetIdmapTypeEnumValues Enumerates the set of values for MountTargetIdmapTypeEnum
MountTargetLifecycleStateEnum Enum with underlying type: string
type MountTargetLifecycleStateEnum string
Set of constants representing the allowable values for MountTargetLifecycleStateEnum
const (
MountTargetLifecycleStateCreating MountTargetLifecycleStateEnum = "CREATING"
MountTargetLifecycleStateActive MountTargetLifecycleStateEnum = "ACTIVE"
MountTargetLifecycleStateDeleting MountTargetLifecycleStateEnum = "DELETING"
MountTargetLifecycleStateDeleted MountTargetLifecycleStateEnum = "DELETED"
MountTargetLifecycleStateFailed MountTargetLifecycleStateEnum = "FAILED"
MountTargetLifecycleStateUpdating MountTargetLifecycleStateEnum = "UPDATING"
)
func GetMappingMountTargetLifecycleStateEnum(val string) (MountTargetLifecycleStateEnum, bool)
GetMappingMountTargetLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMountTargetLifecycleStateEnumValues() []MountTargetLifecycleStateEnum
GetMountTargetLifecycleStateEnumValues Enumerates the set of values for MountTargetLifecycleStateEnum
MountTargetSummary Summary information for the specified mount target.
type MountTargetSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the mount target.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My mount target`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
Id *string `mandatory:"true" json:"id"`
// The current state of the mount target.
LifecycleState MountTargetSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCIDs of the private IP addresses associated with this mount target.
PrivateIpIds []string `mandatory:"true" json:"privateIpIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the mount target is in.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The date and time the mount target was created, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The availability domain the mount target is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated export set. Controls what file
// systems will be exported using Network File System (NFS) protocol on
// this mount target.
ExportSetId *string `mandatory:"false" json:"exportSetId"`
// A list of Network Security Group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this mount target.
// A maximum of 5 is allowed.
// Setting this to an empty array after the list is created removes the mount target from all NSGs.
// For more information about NSGs, see Security Rules (https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm).
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The date and time the mount target current billing cycle will end, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Once a cycle ends, it is updated
// automatically to next timestamp which is after 30 days.
// Example: `2016-08-25T21:10:29.600Z`
TimeBillingCycleEnd *common.SDKTime `mandatory:"false" json:"timeBillingCycleEnd"`
// Current billed throughput for mount target in Gbps. This corresponds to shape of mount target.
// Available shapes and corresponding throughput are listed at Mount Target Performance (https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
ObservedThroughput *int64 `mandatory:"false" json:"observedThroughput"`
// - New throughput for mount target at the end of billing cycle in Gbps.
RequestedThroughput *int64 `mandatory:"false" json:"requestedThroughput"`
// - Reserved capacity (GB) associated with this mount target. Reserved capacity depends on observedThroughput value
// of mount target. Value is listed at Mount Target Performance (https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
ReservedStorageCapacity *int64 `mandatory:"false" json:"reservedStorageCapacity"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m MountTargetSummary) String() string
func (m MountTargetSummary) 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
MountTargetSummaryLifecycleStateEnum Enum with underlying type: string
type MountTargetSummaryLifecycleStateEnum string
Set of constants representing the allowable values for MountTargetSummaryLifecycleStateEnum
const (
MountTargetSummaryLifecycleStateCreating MountTargetSummaryLifecycleStateEnum = "CREATING"
MountTargetSummaryLifecycleStateActive MountTargetSummaryLifecycleStateEnum = "ACTIVE"
MountTargetSummaryLifecycleStateDeleting MountTargetSummaryLifecycleStateEnum = "DELETING"
MountTargetSummaryLifecycleStateDeleted MountTargetSummaryLifecycleStateEnum = "DELETED"
MountTargetSummaryLifecycleStateFailed MountTargetSummaryLifecycleStateEnum = "FAILED"
MountTargetSummaryLifecycleStateUpdating MountTargetSummaryLifecycleStateEnum = "UPDATING"
)
func GetMappingMountTargetSummaryLifecycleStateEnum(val string) (MountTargetSummaryLifecycleStateEnum, bool)
GetMappingMountTargetSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMountTargetSummaryLifecycleStateEnumValues() []MountTargetSummaryLifecycleStateEnum
GetMountTargetSummaryLifecycleStateEnumValues Enumerates the set of values for MountTargetSummaryLifecycleStateEnum
OutboundConnector Outbound connectors are used to help File Storage communicate with an external server, such as an LDAP server. An outbound connector contains all the information needed to connect, authenticate, and gain authorization to perform the account's required functions.
type OutboundConnector interface {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector.
GetCompartmentId() *string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector.
GetId() *string
// The current state of this outbound connector.
GetLifecycleState() OutboundConnectorLifecycleStateEnum
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My outbound connector`
GetDisplayName() *string
// The date and time the outbound connector was created
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
GetTimeCreated() *common.SDKTime
// The availability domain the outbound connector is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
GetAvailabilityDomain() *string
// Locks associated with this resource.
GetLocks() []ResourceLock
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
GetDefinedTags() map[string]map[string]interface{}
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
GetSystemTags() map[string]map[string]interface{}
}
OutboundConnectorConnectorTypeEnum Enum with underlying type: string
type OutboundConnectorConnectorTypeEnum string
Set of constants representing the allowable values for OutboundConnectorConnectorTypeEnum
const (
OutboundConnectorConnectorTypeLdapbind OutboundConnectorConnectorTypeEnum = "LDAPBIND"
)
func GetMappingOutboundConnectorConnectorTypeEnum(val string) (OutboundConnectorConnectorTypeEnum, bool)
GetMappingOutboundConnectorConnectorTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOutboundConnectorConnectorTypeEnumValues() []OutboundConnectorConnectorTypeEnum
GetOutboundConnectorConnectorTypeEnumValues Enumerates the set of values for OutboundConnectorConnectorTypeEnum
OutboundConnectorLifecycleStateEnum Enum with underlying type: string
type OutboundConnectorLifecycleStateEnum string
Set of constants representing the allowable values for OutboundConnectorLifecycleStateEnum
const (
OutboundConnectorLifecycleStateCreating OutboundConnectorLifecycleStateEnum = "CREATING"
OutboundConnectorLifecycleStateActive OutboundConnectorLifecycleStateEnum = "ACTIVE"
OutboundConnectorLifecycleStateDeleting OutboundConnectorLifecycleStateEnum = "DELETING"
OutboundConnectorLifecycleStateDeleted OutboundConnectorLifecycleStateEnum = "DELETED"
)
func GetMappingOutboundConnectorLifecycleStateEnum(val string) (OutboundConnectorLifecycleStateEnum, bool)
GetMappingOutboundConnectorLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOutboundConnectorLifecycleStateEnumValues() []OutboundConnectorLifecycleStateEnum
GetOutboundConnectorLifecycleStateEnumValues Enumerates the set of values for OutboundConnectorLifecycleStateEnum
OutboundConnectorSummary Summary information for an outbound connector.
type OutboundConnectorSummary interface {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector.
GetCompartmentId() *string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector.
GetId() *string
// The current state of this outbound connector.
GetLifecycleState() OutboundConnectorSummaryLifecycleStateEnum
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My outbound connector`
GetDisplayName() *string
// The date and time the outbound connector was created
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
GetTimeCreated() *common.SDKTime
// The availability domain the outbound connector is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
GetAvailabilityDomain() *string
// Locks associated with this resource.
GetLocks() []ResourceLock
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
GetDefinedTags() map[string]map[string]interface{}
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
GetSystemTags() map[string]map[string]interface{}
}
OutboundConnectorSummaryLifecycleStateEnum Enum with underlying type: string
type OutboundConnectorSummaryLifecycleStateEnum string
Set of constants representing the allowable values for OutboundConnectorSummaryLifecycleStateEnum
const (
OutboundConnectorSummaryLifecycleStateCreating OutboundConnectorSummaryLifecycleStateEnum = "CREATING"
OutboundConnectorSummaryLifecycleStateActive OutboundConnectorSummaryLifecycleStateEnum = "ACTIVE"
OutboundConnectorSummaryLifecycleStateDeleting OutboundConnectorSummaryLifecycleStateEnum = "DELETING"
OutboundConnectorSummaryLifecycleStateDeleted OutboundConnectorSummaryLifecycleStateEnum = "DELETED"
)
func GetMappingOutboundConnectorSummaryLifecycleStateEnum(val string) (OutboundConnectorSummaryLifecycleStateEnum, bool)
GetMappingOutboundConnectorSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOutboundConnectorSummaryLifecycleStateEnumValues() []OutboundConnectorSummaryLifecycleStateEnum
GetOutboundConnectorSummaryLifecycleStateEnumValues Enumerates the set of values for OutboundConnectorSummaryLifecycleStateEnum
PauseFilesystemSnapshotPolicyRequest wrapper for the PauseFilesystemSnapshotPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/PauseFilesystemSnapshotPolicy.go.html to see an example of how to use PauseFilesystemSnapshotPolicyRequest.
type PauseFilesystemSnapshotPolicyRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
FilesystemSnapshotPolicyId *string `mandatory:"true" contributesTo:"path" name:"filesystemSnapshotPolicyId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 PauseFilesystemSnapshotPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PauseFilesystemSnapshotPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PauseFilesystemSnapshotPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PauseFilesystemSnapshotPolicyRequest) String() string
func (request PauseFilesystemSnapshotPolicyRequest) 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
PauseFilesystemSnapshotPolicyResponse wrapper for the PauseFilesystemSnapshotPolicy operation
type PauseFilesystemSnapshotPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The FilesystemSnapshotPolicy instance
FilesystemSnapshotPolicy `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 PauseFilesystemSnapshotPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PauseFilesystemSnapshotPolicyResponse) String() string
QuotaRule A rule that can restrict the logical space that a user or group can consume in a file system.
type QuotaRule struct {
// The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file System.
FileSystemId *string `mandatory:"true" json:"fileSystemId"`
// Whether the quota rule will be enforced.
// If `isHardQuota` is true, the quota rule is enforced so that the write is blocked if usage
// exceeds the hard quota limit.
// If `isHardQuota` is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated.
IsHardQuota *bool `mandatory:"true" json:"isHardQuota"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `UserXYZ's quota`
DisplayName *string `mandatory:"true" json:"displayName"`
// The value of the quota rule in gigabytes.
QuotaLimitInGigabytes *int `mandatory:"true" json:"quotaLimitInGigabytes"`
// The date and time the quota rule was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the quota rule was last updated, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The type of the owner of this quota rule and usage.
PrincipalType QuotaRulePrincipalTypeEnum `mandatory:"false" json:"principalType,omitempty"`
// An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to
// identify a user or group to manage access control.
PrincipalId *int `mandatory:"false" json:"principalId"`
}
func (m QuotaRule) String() string
func (m QuotaRule) 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
QuotaRulePrincipalTypeEnum Enum with underlying type: string
type QuotaRulePrincipalTypeEnum string
Set of constants representing the allowable values for QuotaRulePrincipalTypeEnum
const (
QuotaRulePrincipalTypeFileSystemLevel QuotaRulePrincipalTypeEnum = "FILE_SYSTEM_LEVEL"
QuotaRulePrincipalTypeDefaultGroup QuotaRulePrincipalTypeEnum = "DEFAULT_GROUP"
QuotaRulePrincipalTypeDefaultUser QuotaRulePrincipalTypeEnum = "DEFAULT_USER"
QuotaRulePrincipalTypeIndividualGroup QuotaRulePrincipalTypeEnum = "INDIVIDUAL_GROUP"
QuotaRulePrincipalTypeIndividualUser QuotaRulePrincipalTypeEnum = "INDIVIDUAL_USER"
)
func GetMappingQuotaRulePrincipalTypeEnum(val string) (QuotaRulePrincipalTypeEnum, bool)
GetMappingQuotaRulePrincipalTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQuotaRulePrincipalTypeEnumValues() []QuotaRulePrincipalTypeEnum
GetQuotaRulePrincipalTypeEnumValues Enumerates the set of values for QuotaRulePrincipalTypeEnum
QuotaRuleSummary Summary information for a principal's usage and quota rule.
type QuotaRuleSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" json:"fileSystemId"`
// The type of the owner of this quota rule and usage.
PrincipalType QuotaRuleSummaryPrincipalTypeEnum `mandatory:"true" json:"principalType"`
// An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to
// identify a user or group to manage access control.
PrincipalId *int `mandatory:"true" json:"principalId"`
// The usage value corresponding to this principal in bytes.
UsageInBytes *int64 `mandatory:"true" json:"usageInBytes"`
// The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
Id *string `mandatory:"false" json:"id"`
// Whether the quota rule will be enforced.
// If `isHardQuota` is true, the quota rule is enforced so that the write is blocked if usage
// exceeds the hard quota limit.
// If `isHardQuota` is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated.
IsHardQuota *bool `mandatory:"false" json:"isHardQuota"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `UserXYZ's quota`
DisplayName *string `mandatory:"false" json:"displayName"`
// The value of the quota rule in gigabytes.
QuotaLimitInGigabytes *int `mandatory:"false" json:"quotaLimitInGigabytes"`
// The date and time the quota rule was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the quota rule was last updated, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// An option to display only the users or groups that violate their quota rules.
// If `areViolatorsOnly` is false, results report all the quota and usage.
// If `areViolatorsOnly` is true, results only report the quota and usage for
// the users or groups that violate their quota rules.
AreViolatorsOnly *bool `mandatory:"false" json:"areViolatorsOnly"`
}
func (m QuotaRuleSummary) String() string
func (m QuotaRuleSummary) 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
QuotaRuleSummaryPrincipalTypeEnum Enum with underlying type: string
type QuotaRuleSummaryPrincipalTypeEnum string
Set of constants representing the allowable values for QuotaRuleSummaryPrincipalTypeEnum
const (
QuotaRuleSummaryPrincipalTypeFileSystemLevel QuotaRuleSummaryPrincipalTypeEnum = "FILE_SYSTEM_LEVEL"
QuotaRuleSummaryPrincipalTypeDefaultGroup QuotaRuleSummaryPrincipalTypeEnum = "DEFAULT_GROUP"
QuotaRuleSummaryPrincipalTypeDefaultUser QuotaRuleSummaryPrincipalTypeEnum = "DEFAULT_USER"
QuotaRuleSummaryPrincipalTypeIndividualGroup QuotaRuleSummaryPrincipalTypeEnum = "INDIVIDUAL_GROUP"
QuotaRuleSummaryPrincipalTypeIndividualUser QuotaRuleSummaryPrincipalTypeEnum = "INDIVIDUAL_USER"
)
func GetMappingQuotaRuleSummaryPrincipalTypeEnum(val string) (QuotaRuleSummaryPrincipalTypeEnum, bool)
GetMappingQuotaRuleSummaryPrincipalTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQuotaRuleSummaryPrincipalTypeEnumValues() []QuotaRuleSummaryPrincipalTypeEnum
GetQuotaRuleSummaryPrincipalTypeEnumValues Enumerates the set of values for QuotaRuleSummaryPrincipalTypeEnum
RemoveExportLockRequest wrapper for the RemoveExportLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveExportLock.go.html to see an example of how to use RemoveExportLockRequest.
type RemoveExportLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export.
ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"`
// The details to be updated for the RemoveLock.
RemoveExportLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 RemoveExportLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveExportLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveExportLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveExportLockRequest) String() string
func (request RemoveExportLockRequest) 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
RemoveExportLockResponse wrapper for the RemoveExportLock operation
type RemoveExportLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Export instance
Export `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 RemoveExportLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveExportLockResponse) String() string
RemoveFileSystemLockRequest wrapper for the RemoveFileSystemLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveFileSystemLock.go.html to see an example of how to use RemoveFileSystemLockRequest.
type RemoveFileSystemLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// The details to be updated for the RemoveLock.
RemoveFileSystemLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 RemoveFileSystemLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveFileSystemLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveFileSystemLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveFileSystemLockRequest) String() string
func (request RemoveFileSystemLockRequest) 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
RemoveFileSystemLockResponse wrapper for the RemoveFileSystemLock operation
type RemoveFileSystemLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The FileSystem instance
FileSystem `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 RemoveFileSystemLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveFileSystemLockResponse) String() string
RemoveFilesystemSnapshotPolicyLockRequest wrapper for the RemoveFilesystemSnapshotPolicyLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveFilesystemSnapshotPolicyLock.go.html to see an example of how to use RemoveFilesystemSnapshotPolicyLockRequest.
type RemoveFilesystemSnapshotPolicyLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
FilesystemSnapshotPolicyId *string `mandatory:"true" contributesTo:"path" name:"filesystemSnapshotPolicyId"`
// The details to be updated for the RemoveLock.
RemoveFilesystemSnapshotPolicyLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 RemoveFilesystemSnapshotPolicyLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveFilesystemSnapshotPolicyLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveFilesystemSnapshotPolicyLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveFilesystemSnapshotPolicyLockRequest) String() string
func (request RemoveFilesystemSnapshotPolicyLockRequest) 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
RemoveFilesystemSnapshotPolicyLockResponse wrapper for the RemoveFilesystemSnapshotPolicyLock operation
type RemoveFilesystemSnapshotPolicyLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The FilesystemSnapshotPolicy instance
FilesystemSnapshotPolicy `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 RemoveFilesystemSnapshotPolicyLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveFilesystemSnapshotPolicyLockResponse) String() string
RemoveMountTargetLockRequest wrapper for the RemoveMountTargetLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveMountTargetLock.go.html to see an example of how to use RemoveMountTargetLockRequest.
type RemoveMountTargetLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`
// The details to be updated for the RemoveLock.
RemoveMountTargetLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 RemoveMountTargetLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveMountTargetLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveMountTargetLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveMountTargetLockRequest) String() string
func (request RemoveMountTargetLockRequest) 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
RemoveMountTargetLockResponse wrapper for the RemoveMountTargetLock operation
type RemoveMountTargetLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The MountTarget instance
MountTarget `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 RemoveMountTargetLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveMountTargetLockResponse) String() string
RemoveOutboundConnectorLockRequest wrapper for the RemoveOutboundConnectorLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveOutboundConnectorLock.go.html to see an example of how to use RemoveOutboundConnectorLockRequest.
type RemoveOutboundConnectorLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector.
OutboundConnectorId *string `mandatory:"true" contributesTo:"path" name:"outboundConnectorId"`
// The details to be updated for the RemoveLock.
RemoveOutboundConnectorLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 RemoveOutboundConnectorLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveOutboundConnectorLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveOutboundConnectorLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveOutboundConnectorLockRequest) String() string
func (request RemoveOutboundConnectorLockRequest) 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
RemoveOutboundConnectorLockResponse wrapper for the RemoveOutboundConnectorLock operation
type RemoveOutboundConnectorLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The OutboundConnector instance
OutboundConnector `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 RemoveOutboundConnectorLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveOutboundConnectorLockResponse) String() string
RemoveReplicationLockRequest wrapper for the RemoveReplicationLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveReplicationLock.go.html to see an example of how to use RemoveReplicationLockRequest.
type RemoveReplicationLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication.
ReplicationId *string `mandatory:"true" contributesTo:"path" name:"replicationId"`
// The details to be updated for the RemoveLock.
RemoveReplicationLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 RemoveReplicationLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveReplicationLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveReplicationLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveReplicationLockRequest) String() string
func (request RemoveReplicationLockRequest) 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
RemoveReplicationLockResponse wrapper for the RemoveReplicationLock operation
type RemoveReplicationLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Replication instance
Replication `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 RemoveReplicationLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveReplicationLockResponse) String() string
RemoveSnapshotLockRequest wrapper for the RemoveSnapshotLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/RemoveSnapshotLock.go.html to see an example of how to use RemoveSnapshotLockRequest.
type RemoveSnapshotLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot.
SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`
// The details to be updated for the RemoveLock.
RemoveSnapshotLockDetails ResourceLock `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 RemoveSnapshotLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveSnapshotLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveSnapshotLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveSnapshotLockRequest) String() string
func (request RemoveSnapshotLockRequest) 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
RemoveSnapshotLockResponse wrapper for the RemoveSnapshotLock operation
type RemoveSnapshotLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Snapshot instance
Snapshot `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 RemoveSnapshotLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveSnapshotLockResponse) String() string
Replication Replications are the primary resource that governs the policy of cross-region replication between source and target file systems. Replications are associated with a secondary resource called a ReplicationTarget located in another availability domain in the same or different region. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated `ReplicationTarget`, which applies it to the target file system. For more information, see File System Replication (https://docs.oracle.com/iaas/Content/File/Tasks/FSreplication.htm).
type Replication struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication.
Id *string `mandatory:"true" json:"id"`
// The current lifecycle state of the replication.
LifecycleState ReplicationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My replication`
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time the replication was created
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2021-01-04T20:01:29.100Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source file system.
SourceId *string `mandatory:"true" json:"sourceId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target file system.
TargetId *string `mandatory:"true" json:"targetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ReplicationTarget.
ReplicationTargetId *string `mandatory:"true" json:"replicationTargetId"`
// The availability domain that contains the replication. May be unset as a blank or `NULL` value.
// Example: `Uocm:PHX-AD-2`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Duration in minutes between replication snapshots.
ReplicationInterval *int64 `mandatory:"false" json:"replicationInterval"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last snapshot that has been replicated completely.
// Empty if the copy of the initial snapshot is not complete.
LastSnapshotId *string `mandatory:"false" json:"lastSnapshotId"`
// The snapshotTime of the most recent recoverable replication snapshot
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2021-04-04T20:01:29.100Z`
RecoveryPointTime *common.SDKTime `mandatory:"false" json:"recoveryPointTime"`
// The current state of the snapshot during replication operations.
DeltaStatus ReplicationDeltaStatusEnum `mandatory:"false" json:"deltaStatus,omitempty"`
// Additional information about the current 'lifecycleState'.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Percentage progress of the current replication cycle.
DeltaProgress *int64 `mandatory:"false" json:"deltaProgress"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Replication) String() string
func (m Replication) 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
ReplicationDeltaStatusEnum Enum with underlying type: string
type ReplicationDeltaStatusEnum string
Set of constants representing the allowable values for ReplicationDeltaStatusEnum
const (
ReplicationDeltaStatusIdle ReplicationDeltaStatusEnum = "IDLE"
ReplicationDeltaStatusCapturing ReplicationDeltaStatusEnum = "CAPTURING"
ReplicationDeltaStatusApplying ReplicationDeltaStatusEnum = "APPLYING"
ReplicationDeltaStatusServiceError ReplicationDeltaStatusEnum = "SERVICE_ERROR"
ReplicationDeltaStatusUserError ReplicationDeltaStatusEnum = "USER_ERROR"
ReplicationDeltaStatusFailed ReplicationDeltaStatusEnum = "FAILED"
ReplicationDeltaStatusTransferring ReplicationDeltaStatusEnum = "TRANSFERRING"
)
func GetMappingReplicationDeltaStatusEnum(val string) (ReplicationDeltaStatusEnum, bool)
GetMappingReplicationDeltaStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicationDeltaStatusEnumValues() []ReplicationDeltaStatusEnum
GetReplicationDeltaStatusEnumValues Enumerates the set of values for ReplicationDeltaStatusEnum
ReplicationEstimate Details for response from replication estimation.
type ReplicationEstimate struct {
// The rate of change on source filesystem which was used to provide the estimate in MegaBytes per second.
ChangeRateInMBps *int `mandatory:"true" json:"changeRateInMBps"`
// Specifies whether replication can be enabled on the file system.
IsReplicationSupported *bool `mandatory:"true" json:"isReplicationSupported"`
// The minimum supported replication interval for specified file system in minutes.
MinimumSupportedIntervalInMinutes *int `mandatory:"true" json:"minimumSupportedIntervalInMinutes"`
// The approximate time required for the base sync between source and target to finish.
EstimatedBaseCopyTimeInMinutes *int `mandatory:"true" json:"estimatedBaseCopyTimeInMinutes"`
// Array of allowed target region names which can be paired with source file system.
AllowedTargetRegions []string `mandatory:"true" json:"allowedTargetRegions"`
}
func (m ReplicationEstimate) String() string
func (m ReplicationEstimate) 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
ReplicationLifecycleStateEnum Enum with underlying type: string
type ReplicationLifecycleStateEnum string
Set of constants representing the allowable values for ReplicationLifecycleStateEnum
const (
ReplicationLifecycleStateCreating ReplicationLifecycleStateEnum = "CREATING"
ReplicationLifecycleStateActive ReplicationLifecycleStateEnum = "ACTIVE"
ReplicationLifecycleStateDeleting ReplicationLifecycleStateEnum = "DELETING"
ReplicationLifecycleStateDeleted ReplicationLifecycleStateEnum = "DELETED"
ReplicationLifecycleStateFailed ReplicationLifecycleStateEnum = "FAILED"
)
func GetMappingReplicationLifecycleStateEnum(val string) (ReplicationLifecycleStateEnum, bool)
GetMappingReplicationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicationLifecycleStateEnumValues() []ReplicationLifecycleStateEnum
GetReplicationLifecycleStateEnumValues Enumerates the set of values for ReplicationLifecycleStateEnum
ReplicationSummary Summary information for a replication.
type ReplicationSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication.
Id *string `mandatory:"true" json:"id"`
// The current state of this replication.
// This resource can be in a `FAILED` state if replication target is deleted instead of the replication resource.
LifecycleState ReplicationSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My replication`
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time the replication was created
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2020-02-04T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The availability domain the replication is in. The replication must be in the same availability domain as the source file system.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Duration in minutes between replication snapshots.
ReplicationInterval *int64 `mandatory:"false" json:"replicationInterval"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Additional information about the current `lifecycleState`.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The `snapshotTime` of the most recent recoverable replication snapshot
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2021-04-04T20:01:29.100Z`
RecoveryPointTime *common.SDKTime `mandatory:"false" json:"recoveryPointTime"`
}
func (m ReplicationSummary) String() string
func (m ReplicationSummary) 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
ReplicationSummaryLifecycleStateEnum Enum with underlying type: string
type ReplicationSummaryLifecycleStateEnum string
Set of constants representing the allowable values for ReplicationSummaryLifecycleStateEnum
const (
ReplicationSummaryLifecycleStateCreating ReplicationSummaryLifecycleStateEnum = "CREATING"
ReplicationSummaryLifecycleStateActive ReplicationSummaryLifecycleStateEnum = "ACTIVE"
ReplicationSummaryLifecycleStateDeleting ReplicationSummaryLifecycleStateEnum = "DELETING"
ReplicationSummaryLifecycleStateDeleted ReplicationSummaryLifecycleStateEnum = "DELETED"
ReplicationSummaryLifecycleStateFailed ReplicationSummaryLifecycleStateEnum = "FAILED"
)
func GetMappingReplicationSummaryLifecycleStateEnum(val string) (ReplicationSummaryLifecycleStateEnum, bool)
GetMappingReplicationSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicationSummaryLifecycleStateEnumValues() []ReplicationSummaryLifecycleStateEnum
GetReplicationSummaryLifecycleStateEnumValues Enumerates the set of values for ReplicationSummaryLifecycleStateEnum
ReplicationTarget Replication targets are associated with a primary resource called a Replication located in another availability domain in the same or different region. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated `ReplicationTarget`, which applies it to the target file system. All operations (except `DELETE`) must be done using the associated replication resource. Deleting a `ReplicationTarget` allows the target file system to be exported. Deleting a `ReplicationTarget` does not delete the associated `Replication` resource, but places it in a `FAILED` state. For more information, see File System Replication (https://docs.oracle.com/iaas/Content/File/Tasks/FSreplication.htm).
type ReplicationTarget struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication.
Id *string `mandatory:"true" json:"id"`
// The current state of this replication.
LifecycleState ReplicationTargetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. This name is same as the replication display name for the associated resource.
// Example: `My Replication`
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time the replication target was created in target region.
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2021-01-04T20:01:29.100Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of source filesystem.
SourceId *string `mandatory:"true" json:"sourceId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of target filesystem.
TargetId *string `mandatory:"true" json:"targetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of replication.
ReplicationId *string `mandatory:"true" json:"replicationId"`
// The availability domain the replication resource is in. May be unset
// as a blank or NULL value.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last snapshot snapshot which was completely applied to the target file system.
// Empty while the initial snapshot is being applied.
LastSnapshotId *string `mandatory:"false" json:"lastSnapshotId"`
// The snapshotTime of the most recent recoverable replication snapshot
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2021-04-04T20:01:29.100Z`
RecoveryPointTime *common.SDKTime `mandatory:"false" json:"recoveryPointTime"`
// The current state of the snapshot during replication operations.
DeltaStatus ReplicationTargetDeltaStatusEnum `mandatory:"false" json:"deltaStatus,omitempty"`
// Percentage progress of the current replication cycle.
DeltaProgress *int64 `mandatory:"false" json:"deltaProgress"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Additional information about the current `lifecycleState`.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m ReplicationTarget) String() string
func (m ReplicationTarget) 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
ReplicationTargetDeltaStatusEnum Enum with underlying type: string
type ReplicationTargetDeltaStatusEnum string
Set of constants representing the allowable values for ReplicationTargetDeltaStatusEnum
const (
ReplicationTargetDeltaStatusIdle ReplicationTargetDeltaStatusEnum = "IDLE"
ReplicationTargetDeltaStatusCapturing ReplicationTargetDeltaStatusEnum = "CAPTURING"
ReplicationTargetDeltaStatusApplying ReplicationTargetDeltaStatusEnum = "APPLYING"
ReplicationTargetDeltaStatusServiceError ReplicationTargetDeltaStatusEnum = "SERVICE_ERROR"
ReplicationTargetDeltaStatusUserError ReplicationTargetDeltaStatusEnum = "USER_ERROR"
ReplicationTargetDeltaStatusFailed ReplicationTargetDeltaStatusEnum = "FAILED"
ReplicationTargetDeltaStatusTransferring ReplicationTargetDeltaStatusEnum = "TRANSFERRING"
)
func GetMappingReplicationTargetDeltaStatusEnum(val string) (ReplicationTargetDeltaStatusEnum, bool)
GetMappingReplicationTargetDeltaStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicationTargetDeltaStatusEnumValues() []ReplicationTargetDeltaStatusEnum
GetReplicationTargetDeltaStatusEnumValues Enumerates the set of values for ReplicationTargetDeltaStatusEnum
ReplicationTargetLifecycleStateEnum Enum with underlying type: string
type ReplicationTargetLifecycleStateEnum string
Set of constants representing the allowable values for ReplicationTargetLifecycleStateEnum
const (
ReplicationTargetLifecycleStateCreating ReplicationTargetLifecycleStateEnum = "CREATING"
ReplicationTargetLifecycleStateActive ReplicationTargetLifecycleStateEnum = "ACTIVE"
ReplicationTargetLifecycleStateDeleting ReplicationTargetLifecycleStateEnum = "DELETING"
ReplicationTargetLifecycleStateDeleted ReplicationTargetLifecycleStateEnum = "DELETED"
ReplicationTargetLifecycleStateFailed ReplicationTargetLifecycleStateEnum = "FAILED"
)
func GetMappingReplicationTargetLifecycleStateEnum(val string) (ReplicationTargetLifecycleStateEnum, bool)
GetMappingReplicationTargetLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicationTargetLifecycleStateEnumValues() []ReplicationTargetLifecycleStateEnum
GetReplicationTargetLifecycleStateEnumValues Enumerates the set of values for ReplicationTargetLifecycleStateEnum
ReplicationTargetSummary Summary information for replication target.
type ReplicationTargetSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication target.
Id *string `mandatory:"true" json:"id"`
// The current state of this replication.
LifecycleState ReplicationTargetSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. This name is the same as the associated replication name.
// Example: `My replication`
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time the replication was created
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2021-02-02T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The availability domain the replication target is in. Must be in the same availability domain as the target file system.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Additional information about the current 'lifecycleState'.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The snapshotTime of the most recent recoverable replication snapshot
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2021-04-04T20:01:29.100Z`
RecoveryPointTime *common.SDKTime `mandatory:"false" json:"recoveryPointTime"`
}
func (m ReplicationTargetSummary) String() string
func (m ReplicationTargetSummary) 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
ReplicationTargetSummaryLifecycleStateEnum Enum with underlying type: string
type ReplicationTargetSummaryLifecycleStateEnum string
Set of constants representing the allowable values for ReplicationTargetSummaryLifecycleStateEnum
const (
ReplicationTargetSummaryLifecycleStateCreating ReplicationTargetSummaryLifecycleStateEnum = "CREATING"
ReplicationTargetSummaryLifecycleStateActive ReplicationTargetSummaryLifecycleStateEnum = "ACTIVE"
ReplicationTargetSummaryLifecycleStateDeleting ReplicationTargetSummaryLifecycleStateEnum = "DELETING"
ReplicationTargetSummaryLifecycleStateDeleted ReplicationTargetSummaryLifecycleStateEnum = "DELETED"
ReplicationTargetSummaryLifecycleStateFailed ReplicationTargetSummaryLifecycleStateEnum = "FAILED"
)
func GetMappingReplicationTargetSummaryLifecycleStateEnum(val string) (ReplicationTargetSummaryLifecycleStateEnum, bool)
GetMappingReplicationTargetSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicationTargetSummaryLifecycleStateEnumValues() []ReplicationTargetSummaryLifecycleStateEnum
GetReplicationTargetSummaryLifecycleStateEnumValues Enumerates the set of values for ReplicationTargetSummaryLifecycleStateEnum
ResourceLock Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.
type ResourceLock struct {
// Type of the lock.
Type ResourceLockTypeEnum `mandatory:"true" json:"type"`
// The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`
// A message added by the creator of the lock. This is typically used to give an
// indication of why the resource is locked.
Message *string `mandatory:"false" json:"message"`
// When the lock was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m ResourceLock) String() string
func (m ResourceLock) 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
ResourceLockTypeEnum Enum with underlying type: string
type ResourceLockTypeEnum string
Set of constants representing the allowable values for ResourceLockTypeEnum
const (
ResourceLockTypeFull ResourceLockTypeEnum = "FULL"
ResourceLockTypeDelete ResourceLockTypeEnum = "DELETE"
)
func GetMappingResourceLockTypeEnum(val string) (ResourceLockTypeEnum, bool)
GetMappingResourceLockTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResourceLockTypeEnumValues() []ResourceLockTypeEnum
GetResourceLockTypeEnumValues Enumerates the set of values for ResourceLockTypeEnum
ScheduleDowngradeShapeMountTargetDetails Shape details about the Mount Target.
type ScheduleDowngradeShapeMountTargetDetails struct {
// New throughput for mount target in Gbps. Available shapes and corresponding throughput are listed at
// Mount Target Performance (https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
RequestedThroughput *int64 `mandatory:"false" json:"requestedThroughput"`
}
func (m ScheduleDowngradeShapeMountTargetDetails) String() string
func (m ScheduleDowngradeShapeMountTargetDetails) 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
ScheduleDowngradeShapeMountTargetRequest wrapper for the ScheduleDowngradeShapeMountTarget operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ScheduleDowngradeShapeMountTarget.go.html to see an example of how to use ScheduleDowngradeShapeMountTargetRequest.
type ScheduleDowngradeShapeMountTargetRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`
// Details for changing the shape of mount target.
ScheduleDowngradeShapeMountTargetDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ScheduleDowngradeShapeMountTargetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ScheduleDowngradeShapeMountTargetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ScheduleDowngradeShapeMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ScheduleDowngradeShapeMountTargetRequest) String() string
func (request ScheduleDowngradeShapeMountTargetRequest) 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
ScheduleDowngradeShapeMountTargetResponse wrapper for the ScheduleDowngradeShapeMountTarget operation
type ScheduleDowngradeShapeMountTargetResponse struct {
// The underlying http response
RawResponse *http.Response
// The MountTarget instance
MountTarget `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 ScheduleDowngradeShapeMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ScheduleDowngradeShapeMountTargetResponse) String() string
Snapshot A point-in-time snapshot of a specified file system.
type Snapshot struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system from which the snapshot
// was created.
FileSystemId *string `mandatory:"true" json:"fileSystemId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot.
Id *string `mandatory:"true" json:"id"`
// The current state of the snapshot.
LifecycleState SnapshotLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Name of the snapshot. This value is immutable.
// Avoid entering confidential information.
// Example: `Sunday`
Name *string `mandatory:"true" json:"name"`
// The date and time the snapshot was created, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Specifies generation type of the snapshot.
SnapshotType SnapshotSnapshotTypeEnum `mandatory:"false" json:"snapshotType,omitempty"`
// The date and time the snapshot was taken, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// This value might be the same or different from `timeCreated` depending
// on the following factors:
// - If the snapshot is created in the original file system directory.
// - If the snapshot is cloned from a file system.
// - If the snapshot is replicated from a file system.
// Example: `2020-08-25T21:10:29.600Z`
SnapshotTime *common.SDKTime `mandatory:"false" json:"snapshotTime"`
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) identifying the parent from which this snapshot was cloned.
// If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value.
// If this snapshot was cloned, then the `provenanceId` value is the parent's `provenanceId`.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
ProvenanceId *string `mandatory:"false" json:"provenanceId"`
// Specifies whether the snapshot has been cloned.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
IsCloneSource *bool `mandatory:"false" json:"isCloneSource"`
// Additional information about the current `lifecycleState`.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The time when this snapshot will be deleted.
ExpirationTime *common.SDKTime `mandatory:"false" json:"expirationTime"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy that created this snapshot.
FilesystemSnapshotPolicyId *string `mandatory:"false" json:"filesystemSnapshotPolicyId"`
}
func (m Snapshot) String() string
func (m Snapshot) 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
SnapshotLifecycleStateEnum Enum with underlying type: string
type SnapshotLifecycleStateEnum string
Set of constants representing the allowable values for SnapshotLifecycleStateEnum
const (
SnapshotLifecycleStateCreating SnapshotLifecycleStateEnum = "CREATING"
SnapshotLifecycleStateActive SnapshotLifecycleStateEnum = "ACTIVE"
SnapshotLifecycleStateDeleting SnapshotLifecycleStateEnum = "DELETING"
SnapshotLifecycleStateDeleted SnapshotLifecycleStateEnum = "DELETED"
)
func GetMappingSnapshotLifecycleStateEnum(val string) (SnapshotLifecycleStateEnum, bool)
GetMappingSnapshotLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnapshotLifecycleStateEnumValues() []SnapshotLifecycleStateEnum
GetSnapshotLifecycleStateEnumValues Enumerates the set of values for SnapshotLifecycleStateEnum
SnapshotSchedule The snapshot schedule is a structure within a parent file system snapshot policy. It contains data about the frequency of snapshot creation and the retention time of the taken snapshots.
type SnapshotSchedule struct {
// The frequency of scheduled snapshots.
Period SnapshotSchedulePeriodEnum `mandatory:"true" json:"period"`
// Time zone used for scheduling the snapshot.
TimeZone SnapshotScheduleTimeZoneEnum `mandatory:"true" json:"timeZone"`
// A name prefix to be applied to snapshots created by this schedule.
// Example: `compliance1`
SchedulePrefix *string `mandatory:"false" json:"schedulePrefix"`
// The starting point used to begin the scheduling of the snapshots based upon recurrence string
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// If no `timeScheduleStart` is provided, the value will be set to the time when the schedule was created.
TimeScheduleStart *common.SDKTime `mandatory:"false" json:"timeScheduleStart"`
// The number of seconds to retain snapshots created with this schedule.
// Snapshot expiration time will not be set if this value is empty.
RetentionDurationInSeconds *int64 `mandatory:"false" json:"retentionDurationInSeconds"`
// The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot.
// If not set, the system chooses a value at creation time.
HourOfDay *int `mandatory:"false" json:"hourOfDay"`
// The day of the week to create a scheduled snapshot.
// Used for WEEKLY snapshot schedules.
// If not set, the system chooses a value at creation time.
DayOfWeek SnapshotScheduleDayOfWeekEnum `mandatory:"false" json:"dayOfWeek,omitempty"`
// The day of the month to create a scheduled snapshot.
// If the day does not exist for the month, snapshot creation will be skipped.
// Used for MONTHLY and YEARLY snapshot schedules.
// If not set, the system chooses a value at creation time.
DayOfMonth *int `mandatory:"false" json:"dayOfMonth"`
// The month to create a scheduled snapshot.
// Used only for YEARLY snapshot schedules.
// If not set, the system chooses a value at creation time.
Month SnapshotScheduleMonthEnum `mandatory:"false" json:"month,omitempty"`
}
func (m SnapshotSchedule) String() string
func (m SnapshotSchedule) 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
SnapshotScheduleDayOfWeekEnum Enum with underlying type: string
type SnapshotScheduleDayOfWeekEnum string
Set of constants representing the allowable values for SnapshotScheduleDayOfWeekEnum
const (
SnapshotScheduleDayOfWeekMonday SnapshotScheduleDayOfWeekEnum = "MONDAY"
SnapshotScheduleDayOfWeekTuesday SnapshotScheduleDayOfWeekEnum = "TUESDAY"
SnapshotScheduleDayOfWeekWednesday SnapshotScheduleDayOfWeekEnum = "WEDNESDAY"
SnapshotScheduleDayOfWeekThursday SnapshotScheduleDayOfWeekEnum = "THURSDAY"
SnapshotScheduleDayOfWeekFriday SnapshotScheduleDayOfWeekEnum = "FRIDAY"
SnapshotScheduleDayOfWeekSaturday SnapshotScheduleDayOfWeekEnum = "SATURDAY"
SnapshotScheduleDayOfWeekSunday SnapshotScheduleDayOfWeekEnum = "SUNDAY"
)
func GetMappingSnapshotScheduleDayOfWeekEnum(val string) (SnapshotScheduleDayOfWeekEnum, bool)
GetMappingSnapshotScheduleDayOfWeekEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnapshotScheduleDayOfWeekEnumValues() []SnapshotScheduleDayOfWeekEnum
GetSnapshotScheduleDayOfWeekEnumValues Enumerates the set of values for SnapshotScheduleDayOfWeekEnum
SnapshotScheduleMonthEnum Enum with underlying type: string
type SnapshotScheduleMonthEnum string
Set of constants representing the allowable values for SnapshotScheduleMonthEnum
const (
SnapshotScheduleMonthJanuary SnapshotScheduleMonthEnum = "JANUARY"
SnapshotScheduleMonthFebruary SnapshotScheduleMonthEnum = "FEBRUARY"
SnapshotScheduleMonthMarch SnapshotScheduleMonthEnum = "MARCH"
SnapshotScheduleMonthApril SnapshotScheduleMonthEnum = "APRIL"
SnapshotScheduleMonthMay SnapshotScheduleMonthEnum = "MAY"
SnapshotScheduleMonthJune SnapshotScheduleMonthEnum = "JUNE"
SnapshotScheduleMonthJuly SnapshotScheduleMonthEnum = "JULY"
SnapshotScheduleMonthAugust SnapshotScheduleMonthEnum = "AUGUST"
SnapshotScheduleMonthSeptember SnapshotScheduleMonthEnum = "SEPTEMBER"
SnapshotScheduleMonthOctober SnapshotScheduleMonthEnum = "OCTOBER"
SnapshotScheduleMonthNovember SnapshotScheduleMonthEnum = "NOVEMBER"
SnapshotScheduleMonthDecember SnapshotScheduleMonthEnum = "DECEMBER"
)
func GetMappingSnapshotScheduleMonthEnum(val string) (SnapshotScheduleMonthEnum, bool)
GetMappingSnapshotScheduleMonthEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnapshotScheduleMonthEnumValues() []SnapshotScheduleMonthEnum
GetSnapshotScheduleMonthEnumValues Enumerates the set of values for SnapshotScheduleMonthEnum
SnapshotSchedulePeriodEnum Enum with underlying type: string
type SnapshotSchedulePeriodEnum string
Set of constants representing the allowable values for SnapshotSchedulePeriodEnum
const (
SnapshotSchedulePeriodHourly SnapshotSchedulePeriodEnum = "HOURLY"
SnapshotSchedulePeriodDaily SnapshotSchedulePeriodEnum = "DAILY"
SnapshotSchedulePeriodWeekly SnapshotSchedulePeriodEnum = "WEEKLY"
SnapshotSchedulePeriodMonthly SnapshotSchedulePeriodEnum = "MONTHLY"
SnapshotSchedulePeriodYearly SnapshotSchedulePeriodEnum = "YEARLY"
)
func GetMappingSnapshotSchedulePeriodEnum(val string) (SnapshotSchedulePeriodEnum, bool)
GetMappingSnapshotSchedulePeriodEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnapshotSchedulePeriodEnumValues() []SnapshotSchedulePeriodEnum
GetSnapshotSchedulePeriodEnumValues Enumerates the set of values for SnapshotSchedulePeriodEnum
SnapshotScheduleTimeZoneEnum Enum with underlying type: string
type SnapshotScheduleTimeZoneEnum string
Set of constants representing the allowable values for SnapshotScheduleTimeZoneEnum
const (
SnapshotScheduleTimeZoneUtc SnapshotScheduleTimeZoneEnum = "UTC"
SnapshotScheduleTimeZoneRegionalDataCenterTime SnapshotScheduleTimeZoneEnum = "REGIONAL_DATA_CENTER_TIME"
)
func GetMappingSnapshotScheduleTimeZoneEnum(val string) (SnapshotScheduleTimeZoneEnum, bool)
GetMappingSnapshotScheduleTimeZoneEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnapshotScheduleTimeZoneEnumValues() []SnapshotScheduleTimeZoneEnum
GetSnapshotScheduleTimeZoneEnumValues Enumerates the set of values for SnapshotScheduleTimeZoneEnum
SnapshotSnapshotTypeEnum Enum with underlying type: string
type SnapshotSnapshotTypeEnum string
Set of constants representing the allowable values for SnapshotSnapshotTypeEnum
const (
SnapshotSnapshotTypeUser SnapshotSnapshotTypeEnum = "USER"
SnapshotSnapshotTypePolicyBased SnapshotSnapshotTypeEnum = "POLICY_BASED"
SnapshotSnapshotTypeReplication SnapshotSnapshotTypeEnum = "REPLICATION"
)
func GetMappingSnapshotSnapshotTypeEnum(val string) (SnapshotSnapshotTypeEnum, bool)
GetMappingSnapshotSnapshotTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnapshotSnapshotTypeEnumValues() []SnapshotSnapshotTypeEnum
GetSnapshotSnapshotTypeEnumValues Enumerates the set of values for SnapshotSnapshotTypeEnum
SnapshotSummary Summary information for a snapshot.
type SnapshotSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system from which the snapshot was created.
FileSystemId *string `mandatory:"true" json:"fileSystemId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot.
Id *string `mandatory:"true" json:"id"`
// The current state of the snapshot.
LifecycleState SnapshotSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Name of the snapshot. This value is immutable.
// Avoid entering confidential information.
// Example: `Sunday`
Name *string `mandatory:"true" json:"name"`
// The date and time the snapshot was created, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Specifies the generation type of the snapshot.
SnapshotType SnapshotSummarySnapshotTypeEnum `mandatory:"false" json:"snapshotType,omitempty"`
// The date and time the snapshot was taken, expressed
// in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// This value might be the same or different from `timeCreated` depending
// on the following factors:
// - If the snapshot is created in the original file system directory.
// - If the snapshot is cloned from a file system.
// - If the snapshot is replicated from a file system.
// Example: `2020-08-25T21:10:29.600Z`
SnapshotTime *common.SDKTime `mandatory:"false" json:"snapshotTime"`
// The time when this snapshot will be deleted.
ExpirationTime *common.SDKTime `mandatory:"false" json:"expirationTime"`
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) identifying the parent from which this snapshot was cloned.
// If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value.
// If this snapshot was cloned, then the `provenanceId` value is the parent's `provenanceId`.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
ProvenanceId *string `mandatory:"false" json:"provenanceId"`
// Specifies whether the snapshot has been cloned.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
IsCloneSource *bool `mandatory:"false" json:"isCloneSource"`
// Additional information about the current `lifecycleState`.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource.
// System tags are applied to resources by internal OCI services.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m SnapshotSummary) String() string
func (m SnapshotSummary) 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
SnapshotSummaryLifecycleStateEnum Enum with underlying type: string
type SnapshotSummaryLifecycleStateEnum string
Set of constants representing the allowable values for SnapshotSummaryLifecycleStateEnum
const (
SnapshotSummaryLifecycleStateCreating SnapshotSummaryLifecycleStateEnum = "CREATING"
SnapshotSummaryLifecycleStateActive SnapshotSummaryLifecycleStateEnum = "ACTIVE"
SnapshotSummaryLifecycleStateDeleting SnapshotSummaryLifecycleStateEnum = "DELETING"
SnapshotSummaryLifecycleStateDeleted SnapshotSummaryLifecycleStateEnum = "DELETED"
)
func GetMappingSnapshotSummaryLifecycleStateEnum(val string) (SnapshotSummaryLifecycleStateEnum, bool)
GetMappingSnapshotSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnapshotSummaryLifecycleStateEnumValues() []SnapshotSummaryLifecycleStateEnum
GetSnapshotSummaryLifecycleStateEnumValues Enumerates the set of values for SnapshotSummaryLifecycleStateEnum
SnapshotSummarySnapshotTypeEnum Enum with underlying type: string
type SnapshotSummarySnapshotTypeEnum string
Set of constants representing the allowable values for SnapshotSummarySnapshotTypeEnum
const (
SnapshotSummarySnapshotTypeUser SnapshotSummarySnapshotTypeEnum = "USER"
SnapshotSummarySnapshotTypePolicyBased SnapshotSummarySnapshotTypeEnum = "POLICY_BASED"
SnapshotSummarySnapshotTypeReplication SnapshotSummarySnapshotTypeEnum = "REPLICATION"
)
func GetMappingSnapshotSummarySnapshotTypeEnum(val string) (SnapshotSummarySnapshotTypeEnum, bool)
GetMappingSnapshotSummarySnapshotTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnapshotSummarySnapshotTypeEnumValues() []SnapshotSummarySnapshotTypeEnum
GetSnapshotSummarySnapshotTypeEnumValues Enumerates the set of values for SnapshotSummarySnapshotTypeEnum
SourceDetails Source information for the file system.
type SourceDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system that contains the source snapshot of a cloned file system.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
ParentFileSystemId *string `mandatory:"false" json:"parentFileSystemId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source snapshot used to create a cloned file system.
// See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm).
SourceSnapshotId *string `mandatory:"false" json:"sourceSnapshotId"`
}
func (m SourceDetails) String() string
func (m SourceDetails) 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
ToggleQuotaRulesDetails Details for enabling or disabling quota enforcement in the file system.
type ToggleQuotaRulesDetails struct {
// Specifies the enforcement of quota rules on the file system.
AreQuotaRulesEnabled *bool `mandatory:"true" json:"areQuotaRulesEnabled"`
}
func (m ToggleQuotaRulesDetails) String() string
func (m ToggleQuotaRulesDetails) 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
ToggleQuotaRulesRequest wrapper for the ToggleQuotaRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ToggleQuotaRules.go.html to see an example of how to use ToggleQuotaRulesRequest.
type ToggleQuotaRulesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// Details for toggling quota enforcement in the file system.
ToggleQuotaRulesDetails `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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ToggleQuotaRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ToggleQuotaRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ToggleQuotaRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ToggleQuotaRulesRequest) String() string
func (request ToggleQuotaRulesRequest) 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
ToggleQuotaRulesResponse wrapper for the ToggleQuotaRules operation
type ToggleQuotaRulesResponse 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 ToggleQuotaRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ToggleQuotaRulesResponse) String() string
UnpauseFilesystemSnapshotPolicyRequest wrapper for the UnpauseFilesystemSnapshotPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UnpauseFilesystemSnapshotPolicy.go.html to see an example of how to use UnpauseFilesystemSnapshotPolicyRequest.
type UnpauseFilesystemSnapshotPolicyRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
FilesystemSnapshotPolicyId *string `mandatory:"true" contributesTo:"path" name:"filesystemSnapshotPolicyId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 UnpauseFilesystemSnapshotPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UnpauseFilesystemSnapshotPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UnpauseFilesystemSnapshotPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UnpauseFilesystemSnapshotPolicyRequest) String() string
func (request UnpauseFilesystemSnapshotPolicyRequest) 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
UnpauseFilesystemSnapshotPolicyResponse wrapper for the UnpauseFilesystemSnapshotPolicy operation
type UnpauseFilesystemSnapshotPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The FilesystemSnapshotPolicy instance
FilesystemSnapshotPolicy `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 UnpauseFilesystemSnapshotPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UnpauseFilesystemSnapshotPolicyResponse) String() string
UpdateExportDetails Details for updating the export.
type UpdateExportDetails struct {
// Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
IsIdmapGroupsForSysAuth *bool `mandatory:"false" json:"isIdmapGroupsForSysAuth"`
// New export options for the export.
// **Setting to the empty array will make the export invisible to all clients.**
// Leaving unset will leave the `exportOptions` unchanged.
ExportOptions []ClientOptions `mandatory:"false" json:"exportOptions"`
}
func (m UpdateExportDetails) String() string
func (m UpdateExportDetails) 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
UpdateExportRequest wrapper for the UpdateExport operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateExport.go.html to see an example of how to use UpdateExportRequest.
type UpdateExportRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export.
ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"`
// Details object for updating an export.
UpdateExportDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 UpdateExportRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateExportRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateExportRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateExportRequest) String() string
func (request UpdateExportRequest) 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
UpdateExportResponse wrapper for the UpdateExport operation
type UpdateExportResponse struct {
// The underlying http response
RawResponse *http.Response
// The Export instance
Export `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 UpdateExportResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateExportResponse) String() string
UpdateExportSetDetails Details for updating the export set.
type UpdateExportSetDetails struct {
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My export set`
DisplayName *string `mandatory:"false" json:"displayName"`
// Controls the maximum `tbytes`, `fbytes`, and `abytes`
// values reported by `NFS FSSTAT` calls through any associated
// mount targets. This is an advanced feature. For most
// applications, use the default value. The
// `tbytes` value reported by `FSSTAT` will be
// `maxFsStatBytes`. The value of `fbytes` and `abytes` will be
// `maxFsStatBytes` minus the metered size of the file
// system. If the metered size is larger than `maxFsStatBytes`,
// then `fbytes` and `abytes` will both be '0'.
MaxFsStatBytes *int64 `mandatory:"false" json:"maxFsStatBytes"`
// Controls the maximum `ffiles`, `ffiles`, and `afiles`
// values reported by `NFS FSSTAT` calls through any associated
// mount targets. This is an advanced feature. For most
// applications, use the default value. The
// `tfiles` value reported by `FSSTAT` will be
// `maxFsStatFiles`. The value of `ffiles` and `afiles` will be
// `maxFsStatFiles` minus the metered size of the file
// system. If the metered size is larger than `maxFsStatFiles`,
// then `ffiles` and `afiles` will both be '0'.
MaxFsStatFiles *int64 `mandatory:"false" json:"maxFsStatFiles"`
}
func (m UpdateExportSetDetails) String() string
func (m UpdateExportSetDetails) 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
UpdateExportSetRequest wrapper for the UpdateExportSet operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateExportSet.go.html to see an example of how to use UpdateExportSetRequest.
type UpdateExportSetRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export set.
ExportSetId *string `mandatory:"true" contributesTo:"path" name:"exportSetId"`
// Details object for updating an export set.
UpdateExportSetDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 UpdateExportSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateExportSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateExportSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateExportSetRequest) String() string
func (request UpdateExportSetRequest) 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
UpdateExportSetResponse wrapper for the UpdateExportSet operation
type UpdateExportSetResponse struct {
// The underlying http response
RawResponse *http.Response
// The ExportSet instance
ExportSet `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 UpdateExportSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateExportSetResponse) String() string
UpdateFileSystemDetails Details for updating the file system.
type UpdateFileSystemDetails struct {
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My file system`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Key Management master encryption key to associate with the specified file system.
// If this value is empty, the Update operation will remove the associated key, if there is one, from the file system.
// (The file system will continue to be encrypted, but with an encryption key managed by Oracle.)
// If updating to a new Key Management key, the old key must remain enabled so that files previously encrypted continue
// to be accessible. For more information, see Overview of Key Management (https://docs.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm).
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated file system snapshot policy, which
// controls the frequency of snapshot creation and retention period of the taken snapshots.
// If string is empty, the policy reference (if any) would be removed.
FilesystemSnapshotPolicyId *string `mandatory:"false" json:"filesystemSnapshotPolicyId"`
}
func (m UpdateFileSystemDetails) String() string
func (m UpdateFileSystemDetails) 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
UpdateFileSystemRequest wrapper for the UpdateFileSystem operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateFileSystem.go.html to see an example of how to use UpdateFileSystemRequest.
type UpdateFileSystemRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// Details object for updating a file system.
UpdateFileSystemDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 UpdateFileSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateFileSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateFileSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateFileSystemRequest) String() string
func (request UpdateFileSystemRequest) 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
UpdateFileSystemResponse wrapper for the UpdateFileSystem operation
type UpdateFileSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// The FileSystem instance
FileSystem `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 UpdateFileSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateFileSystemResponse) String() string
UpdateFilesystemSnapshotPolicyDetails Details for updating the file system snapshot policy.
type UpdateFilesystemSnapshotPolicyDetails struct {
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `policy1`
DisplayName *string `mandatory:"false" json:"displayName"`
// The prefix to apply to all snapshots created by this policy.
// Example: `acme`
PolicyPrefix *string `mandatory:"false" json:"policyPrefix"`
// The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
// If using the CLI, provide the schedule as a list of JSON strings, with the list wrapped in
// quotation marks, i.e.
// ```
// --schedules '[{"timeZone":"UTC","period":"DAILY","hourOfDay":18},{"timeZone":"UTC","period":"HOURLY"}]'
// ```
Schedules []SnapshotSchedule `mandatory:"false" json:"schedules"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateFilesystemSnapshotPolicyDetails) String() string
func (m UpdateFilesystemSnapshotPolicyDetails) 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
UpdateFilesystemSnapshotPolicyRequest wrapper for the UpdateFilesystemSnapshotPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateFilesystemSnapshotPolicy.go.html to see an example of how to use UpdateFilesystemSnapshotPolicyRequest.
type UpdateFilesystemSnapshotPolicyRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
FilesystemSnapshotPolicyId *string `mandatory:"true" contributesTo:"path" name:"filesystemSnapshotPolicyId"`
// Details object for updating a file system snapshot policy.
UpdateFilesystemSnapshotPolicyDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 UpdateFilesystemSnapshotPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateFilesystemSnapshotPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateFilesystemSnapshotPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateFilesystemSnapshotPolicyRequest) String() string
func (request UpdateFilesystemSnapshotPolicyRequest) 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
UpdateFilesystemSnapshotPolicyResponse wrapper for the UpdateFilesystemSnapshotPolicy operation
type UpdateFilesystemSnapshotPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The FilesystemSnapshotPolicy instance
FilesystemSnapshotPolicy `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 UpdateFilesystemSnapshotPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateFilesystemSnapshotPolicyResponse) String() string
UpdateKerberosDetails Kerberos details needed to update configuration.
type UpdateKerberosDetails struct {
// Kerberos realm that this mount target will join.
KerberosRealm *string `mandatory:"false" json:"kerberosRealm"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the keytab secret in the Vault.
KeyTabSecretId *string `mandatory:"false" json:"keyTabSecretId"`
// Version of the keytab secret in the Vault to use.
CurrentKeyTabSecretVersion *int `mandatory:"false" json:"currentKeyTabSecretVersion"`
// Version of the keytab secert in the Vault to use as a backup.
BackupKeyTabSecretVersion *int `mandatory:"false" json:"backupKeyTabSecretVersion"`
// Specifies whether to enable or disable Kerberos.
IsKerberosEnabled *bool `mandatory:"false" json:"isKerberosEnabled"`
}
func (m UpdateKerberosDetails) String() string
func (m UpdateKerberosDetails) 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
UpdateLdapIdmapDetails Mount target details about the LDAP ID mapping configuration.
type UpdateLdapIdmapDetails struct {
// Schema type of the LDAP account.
SchemaType UpdateLdapIdmapDetailsSchemaTypeEnum `mandatory:"false" json:"schemaType,omitempty"`
// The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry.
CacheRefreshIntervalSeconds *int `mandatory:"false" json:"cacheRefreshIntervalSeconds"`
// The maximum amount of time the mount target is allowed to use a cached entry.
CacheLifetimeSeconds *int `mandatory:"false" json:"cacheLifetimeSeconds"`
// The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration.
NegativeCacheLifetimeSeconds *int `mandatory:"false" json:"negativeCacheLifetimeSeconds"`
// All LDAP searches are recursive starting at this user.
// Example: `CN=User,DC=domain,DC=com`
UserSearchBase *string `mandatory:"false" json:"userSearchBase"`
// All LDAP searches are recursive starting at this group.
// Example: `CN=Group,DC=domain,DC=com`
GroupSearchBase *string `mandatory:"false" json:"groupSearchBase"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first connector to use to communicate with the LDAP server.
OutboundConnector1Id *string `mandatory:"false" json:"outboundConnector1Id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second connector to use to communicate with the LDAP server.
OutboundConnector2Id *string `mandatory:"false" json:"outboundConnector2Id"`
}
func (m UpdateLdapIdmapDetails) String() string
func (m UpdateLdapIdmapDetails) 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
UpdateLdapIdmapDetailsSchemaTypeEnum Enum with underlying type: string
type UpdateLdapIdmapDetailsSchemaTypeEnum string
Set of constants representing the allowable values for UpdateLdapIdmapDetailsSchemaTypeEnum
const (
UpdateLdapIdmapDetailsSchemaTypeRfc2307 UpdateLdapIdmapDetailsSchemaTypeEnum = "RFC2307"
)
func GetMappingUpdateLdapIdmapDetailsSchemaTypeEnum(val string) (UpdateLdapIdmapDetailsSchemaTypeEnum, bool)
GetMappingUpdateLdapIdmapDetailsSchemaTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateLdapIdmapDetailsSchemaTypeEnumValues() []UpdateLdapIdmapDetailsSchemaTypeEnum
GetUpdateLdapIdmapDetailsSchemaTypeEnumValues Enumerates the set of values for UpdateLdapIdmapDetailsSchemaTypeEnum
UpdateMountTargetDetails Details for updating the mount target.
type UpdateMountTargetDetails struct {
// A user-friendly name. Does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My mount target`
DisplayName *string `mandatory:"false" json:"displayName"`
// The method used to map a Unix UID to secondary groups, if any.
IdmapType MountTargetIdmapTypeEnum `mandatory:"false" json:"idmapType,omitempty"`
LdapIdmap *UpdateLdapIdmapDetails `mandatory:"false" json:"ldapIdmap"`
// A list of Network Security Group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this mount target.
// A maximum of 5 is allowed.
// Setting this to an empty array after the list is created removes the mount target from all NSGs.
// For more information about NSGs, see Security Rules (https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm).
NsgIds []string `mandatory:"false" json:"nsgIds"`
Kerberos *UpdateKerberosDetails `mandatory:"false" json:"kerberos"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateMountTargetDetails) String() string
func (m UpdateMountTargetDetails) 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
UpdateMountTargetRequest wrapper for the UpdateMountTarget operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateMountTarget.go.html to see an example of how to use UpdateMountTargetRequest.
type UpdateMountTargetRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`
// Details object for updating a mount target.
UpdateMountTargetDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 UpdateMountTargetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateMountTargetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateMountTargetRequest) String() string
func (request UpdateMountTargetRequest) 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
UpdateMountTargetResponse wrapper for the UpdateMountTarget operation
type UpdateMountTargetResponse struct {
// The underlying http response
RawResponse *http.Response
// The MountTarget instance
MountTarget `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 UpdateMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateMountTargetResponse) String() string
UpdateOutboundConnectorDetails Details for updating the outbound connector.
type UpdateOutboundConnectorDetails struct {
// A user-friendly name. Does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// Example: `My Outbound Connector`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateOutboundConnectorDetails) String() string
func (m UpdateOutboundConnectorDetails) 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
UpdateOutboundConnectorRequest wrapper for the UpdateOutboundConnector operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateOutboundConnector.go.html to see an example of how to use UpdateOutboundConnectorRequest.
type UpdateOutboundConnectorRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector.
OutboundConnectorId *string `mandatory:"true" contributesTo:"path" name:"outboundConnectorId"`
// Details object for updating a outbound connector.
UpdateOutboundConnectorDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 UpdateOutboundConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOutboundConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOutboundConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOutboundConnectorRequest) String() string
func (request UpdateOutboundConnectorRequest) 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
UpdateOutboundConnectorResponse wrapper for the UpdateOutboundConnector operation
type UpdateOutboundConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// The OutboundConnector instance
OutboundConnector `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 UpdateOutboundConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOutboundConnectorResponse) String() string
UpdateQuotaRuleDetails Details for updating a quota rule in the file system.
type UpdateQuotaRuleDetails struct {
// A user-friendly name that the quota rule will be renamed to. It does not have to be unique.
// Avoid entering confidential information.
// Example: `UserXYZ's quota`
DisplayName *string `mandatory:"false" json:"displayName"`
// An updated value of the quota rule in gigabytes.
QuotaLimitInGigabytes *int `mandatory:"false" json:"quotaLimitInGigabytes"`
}
func (m UpdateQuotaRuleDetails) String() string
func (m UpdateQuotaRuleDetails) 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
UpdateQuotaRuleRequest wrapper for the UpdateQuotaRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateQuotaRule.go.html to see an example of how to use UpdateQuotaRuleRequest.
type UpdateQuotaRuleRequest struct {
// Details for editing a quota rule.
UpdateQuotaRuleDetails `contributesTo:"body"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`
// The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
QuotaRuleId *string `mandatory:"true" contributesTo:"path" name:"quotaRuleId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 UpdateQuotaRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateQuotaRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateQuotaRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateQuotaRuleRequest) String() string
func (request UpdateQuotaRuleRequest) 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
UpdateQuotaRuleResponse wrapper for the UpdateQuotaRule operation
type UpdateQuotaRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The QuotaRule instance
QuotaRule `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 UpdateQuotaRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateQuotaRuleResponse) String() string
UpdateReplicationDetails Details for updating the replication and replication target.
type UpdateReplicationDetails struct {
// A user-friendly name. Does not have to be unique, and it is changeable.
// Avoid entering confidential information.
// A replication target will also updated with the same `displayName`.
// Example: `My replication`
DisplayName *string `mandatory:"false" json:"displayName"`
// Duration in minutes between replication snapshots.
ReplicationInterval *int64 `mandatory:"false" json:"replicationInterval"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateReplicationDetails) String() string
func (m UpdateReplicationDetails) 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
UpdateReplicationRequest wrapper for the UpdateReplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateReplication.go.html to see an example of how to use UpdateReplicationRequest.
type UpdateReplicationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication.
ReplicationId *string `mandatory:"true" contributesTo:"path" name:"replicationId"`
// Details object for updating a replication.
UpdateReplicationDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 UpdateReplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateReplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateReplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateReplicationRequest) String() string
func (request UpdateReplicationRequest) 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
UpdateReplicationResponse wrapper for the UpdateReplication operation
type UpdateReplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Replication instance
Replication `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 UpdateReplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateReplicationResponse) String() string
UpdateSnapshotDetails Details for updating the snapshot.
type UpdateSnapshotDetails struct {
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The UTC time when this snapshot will be deleted. To remove the expiration time, set this field to the minimum date-time value using Date(0).
// Example: `Thu Jan 01 01:00:00 GMT 1970`
ExpirationTime *common.SDKTime `mandatory:"false" json:"expirationTime"`
}
func (m UpdateSnapshotDetails) String() string
func (m UpdateSnapshotDetails) 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
UpdateSnapshotRequest wrapper for the UpdateSnapshot operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpdateSnapshot.go.html to see an example of how to use UpdateSnapshotRequest.
type UpdateSnapshotRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot.
SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`
// Details object for updating a snapshot.
UpdateSnapshotDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// 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 UpdateSnapshotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSnapshotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSnapshotRequest) String() string
func (request UpdateSnapshotRequest) 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
UpdateSnapshotResponse wrapper for the UpdateSnapshot operation
type UpdateSnapshotResponse struct {
// The underlying http response
RawResponse *http.Response
// The Snapshot instance
Snapshot `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 UpdateSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSnapshotResponse) String() string
UpgradeShapeMountTargetDetails Shape details about the Mount Target.
type UpgradeShapeMountTargetDetails struct {
// New throughput for mount target in Gbps. Available shapes and corresponding throughput are listed at
// Mount Target Performance (https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
RequestedThroughput *int64 `mandatory:"false" json:"requestedThroughput"`
}
func (m UpgradeShapeMountTargetDetails) String() string
func (m UpgradeShapeMountTargetDetails) 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
UpgradeShapeMountTargetRequest wrapper for the UpgradeShapeMountTarget operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/UpgradeShapeMountTarget.go.html to see an example of how to use UpgradeShapeMountTargetRequest.
type UpgradeShapeMountTargetRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target.
MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`
// Details for changing the shape of mount target.
UpgradeShapeMountTargetDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 UpgradeShapeMountTargetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpgradeShapeMountTargetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpgradeShapeMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpgradeShapeMountTargetRequest) String() string
func (request UpgradeShapeMountTargetRequest) 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
UpgradeShapeMountTargetResponse wrapper for the UpgradeShapeMountTarget operation
type UpgradeShapeMountTargetResponse struct {
// The underlying http response
RawResponse *http.Response
// The MountTarget instance
MountTarget `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 UpgradeShapeMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpgradeShapeMountTargetResponse) String() string
ValidateKeyTabsDetails Validate keytabs request details.
type ValidateKeyTabsDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target whose keytabs are to be validated.
MountTargetId *string `mandatory:"false" json:"mountTargetId"`
KeyTabSecretDetails *KeyTabSecretDetails `mandatory:"false" json:"keyTabSecretDetails"`
}
func (m ValidateKeyTabsDetails) String() string
func (m ValidateKeyTabsDetails) 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
ValidateKeyTabsRequest wrapper for the ValidateKeyTabs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/filestorage/ValidateKeyTabs.go.html to see an example of how to use ValidateKeyTabsRequest.
type ValidateKeyTabsRequest struct {
// Keytab secret details or mount target ID for validating keytabs.
ValidateKeyTabsDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ValidateKeyTabsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ValidateKeyTabsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ValidateKeyTabsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ValidateKeyTabsRequest) String() string
func (request ValidateKeyTabsRequest) 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
ValidateKeyTabsResponse wrapper for the ValidateKeyTabs operation
type ValidateKeyTabsResponse struct {
// The underlying http response
RawResponse *http.Response
// The ValidateKeyTabsResponseDetails instance
ValidateKeyTabsResponseDetails `presentIn:"body"`
// Unique Oracle-assigned identifier for the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ValidateKeyTabsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ValidateKeyTabsResponse) String() string
ValidateKeyTabsResponseDetails Validate keytabs response details.
type ValidateKeyTabsResponseDetails struct {
// An array of keytab entries (principal, encryptionType, keyVersionNumber).
CurrentKerberosKeytabEntries []KerberosKeytabEntry `mandatory:"true" json:"currentKerberosKeytabEntries"`
// An array of keytab entries (principal, encryptionType, keyVersionNumber).
BackupKerberosKeytabEntries []KerberosKeytabEntry `mandatory:"false" json:"backupKerberosKeytabEntries"`
}
func (m ValidateKeyTabsResponseDetails) String() string
func (m ValidateKeyTabsResponseDetails) 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