Documentation ¶
Index ¶
- type ClientOptions
- type ClientOptionsAccessEnum
- type ClientOptionsIdentitySquashEnum
- type CreateExportDetails
- type CreateExportRequest
- type CreateExportResponse
- type CreateFileSystemDetails
- type CreateFileSystemRequest
- type CreateFileSystemResponse
- type CreateMountTargetDetails
- type CreateMountTargetRequest
- type CreateMountTargetResponse
- type CreateSnapshotDetails
- type CreateSnapshotRequest
- type CreateSnapshotResponse
- type DeleteExportRequest
- type DeleteExportResponse
- type DeleteFileSystemRequest
- type DeleteFileSystemResponse
- type DeleteMountTargetRequest
- type DeleteMountTargetResponse
- type DeleteSnapshotRequest
- type DeleteSnapshotResponse
- type Export
- type ExportLifecycleStateEnum
- type ExportSet
- type ExportSetLifecycleStateEnum
- type ExportSetSummary
- type ExportSetSummaryLifecycleStateEnum
- type ExportSummary
- type ExportSummaryLifecycleStateEnum
- type FileStorageClient
- func (client *FileStorageClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client FileStorageClient) CreateExport(ctx context.Context, request CreateExportRequest) (response CreateExportResponse, err error)
- func (client FileStorageClient) CreateFileSystem(ctx context.Context, request CreateFileSystemRequest) (response CreateFileSystemResponse, err error)
- func (client FileStorageClient) CreateMountTarget(ctx context.Context, request CreateMountTargetRequest) (response CreateMountTargetResponse, err error)
- func (client FileStorageClient) CreateSnapshot(ctx context.Context, request CreateSnapshotRequest) (response CreateSnapshotResponse, err error)
- func (client FileStorageClient) DeleteExport(ctx context.Context, request DeleteExportRequest) (response DeleteExportResponse, err error)
- func (client FileStorageClient) DeleteFileSystem(ctx context.Context, request DeleteFileSystemRequest) (response DeleteFileSystemResponse, err error)
- func (client FileStorageClient) DeleteMountTarget(ctx context.Context, request DeleteMountTargetRequest) (response DeleteMountTargetResponse, err error)
- func (client FileStorageClient) DeleteSnapshot(ctx context.Context, request DeleteSnapshotRequest) (response DeleteSnapshotResponse, err error)
- func (client FileStorageClient) GetExport(ctx context.Context, request GetExportRequest) (response GetExportResponse, err error)
- func (client FileStorageClient) GetExportSet(ctx context.Context, request GetExportSetRequest) (response GetExportSetResponse, err error)
- func (client FileStorageClient) GetFileSystem(ctx context.Context, request GetFileSystemRequest) (response GetFileSystemResponse, err error)
- func (client FileStorageClient) GetMountTarget(ctx context.Context, request GetMountTargetRequest) (response GetMountTargetResponse, err error)
- func (client FileStorageClient) GetSnapshot(ctx context.Context, request GetSnapshotRequest) (response GetSnapshotResponse, err error)
- func (client FileStorageClient) ListExportSets(ctx context.Context, request ListExportSetsRequest) (response ListExportSetsResponse, err error)
- func (client FileStorageClient) ListExports(ctx context.Context, request ListExportsRequest) (response ListExportsResponse, err error)
- func (client FileStorageClient) ListFileSystems(ctx context.Context, request ListFileSystemsRequest) (response ListFileSystemsResponse, err error)
- func (client FileStorageClient) ListMountTargets(ctx context.Context, request ListMountTargetsRequest) (response ListMountTargetsResponse, err error)
- func (client FileStorageClient) ListSnapshots(ctx context.Context, request ListSnapshotsRequest) (response ListSnapshotsResponse, err error)
- func (client *FileStorageClient) SetRegion(region string)
- func (client FileStorageClient) UpdateExport(ctx context.Context, request UpdateExportRequest) (response UpdateExportResponse, err error)
- func (client FileStorageClient) UpdateExportSet(ctx context.Context, request UpdateExportSetRequest) (response UpdateExportSetResponse, err error)
- func (client FileStorageClient) UpdateFileSystem(ctx context.Context, request UpdateFileSystemRequest) (response UpdateFileSystemResponse, err error)
- func (client FileStorageClient) UpdateMountTarget(ctx context.Context, request UpdateMountTargetRequest) (response UpdateMountTargetResponse, err error)
- type FileSystem
- type FileSystemLifecycleStateEnum
- type FileSystemSummary
- type FileSystemSummaryLifecycleStateEnum
- type GetExportRequest
- type GetExportResponse
- type GetExportSetRequest
- type GetExportSetResponse
- type GetFileSystemRequest
- type GetFileSystemResponse
- type GetMountTargetRequest
- type GetMountTargetResponse
- type GetSnapshotRequest
- type GetSnapshotResponse
- type ListExportSetsLifecycleStateEnum
- type ListExportSetsRequest
- type ListExportSetsResponse
- type ListExportSetsSortByEnum
- type ListExportSetsSortOrderEnum
- type ListExportsLifecycleStateEnum
- type ListExportsRequest
- type ListExportsResponse
- type ListExportsSortByEnum
- type ListExportsSortOrderEnum
- type ListFileSystemsLifecycleStateEnum
- type ListFileSystemsRequest
- type ListFileSystemsResponse
- type ListFileSystemsSortByEnum
- type ListFileSystemsSortOrderEnum
- type ListMountTargetsLifecycleStateEnum
- type ListMountTargetsRequest
- type ListMountTargetsResponse
- type ListMountTargetsSortByEnum
- type ListMountTargetsSortOrderEnum
- type ListSnapshotsLifecycleStateEnum
- type ListSnapshotsRequest
- type ListSnapshotsResponse
- type ListSnapshotsSortOrderEnum
- type MountTarget
- type MountTargetLifecycleStateEnum
- type MountTargetSummary
- type MountTargetSummaryLifecycleStateEnum
- type Snapshot
- type SnapshotLifecycleStateEnum
- type SnapshotSummary
- type SnapshotSummaryLifecycleStateEnum
- type UpdateExportDetails
- type UpdateExportRequest
- type UpdateExportResponse
- type UpdateExportSetDetails
- type UpdateExportSetRequest
- type UpdateExportSetResponse
- type UpdateFileSystemDetails
- type UpdateFileSystemRequest
- type UpdateFileSystemResponse
- type UpdateMountTargetDetails
- type UpdateMountTargetRequest
- type UpdateMountTargetResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClientOptions ¶
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_ONLY`. 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"` }
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.
func (ClientOptions) String ¶
func (m ClientOptions) String() string
type ClientOptionsAccessEnum ¶
type ClientOptionsAccessEnum string
ClientOptionsAccessEnum Enum with underlying type: string
const ( ClientOptionsAccessWrite ClientOptionsAccessEnum = "READ_WRITE" ClientOptionsAccessOnly ClientOptionsAccessEnum = "READ_ONLY" )
Set of constants representing the allowable values for ClientOptionsAccess
func GetClientOptionsAccessEnumValues ¶
func GetClientOptionsAccessEnumValues() []ClientOptionsAccessEnum
GetClientOptionsAccessEnumValues Enumerates the set of values for ClientOptionsAccess
type ClientOptionsIdentitySquashEnum ¶
type ClientOptionsIdentitySquashEnum string
ClientOptionsIdentitySquashEnum Enum with underlying type: string
const ( ClientOptionsIdentitySquashNone ClientOptionsIdentitySquashEnum = "NONE" ClientOptionsIdentitySquashRoot ClientOptionsIdentitySquashEnum = "ROOT" ClientOptionsIdentitySquashAll ClientOptionsIdentitySquashEnum = "ALL" )
Set of constants representing the allowable values for ClientOptionsIdentitySquash
func GetClientOptionsIdentitySquashEnumValues ¶
func GetClientOptionsIdentitySquashEnumValues() []ClientOptionsIdentitySquashEnum
GetClientOptionsIdentitySquashEnumValues Enumerates the set of values for ClientOptionsIdentitySquash
type CreateExportDetails ¶
type CreateExportDetails struct { // The OCID of this export's export set. ExportSetId *string `mandatory:"true" json:"exportSetId"` // The OCID 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. If left unspecified, // defaults to: // [ // { // "source" : "0.0.0.0/0", // "requirePrivilegedSourcePort" : false, // "access" : "READ_WRITE", // "identitySquash" : "NONE" // } // ] // **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"` }
CreateExportDetails The representation of CreateExportDetails
func (CreateExportDetails) String ¶
func (m CreateExportDetails) String() string
type 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 Oracle-assigned 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 }
CreateExportRequest wrapper for the CreateExport operation
func (CreateExportRequest) HTTPRequest ¶ added in v1.3.0
func (request CreateExportRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreateExportRequest) RetryPolicy ¶ added in v1.3.0
func (request CreateExportRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreateExportRequest) String ¶
func (request CreateExportRequest) String() string
type CreateExportResponse ¶
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"` }
CreateExportResponse wrapper for the CreateExport operation
func (CreateExportResponse) HTTPResponse ¶ added in v1.3.0
func (response CreateExportResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateExportResponse) String ¶
func (response CreateExportResponse) String() string
type CreateFileSystemDetails ¶
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 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"` }
CreateFileSystemDetails The representation of CreateFileSystemDetails
func (CreateFileSystemDetails) String ¶
func (m CreateFileSystemDetails) String() string
type 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 Oracle-assigned 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 }
CreateFileSystemRequest wrapper for the CreateFileSystem operation
func (CreateFileSystemRequest) HTTPRequest ¶ added in v1.3.0
func (request CreateFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreateFileSystemRequest) RetryPolicy ¶ added in v1.3.0
func (request CreateFileSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreateFileSystemRequest) String ¶
func (request CreateFileSystemRequest) String() string
type CreateFileSystemResponse ¶
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"` }
CreateFileSystemResponse wrapper for the CreateFileSystem operation
func (CreateFileSystemResponse) HTTPResponse ¶ added in v1.3.0
func (response CreateFileSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateFileSystemResponse) String ¶
func (response CreateFileSystemResponse) String() string
type CreateMountTargetDetails ¶
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 of the compartment in which to create the mount target. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The OCID 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). // For more information, see // DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/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"` }
CreateMountTargetDetails The representation of CreateMountTargetDetails
func (CreateMountTargetDetails) String ¶
func (m CreateMountTargetDetails) String() string
type 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 Oracle-assigned 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 }
CreateMountTargetRequest wrapper for the CreateMountTarget operation
func (CreateMountTargetRequest) HTTPRequest ¶ added in v1.3.0
func (request CreateMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreateMountTargetRequest) RetryPolicy ¶ added in v1.3.0
func (request CreateMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreateMountTargetRequest) String ¶
func (request CreateMountTargetRequest) String() string
type CreateMountTargetResponse ¶
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"` }
CreateMountTargetResponse wrapper for the CreateMountTarget operation
func (CreateMountTargetResponse) HTTPResponse ¶ added in v1.3.0
func (response CreateMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateMountTargetResponse) String ¶
func (response CreateMountTargetResponse) String() string
type CreateSnapshotDetails ¶
type CreateSnapshotDetails struct { // The OCID 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"` }
CreateSnapshotDetails The representation of CreateSnapshotDetails
func (CreateSnapshotDetails) String ¶
func (m CreateSnapshotDetails) String() string
type 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 Oracle-assigned 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 }
CreateSnapshotRequest wrapper for the CreateSnapshot operation
func (CreateSnapshotRequest) HTTPRequest ¶ added in v1.3.0
func (request CreateSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreateSnapshotRequest) RetryPolicy ¶ added in v1.3.0
func (request CreateSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreateSnapshotRequest) String ¶
func (request CreateSnapshotRequest) String() string
type CreateSnapshotResponse ¶
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"` }
CreateSnapshotResponse wrapper for the CreateSnapshot operation
func (CreateSnapshotResponse) HTTPResponse ¶ added in v1.3.0
func (response CreateSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateSnapshotResponse) String ¶
func (response CreateSnapshotResponse) String() string
type DeleteExportRequest ¶
type DeleteExportRequest struct { // The OCID 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 Oracle-assigned 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 }
DeleteExportRequest wrapper for the DeleteExport operation
func (DeleteExportRequest) HTTPRequest ¶ added in v1.3.0
func (request DeleteExportRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (DeleteExportRequest) RetryPolicy ¶ added in v1.3.0
func (request DeleteExportRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (DeleteExportRequest) String ¶
func (request DeleteExportRequest) String() string
type DeleteExportResponse ¶
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"` }
DeleteExportResponse wrapper for the DeleteExport operation
func (DeleteExportResponse) HTTPResponse ¶ added in v1.3.0
func (response DeleteExportResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DeleteExportResponse) String ¶
func (response DeleteExportResponse) String() string
type DeleteFileSystemRequest ¶
type DeleteFileSystemRequest struct { // The OCID 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 Oracle-assigned 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 }
DeleteFileSystemRequest wrapper for the DeleteFileSystem operation
func (DeleteFileSystemRequest) HTTPRequest ¶ added in v1.3.0
func (request DeleteFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (DeleteFileSystemRequest) RetryPolicy ¶ added in v1.3.0
func (request DeleteFileSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (DeleteFileSystemRequest) String ¶
func (request DeleteFileSystemRequest) String() string
type DeleteFileSystemResponse ¶
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"` }
DeleteFileSystemResponse wrapper for the DeleteFileSystem operation
func (DeleteFileSystemResponse) HTTPResponse ¶ added in v1.3.0
func (response DeleteFileSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DeleteFileSystemResponse) String ¶
func (response DeleteFileSystemResponse) String() string
type DeleteMountTargetRequest ¶
type DeleteMountTargetRequest struct { // The OCID 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 Oracle-assigned 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 }
DeleteMountTargetRequest wrapper for the DeleteMountTarget operation
func (DeleteMountTargetRequest) HTTPRequest ¶ added in v1.3.0
func (request DeleteMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (DeleteMountTargetRequest) RetryPolicy ¶ added in v1.3.0
func (request DeleteMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (DeleteMountTargetRequest) String ¶
func (request DeleteMountTargetRequest) String() string
type DeleteMountTargetResponse ¶
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"` }
DeleteMountTargetResponse wrapper for the DeleteMountTarget operation
func (DeleteMountTargetResponse) HTTPResponse ¶ added in v1.3.0
func (response DeleteMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DeleteMountTargetResponse) String ¶
func (response DeleteMountTargetResponse) String() string
type DeleteSnapshotRequest ¶
type DeleteSnapshotRequest struct { // The OCID 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 Oracle-assigned 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 }
DeleteSnapshotRequest wrapper for the DeleteSnapshot operation
func (DeleteSnapshotRequest) HTTPRequest ¶ added in v1.3.0
func (request DeleteSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (DeleteSnapshotRequest) RetryPolicy ¶ added in v1.3.0
func (request DeleteSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (DeleteSnapshotRequest) String ¶
func (request DeleteSnapshotRequest) String() string
type DeleteSnapshotResponse ¶
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"` }
DeleteSnapshotResponse wrapper for the DeleteSnapshot operation
func (DeleteSnapshotResponse) HTTPResponse ¶ added in v1.3.0
func (response DeleteSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DeleteSnapshotResponse) String ¶
func (response DeleteSnapshotResponse) String() string
type Export ¶
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 of this export's export set. ExportSetId *string `mandatory:"true" json:"exportSetId"` // The OCID of this export's file system. FileSystemId *string `mandatory:"true" json:"fileSystemId"` // The OCID 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"` }
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:
- /example and /path
- /example1 and /example2
- /example and /example1
The following examples are not acceptable:
- /example and /example/path
- / and /example
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.us-phoenix-1.oraclecloud.com/Content/File/Tasks/exportoptions.htm).
type ExportLifecycleStateEnum ¶
type ExportLifecycleStateEnum string
ExportLifecycleStateEnum Enum with underlying type: string
const ( ExportLifecycleStateCreating ExportLifecycleStateEnum = "CREATING" ExportLifecycleStateActive ExportLifecycleStateEnum = "ACTIVE" ExportLifecycleStateDeleting ExportLifecycleStateEnum = "DELETING" ExportLifecycleStateDeleted ExportLifecycleStateEnum = "DELETED" )
Set of constants representing the allowable values for ExportLifecycleState
func GetExportLifecycleStateEnumValues ¶
func GetExportLifecycleStateEnumValues() []ExportLifecycleStateEnum
GetExportLifecycleStateEnumValues Enumerates the set of values for ExportLifecycleState
type ExportSet ¶
type ExportSet struct { // The OCID 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 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 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"` }
ExportSet A set of file systems to export through one or more mount targets. Composed of zero or more export resources.
type ExportSetLifecycleStateEnum ¶
type ExportSetLifecycleStateEnum string
ExportSetLifecycleStateEnum Enum with underlying type: string
const ( ExportSetLifecycleStateCreating ExportSetLifecycleStateEnum = "CREATING" ExportSetLifecycleStateActive ExportSetLifecycleStateEnum = "ACTIVE" ExportSetLifecycleStateDeleting ExportSetLifecycleStateEnum = "DELETING" ExportSetLifecycleStateDeleted ExportSetLifecycleStateEnum = "DELETED" )
Set of constants representing the allowable values for ExportSetLifecycleState
func GetExportSetLifecycleStateEnumValues ¶
func GetExportSetLifecycleStateEnumValues() []ExportSetLifecycleStateEnum
GetExportSetLifecycleStateEnumValues Enumerates the set of values for ExportSetLifecycleState
type ExportSetSummary ¶
type ExportSetSummary struct { // The OCID 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 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 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"` }
ExportSetSummary Summary information for an export set.
func (ExportSetSummary) String ¶
func (m ExportSetSummary) String() string
type ExportSetSummaryLifecycleStateEnum ¶
type ExportSetSummaryLifecycleStateEnum string
ExportSetSummaryLifecycleStateEnum Enum with underlying type: string
const ( ExportSetSummaryLifecycleStateCreating ExportSetSummaryLifecycleStateEnum = "CREATING" ExportSetSummaryLifecycleStateActive ExportSetSummaryLifecycleStateEnum = "ACTIVE" ExportSetSummaryLifecycleStateDeleting ExportSetSummaryLifecycleStateEnum = "DELETING" ExportSetSummaryLifecycleStateDeleted ExportSetSummaryLifecycleStateEnum = "DELETED" )
Set of constants representing the allowable values for ExportSetSummaryLifecycleState
func GetExportSetSummaryLifecycleStateEnumValues ¶
func GetExportSetSummaryLifecycleStateEnumValues() []ExportSetSummaryLifecycleStateEnum
GetExportSetSummaryLifecycleStateEnumValues Enumerates the set of values for ExportSetSummaryLifecycleState
type ExportSummary ¶
type ExportSummary struct { // The OCID of this export's export set. ExportSetId *string `mandatory:"true" json:"exportSetId"` // The OCID of this export's file system. FileSystemId *string `mandatory:"true" json:"fileSystemId"` // The OCID 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"` }
ExportSummary Summary information for an export.
func (ExportSummary) String ¶
func (m ExportSummary) String() string
type ExportSummaryLifecycleStateEnum ¶
type ExportSummaryLifecycleStateEnum string
ExportSummaryLifecycleStateEnum Enum with underlying type: string
const ( ExportSummaryLifecycleStateCreating ExportSummaryLifecycleStateEnum = "CREATING" ExportSummaryLifecycleStateActive ExportSummaryLifecycleStateEnum = "ACTIVE" ExportSummaryLifecycleStateDeleting ExportSummaryLifecycleStateEnum = "DELETING" ExportSummaryLifecycleStateDeleted ExportSummaryLifecycleStateEnum = "DELETED" )
Set of constants representing the allowable values for ExportSummaryLifecycleState
func GetExportSummaryLifecycleStateEnumValues ¶
func GetExportSummaryLifecycleStateEnumValues() []ExportSummaryLifecycleStateEnum
GetExportSummaryLifecycleStateEnumValues Enumerates the set of values for ExportSummaryLifecycleState
type FileStorageClient ¶
type FileStorageClient struct { common.BaseClient // contains filtered or unexported fields }
FileStorageClient a client for FileStorage
func NewFileStorageClientWithConfigurationProvider ¶
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 (*FileStorageClient) ConfigurationProvider ¶
func (client *FileStorageClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (FileStorageClient) CreateExport ¶
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.
func (FileStorageClient) CreateFileSystem ¶
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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about availability domains, see Regions and Availability Domains (https://docs.us-phoenix-1.oraclecloud.com/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). 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.
func (FileStorageClient) CreateMountTarget ¶
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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about availability domains, see Regions and Availability Domains (https://docs.us-phoenix-1.oraclecloud.com/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). 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.
func (FileStorageClient) CreateSnapshot ¶
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>`.
func (FileStorageClient) DeleteExport ¶
func (client FileStorageClient) DeleteExport(ctx context.Context, request DeleteExportRequest) (response DeleteExportResponse, err error)
DeleteExport Deletes the specified export.
func (FileStorageClient) DeleteFileSystem ¶
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.
func (FileStorageClient) DeleteMountTarget ¶
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.
func (FileStorageClient) DeleteSnapshot ¶
func (client FileStorageClient) DeleteSnapshot(ctx context.Context, request DeleteSnapshotRequest) (response DeleteSnapshotResponse, err error)
DeleteSnapshot Deletes the specified snapshot.
func (FileStorageClient) GetExport ¶
func (client FileStorageClient) GetExport(ctx context.Context, request GetExportRequest) (response GetExportResponse, err error)
GetExport Gets the specified export's information.
func (FileStorageClient) GetExportSet ¶
func (client FileStorageClient) GetExportSet(ctx context.Context, request GetExportSetRequest) (response GetExportSetResponse, err error)
GetExportSet Gets the specified export set's information.
func (FileStorageClient) GetFileSystem ¶
func (client FileStorageClient) GetFileSystem(ctx context.Context, request GetFileSystemRequest) (response GetFileSystemResponse, err error)
GetFileSystem Gets the specified file system's information.
func (FileStorageClient) GetMountTarget ¶
func (client FileStorageClient) GetMountTarget(ctx context.Context, request GetMountTargetRequest) (response GetMountTargetResponse, err error)
GetMountTarget Gets the specified mount target's information.
func (FileStorageClient) GetSnapshot ¶
func (client FileStorageClient) GetSnapshot(ctx context.Context, request GetSnapshotRequest) (response GetSnapshotResponse, err error)
GetSnapshot Gets the specified snapshot's information.
func (FileStorageClient) ListExportSets ¶
func (client FileStorageClient) ListExportSets(ctx context.Context, request ListExportSetsRequest) (response ListExportSetsResponse, err error)
ListExportSets Lists the export set resources in the specified compartment.
func (FileStorageClient) ListExports ¶
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.
func (FileStorageClient) ListFileSystems ¶
func (client FileStorageClient) ListFileSystems(ctx context.Context, request ListFileSystemsRequest) (response ListFileSystemsResponse, err error)
ListFileSystems Lists the file system resources in the specified compartment.
func (FileStorageClient) ListMountTargets ¶
func (client FileStorageClient) ListMountTargets(ctx context.Context, request ListMountTargetsRequest) (response ListMountTargetsResponse, err error)
ListMountTargets Lists the mount target resources in the specified compartment.
func (FileStorageClient) ListSnapshots ¶
func (client FileStorageClient) ListSnapshots(ctx context.Context, request ListSnapshotsRequest) (response ListSnapshotsResponse, err error)
ListSnapshots Lists snapshots of the specified file system.
func (*FileStorageClient) SetRegion ¶
func (client *FileStorageClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (FileStorageClient) UpdateExport ¶
func (client FileStorageClient) UpdateExport(ctx context.Context, request UpdateExportRequest) (response UpdateExportResponse, err error)
UpdateExport Updates the specified export's information.
func (FileStorageClient) UpdateExportSet ¶
func (client FileStorageClient) UpdateExportSet(ctx context.Context, request UpdateExportSetRequest) (response UpdateExportSetResponse, err error)
UpdateExportSet Updates the specified export set's information.
func (FileStorageClient) UpdateFileSystem ¶
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.
func (FileStorageClient) UpdateMountTarget ¶
func (client FileStorageClient) UpdateMountTarget(ctx context.Context, request UpdateMountTargetRequest) (response UpdateMountTargetResponse, err error)
UpdateMountTarget Updates the specified mount target's information.
type FileSystem ¶
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. MeteredBytes *int64 `mandatory:"true" json:"meteredBytes"` // The OCID 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 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"` }
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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
func (FileSystem) String ¶
func (m FileSystem) String() string
type FileSystemLifecycleStateEnum ¶
type FileSystemLifecycleStateEnum string
FileSystemLifecycleStateEnum Enum with underlying type: string
const ( FileSystemLifecycleStateCreating FileSystemLifecycleStateEnum = "CREATING" FileSystemLifecycleStateActive FileSystemLifecycleStateEnum = "ACTIVE" FileSystemLifecycleStateDeleting FileSystemLifecycleStateEnum = "DELETING" FileSystemLifecycleStateDeleted FileSystemLifecycleStateEnum = "DELETED" )
Set of constants representing the allowable values for FileSystemLifecycleState
func GetFileSystemLifecycleStateEnumValues ¶
func GetFileSystemLifecycleStateEnumValues() []FileSystemLifecycleStateEnum
GetFileSystemLifecycleStateEnumValues Enumerates the set of values for FileSystemLifecycleState
type FileSystemSummary ¶
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 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 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"` }
FileSystemSummary Summary information for a file system.
func (FileSystemSummary) String ¶
func (m FileSystemSummary) String() string
type FileSystemSummaryLifecycleStateEnum ¶
type FileSystemSummaryLifecycleStateEnum string
FileSystemSummaryLifecycleStateEnum Enum with underlying type: string
const ( FileSystemSummaryLifecycleStateCreating FileSystemSummaryLifecycleStateEnum = "CREATING" FileSystemSummaryLifecycleStateActive FileSystemSummaryLifecycleStateEnum = "ACTIVE" FileSystemSummaryLifecycleStateDeleting FileSystemSummaryLifecycleStateEnum = "DELETING" FileSystemSummaryLifecycleStateDeleted FileSystemSummaryLifecycleStateEnum = "DELETED" )
Set of constants representing the allowable values for FileSystemSummaryLifecycleState
func GetFileSystemSummaryLifecycleStateEnumValues ¶
func GetFileSystemSummaryLifecycleStateEnumValues() []FileSystemSummaryLifecycleStateEnum
GetFileSystemSummaryLifecycleStateEnumValues Enumerates the set of values for FileSystemSummaryLifecycleState
type GetExportRequest ¶
type GetExportRequest struct { // The OCID of the export. ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"` // Unique Oracle-assigned 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 }
GetExportRequest wrapper for the GetExport operation
func (GetExportRequest) HTTPRequest ¶ added in v1.3.0
func (request GetExportRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetExportRequest) RetryPolicy ¶ added in v1.3.0
func (request GetExportRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetExportRequest) String ¶
func (request GetExportRequest) String() string
type GetExportResponse ¶
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"` }
GetExportResponse wrapper for the GetExport operation
func (GetExportResponse) HTTPResponse ¶ added in v1.3.0
func (response GetExportResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetExportResponse) String ¶
func (response GetExportResponse) String() string
type GetExportSetRequest ¶
type GetExportSetRequest struct { // The OCID of the export set. ExportSetId *string `mandatory:"true" contributesTo:"path" name:"exportSetId"` // Unique Oracle-assigned 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 }
GetExportSetRequest wrapper for the GetExportSet operation
func (GetExportSetRequest) HTTPRequest ¶ added in v1.3.0
func (request GetExportSetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetExportSetRequest) RetryPolicy ¶ added in v1.3.0
func (request GetExportSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetExportSetRequest) String ¶
func (request GetExportSetRequest) String() string
type GetExportSetResponse ¶
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"` }
GetExportSetResponse wrapper for the GetExportSet operation
func (GetExportSetResponse) HTTPResponse ¶ added in v1.3.0
func (response GetExportSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetExportSetResponse) String ¶
func (response GetExportSetResponse) String() string
type GetFileSystemRequest ¶
type GetFileSystemRequest struct { // The OCID of the file system. FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"` // Unique Oracle-assigned 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 }
GetFileSystemRequest wrapper for the GetFileSystem operation
func (GetFileSystemRequest) HTTPRequest ¶ added in v1.3.0
func (request GetFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetFileSystemRequest) RetryPolicy ¶ added in v1.3.0
func (request GetFileSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetFileSystemRequest) String ¶
func (request GetFileSystemRequest) String() string
type GetFileSystemResponse ¶
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"` }
GetFileSystemResponse wrapper for the GetFileSystem operation
func (GetFileSystemResponse) HTTPResponse ¶ added in v1.3.0
func (response GetFileSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetFileSystemResponse) String ¶
func (response GetFileSystemResponse) String() string
type GetMountTargetRequest ¶
type GetMountTargetRequest struct { // The OCID of the mount target. MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"` // Unique Oracle-assigned 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 }
GetMountTargetRequest wrapper for the GetMountTarget operation
func (GetMountTargetRequest) HTTPRequest ¶ added in v1.3.0
func (request GetMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetMountTargetRequest) RetryPolicy ¶ added in v1.3.0
func (request GetMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetMountTargetRequest) String ¶
func (request GetMountTargetRequest) String() string
type GetMountTargetResponse ¶
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"` }
GetMountTargetResponse wrapper for the GetMountTarget operation
func (GetMountTargetResponse) HTTPResponse ¶ added in v1.3.0
func (response GetMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetMountTargetResponse) String ¶
func (response GetMountTargetResponse) String() string
type GetSnapshotRequest ¶
type GetSnapshotRequest struct { // The OCID of the snapshot. SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"` // Unique Oracle-assigned 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 }
GetSnapshotRequest wrapper for the GetSnapshot operation
func (GetSnapshotRequest) HTTPRequest ¶ added in v1.3.0
func (request GetSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetSnapshotRequest) RetryPolicy ¶ added in v1.3.0
func (request GetSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetSnapshotRequest) String ¶
func (request GetSnapshotRequest) String() string
type GetSnapshotResponse ¶
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"` }
GetSnapshotResponse wrapper for the GetSnapshot operation
func (GetSnapshotResponse) HTTPResponse ¶ added in v1.3.0
func (response GetSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetSnapshotResponse) String ¶
func (response GetSnapshotResponse) String() string
type ListExportSetsLifecycleStateEnum ¶
type ListExportSetsLifecycleStateEnum string
ListExportSetsLifecycleStateEnum Enum with underlying type: string
const ( ListExportSetsLifecycleStateCreating ListExportSetsLifecycleStateEnum = "CREATING" ListExportSetsLifecycleStateActive ListExportSetsLifecycleStateEnum = "ACTIVE" ListExportSetsLifecycleStateDeleting ListExportSetsLifecycleStateEnum = "DELETING" ListExportSetsLifecycleStateDeleted ListExportSetsLifecycleStateEnum = "DELETED" ListExportSetsLifecycleStateFailed ListExportSetsLifecycleStateEnum = "FAILED" )
Set of constants representing the allowable values for ListExportSetsLifecycleState
func GetListExportSetsLifecycleStateEnumValues ¶
func GetListExportSetsLifecycleStateEnumValues() []ListExportSetsLifecycleStateEnum
GetListExportSetsLifecycleStateEnumValues Enumerates the set of values for ListExportSetsLifecycleState
type ListExportSetsRequest ¶
type ListExportSetsRequest struct { // The OCID 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"` // The maximum number of items to return in a paginated "List" call. // Example: `500` Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. 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. 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. SortOrder ListExportSetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Unique Oracle-assigned 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 }
ListExportSetsRequest wrapper for the ListExportSets operation
func (ListExportSetsRequest) HTTPRequest ¶ added in v1.3.0
func (request ListExportSetsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListExportSetsRequest) RetryPolicy ¶ added in v1.3.0
func (request ListExportSetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListExportSetsRequest) String ¶
func (request ListExportSetsRequest) String() string
type ListExportSetsResponse ¶
type ListExportSetsResponse struct { // The underlying http response RawResponse *http.Response // A list of []ExportSetSummary instances Items []ExportSetSummary `presentIn:"body"` // For pagination of a list of items. When paging through // a list, if this header appears in the response, then a // partial list might have been returned. Include this // value as the `page` parameter for the subsequent GET // request to get the next batch of items. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If // you need to contact Oracle about a particular request, // please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
ListExportSetsResponse wrapper for the ListExportSets operation
func (ListExportSetsResponse) HTTPResponse ¶ added in v1.3.0
func (response ListExportSetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListExportSetsResponse) String ¶
func (response ListExportSetsResponse) String() string
type ListExportSetsSortByEnum ¶
type ListExportSetsSortByEnum string
ListExportSetsSortByEnum Enum with underlying type: string
const ( ListExportSetsSortByTimecreated ListExportSetsSortByEnum = "TIMECREATED" ListExportSetsSortByDisplayname ListExportSetsSortByEnum = "DISPLAYNAME" )
Set of constants representing the allowable values for ListExportSetsSortBy
func GetListExportSetsSortByEnumValues ¶
func GetListExportSetsSortByEnumValues() []ListExportSetsSortByEnum
GetListExportSetsSortByEnumValues Enumerates the set of values for ListExportSetsSortBy
type ListExportSetsSortOrderEnum ¶
type ListExportSetsSortOrderEnum string
ListExportSetsSortOrderEnum Enum with underlying type: string
const ( ListExportSetsSortOrderAsc ListExportSetsSortOrderEnum = "ASC" ListExportSetsSortOrderDesc ListExportSetsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListExportSetsSortOrder
func GetListExportSetsSortOrderEnumValues ¶
func GetListExportSetsSortOrderEnumValues() []ListExportSetsSortOrderEnum
GetListExportSetsSortOrderEnumValues Enumerates the set of values for ListExportSetsSortOrder
type ListExportsLifecycleStateEnum ¶
type ListExportsLifecycleStateEnum string
ListExportsLifecycleStateEnum Enum with underlying type: string
const ( ListExportsLifecycleStateCreating ListExportsLifecycleStateEnum = "CREATING" ListExportsLifecycleStateActive ListExportsLifecycleStateEnum = "ACTIVE" ListExportsLifecycleStateDeleting ListExportsLifecycleStateEnum = "DELETING" ListExportsLifecycleStateDeleted ListExportsLifecycleStateEnum = "DELETED" ListExportsLifecycleStateFailed ListExportsLifecycleStateEnum = "FAILED" )
Set of constants representing the allowable values for ListExportsLifecycleState
func GetListExportsLifecycleStateEnumValues ¶
func GetListExportsLifecycleStateEnumValues() []ListExportsLifecycleStateEnum
GetListExportsLifecycleStateEnumValues Enumerates the set of values for ListExportsLifecycleState
type ListExportsRequest ¶
type ListExportsRequest struct { // The OCID of the compartment. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // The maximum number of items to return in a paginated "List" call. // Example: `500` Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The OCID of the export set. ExportSetId *string `mandatory:"false" contributesTo:"query" name:"exportSetId"` // The OCID 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. 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. SortOrder ListExportsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Unique Oracle-assigned 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 }
ListExportsRequest wrapper for the ListExports operation
func (ListExportsRequest) HTTPRequest ¶ added in v1.3.0
func (request ListExportsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListExportsRequest) RetryPolicy ¶ added in v1.3.0
func (request ListExportsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListExportsRequest) String ¶
func (request ListExportsRequest) String() string
type ListExportsResponse ¶
type ListExportsResponse struct { // The underlying http response RawResponse *http.Response // A list of []ExportSummary instances Items []ExportSummary `presentIn:"body"` // For pagination of a list of items. When paging through // a list, if this header appears in the response, then a // partial list might have been returned. Include this // value as the `page` parameter for the subsequent GET // request to get the next batch of items. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If // you need to contact Oracle about a particular request, // please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
ListExportsResponse wrapper for the ListExports operation
func (ListExportsResponse) HTTPResponse ¶ added in v1.3.0
func (response ListExportsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListExportsResponse) String ¶
func (response ListExportsResponse) String() string
type ListExportsSortByEnum ¶
type ListExportsSortByEnum string
ListExportsSortByEnum Enum with underlying type: string
const ( ListExportsSortByTimecreated ListExportsSortByEnum = "TIMECREATED" ListExportsSortByPath ListExportsSortByEnum = "PATH" )
Set of constants representing the allowable values for ListExportsSortBy
func GetListExportsSortByEnumValues ¶
func GetListExportsSortByEnumValues() []ListExportsSortByEnum
GetListExportsSortByEnumValues Enumerates the set of values for ListExportsSortBy
type ListExportsSortOrderEnum ¶
type ListExportsSortOrderEnum string
ListExportsSortOrderEnum Enum with underlying type: string
const ( ListExportsSortOrderAsc ListExportsSortOrderEnum = "ASC" ListExportsSortOrderDesc ListExportsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListExportsSortOrder
func GetListExportsSortOrderEnumValues ¶
func GetListExportsSortOrderEnumValues() []ListExportsSortOrderEnum
GetListExportsSortOrderEnumValues Enumerates the set of values for ListExportsSortOrder
type ListFileSystemsLifecycleStateEnum ¶
type ListFileSystemsLifecycleStateEnum string
ListFileSystemsLifecycleStateEnum Enum with underlying type: string
const ( ListFileSystemsLifecycleStateCreating ListFileSystemsLifecycleStateEnum = "CREATING" ListFileSystemsLifecycleStateActive ListFileSystemsLifecycleStateEnum = "ACTIVE" ListFileSystemsLifecycleStateDeleting ListFileSystemsLifecycleStateEnum = "DELETING" ListFileSystemsLifecycleStateDeleted ListFileSystemsLifecycleStateEnum = "DELETED" ListFileSystemsLifecycleStateFailed ListFileSystemsLifecycleStateEnum = "FAILED" )
Set of constants representing the allowable values for ListFileSystemsLifecycleState
func GetListFileSystemsLifecycleStateEnumValues ¶
func GetListFileSystemsLifecycleStateEnumValues() []ListFileSystemsLifecycleStateEnum
GetListFileSystemsLifecycleStateEnumValues Enumerates the set of values for ListFileSystemsLifecycleState
type ListFileSystemsRequest ¶
type ListFileSystemsRequest struct { // The OCID 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"` // The maximum number of items to return in a paginated "List" call. // Example: `500` Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. 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. 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 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. SortOrder ListFileSystemsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Unique Oracle-assigned 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 }
ListFileSystemsRequest wrapper for the ListFileSystems operation
func (ListFileSystemsRequest) HTTPRequest ¶ added in v1.3.0
func (request ListFileSystemsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListFileSystemsRequest) RetryPolicy ¶ added in v1.3.0
func (request ListFileSystemsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListFileSystemsRequest) String ¶
func (request ListFileSystemsRequest) String() string
type ListFileSystemsResponse ¶
type ListFileSystemsResponse struct { // The underlying http response RawResponse *http.Response // A list of []FileSystemSummary instances Items []FileSystemSummary `presentIn:"body"` // For pagination of a list of items. When paging through // a list, if this header appears in the response, then a // partial list might have been returned. Include this // value as the `page` parameter for the subsequent GET // request to get the next batch of items. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If // you need to contact Oracle about a particular request, // please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
ListFileSystemsResponse wrapper for the ListFileSystems operation
func (ListFileSystemsResponse) HTTPResponse ¶ added in v1.3.0
func (response ListFileSystemsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListFileSystemsResponse) String ¶
func (response ListFileSystemsResponse) String() string
type ListFileSystemsSortByEnum ¶
type ListFileSystemsSortByEnum string
ListFileSystemsSortByEnum Enum with underlying type: string
const ( ListFileSystemsSortByTimecreated ListFileSystemsSortByEnum = "TIMECREATED" ListFileSystemsSortByDisplayname ListFileSystemsSortByEnum = "DISPLAYNAME" )
Set of constants representing the allowable values for ListFileSystemsSortBy
func GetListFileSystemsSortByEnumValues ¶
func GetListFileSystemsSortByEnumValues() []ListFileSystemsSortByEnum
GetListFileSystemsSortByEnumValues Enumerates the set of values for ListFileSystemsSortBy
type ListFileSystemsSortOrderEnum ¶
type ListFileSystemsSortOrderEnum string
ListFileSystemsSortOrderEnum Enum with underlying type: string
const ( ListFileSystemsSortOrderAsc ListFileSystemsSortOrderEnum = "ASC" ListFileSystemsSortOrderDesc ListFileSystemsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListFileSystemsSortOrder
func GetListFileSystemsSortOrderEnumValues ¶
func GetListFileSystemsSortOrderEnumValues() []ListFileSystemsSortOrderEnum
GetListFileSystemsSortOrderEnumValues Enumerates the set of values for ListFileSystemsSortOrder
type ListMountTargetsLifecycleStateEnum ¶
type ListMountTargetsLifecycleStateEnum string
ListMountTargetsLifecycleStateEnum Enum with underlying type: string
const ( ListMountTargetsLifecycleStateCreating ListMountTargetsLifecycleStateEnum = "CREATING" ListMountTargetsLifecycleStateActive ListMountTargetsLifecycleStateEnum = "ACTIVE" ListMountTargetsLifecycleStateDeleting ListMountTargetsLifecycleStateEnum = "DELETING" ListMountTargetsLifecycleStateDeleted ListMountTargetsLifecycleStateEnum = "DELETED" ListMountTargetsLifecycleStateFailed ListMountTargetsLifecycleStateEnum = "FAILED" )
Set of constants representing the allowable values for ListMountTargetsLifecycleState
func GetListMountTargetsLifecycleStateEnumValues ¶
func GetListMountTargetsLifecycleStateEnumValues() []ListMountTargetsLifecycleStateEnum
GetListMountTargetsLifecycleStateEnumValues Enumerates the set of values for ListMountTargetsLifecycleState
type ListMountTargetsRequest ¶
type ListMountTargetsRequest struct { // The OCID 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"` // The maximum number of items to return in a paginated "List" call. // Example: `500` Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. 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 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. 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. SortOrder ListMountTargetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Unique Oracle-assigned 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 }
ListMountTargetsRequest wrapper for the ListMountTargets operation
func (ListMountTargetsRequest) HTTPRequest ¶ added in v1.3.0
func (request ListMountTargetsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListMountTargetsRequest) RetryPolicy ¶ added in v1.3.0
func (request ListMountTargetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListMountTargetsRequest) String ¶
func (request ListMountTargetsRequest) String() string
type ListMountTargetsResponse ¶
type ListMountTargetsResponse struct { // The underlying http response RawResponse *http.Response // A list of []MountTargetSummary instances Items []MountTargetSummary `presentIn:"body"` // For pagination of a list of items. When paging through // a list, if this header appears in the response, then a // partial list might have been returned. Include this // value as the `page` parameter for the subsequent GET // request to get the next batch of items. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If // you need to contact Oracle about a particular request, // please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
ListMountTargetsResponse wrapper for the ListMountTargets operation
func (ListMountTargetsResponse) HTTPResponse ¶ added in v1.3.0
func (response ListMountTargetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListMountTargetsResponse) String ¶
func (response ListMountTargetsResponse) String() string
type ListMountTargetsSortByEnum ¶
type ListMountTargetsSortByEnum string
ListMountTargetsSortByEnum Enum with underlying type: string
const ( ListMountTargetsSortByTimecreated ListMountTargetsSortByEnum = "TIMECREATED" ListMountTargetsSortByDisplayname ListMountTargetsSortByEnum = "DISPLAYNAME" )
Set of constants representing the allowable values for ListMountTargetsSortBy
func GetListMountTargetsSortByEnumValues ¶
func GetListMountTargetsSortByEnumValues() []ListMountTargetsSortByEnum
GetListMountTargetsSortByEnumValues Enumerates the set of values for ListMountTargetsSortBy
type ListMountTargetsSortOrderEnum ¶
type ListMountTargetsSortOrderEnum string
ListMountTargetsSortOrderEnum Enum with underlying type: string
const ( ListMountTargetsSortOrderAsc ListMountTargetsSortOrderEnum = "ASC" ListMountTargetsSortOrderDesc ListMountTargetsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListMountTargetsSortOrder
func GetListMountTargetsSortOrderEnumValues ¶
func GetListMountTargetsSortOrderEnumValues() []ListMountTargetsSortOrderEnum
GetListMountTargetsSortOrderEnumValues Enumerates the set of values for ListMountTargetsSortOrder
type ListSnapshotsLifecycleStateEnum ¶
type ListSnapshotsLifecycleStateEnum string
ListSnapshotsLifecycleStateEnum Enum with underlying type: string
const ( ListSnapshotsLifecycleStateCreating ListSnapshotsLifecycleStateEnum = "CREATING" ListSnapshotsLifecycleStateActive ListSnapshotsLifecycleStateEnum = "ACTIVE" ListSnapshotsLifecycleStateDeleting ListSnapshotsLifecycleStateEnum = "DELETING" ListSnapshotsLifecycleStateDeleted ListSnapshotsLifecycleStateEnum = "DELETED" ListSnapshotsLifecycleStateFailed ListSnapshotsLifecycleStateEnum = "FAILED" )
Set of constants representing the allowable values for ListSnapshotsLifecycleState
func GetListSnapshotsLifecycleStateEnumValues ¶
func GetListSnapshotsLifecycleStateEnumValues() []ListSnapshotsLifecycleStateEnum
GetListSnapshotsLifecycleStateEnumValues Enumerates the set of values for ListSnapshotsLifecycleState
type ListSnapshotsRequest ¶
type ListSnapshotsRequest struct { // The OCID of the file system. FileSystemId *string `mandatory:"true" contributesTo:"query" name:"fileSystemId"` // The maximum number of items to return in a paginated "List" call. // Example: `500` Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. 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. Must be an OCID of the correct type for // the resouce type. Id *string `mandatory:"false" contributesTo:"query" name:"id"` // The sort order to use, either 'asc' or 'desc', where 'asc' is // ascending and 'desc' is descending. SortOrder ListSnapshotsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Unique Oracle-assigned 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 }
ListSnapshotsRequest wrapper for the ListSnapshots operation
func (ListSnapshotsRequest) HTTPRequest ¶ added in v1.3.0
func (request ListSnapshotsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListSnapshotsRequest) RetryPolicy ¶ added in v1.3.0
func (request ListSnapshotsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListSnapshotsRequest) String ¶
func (request ListSnapshotsRequest) String() string
type ListSnapshotsResponse ¶
type ListSnapshotsResponse struct { // The underlying http response RawResponse *http.Response // A list of []SnapshotSummary instances Items []SnapshotSummary `presentIn:"body"` // For pagination of a list of items. When paging through // a list, if this header appears in the response, then a // partial list might have been returned. Include this // value as the `page` parameter for the subsequent GET // request to get the next batch of items. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If // you need to contact Oracle about a particular request, // please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
ListSnapshotsResponse wrapper for the ListSnapshots operation
func (ListSnapshotsResponse) HTTPResponse ¶ added in v1.3.0
func (response ListSnapshotsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListSnapshotsResponse) String ¶
func (response ListSnapshotsResponse) String() string
type ListSnapshotsSortOrderEnum ¶
type ListSnapshotsSortOrderEnum string
ListSnapshotsSortOrderEnum Enum with underlying type: string
const ( ListSnapshotsSortOrderAsc ListSnapshotsSortOrderEnum = "ASC" ListSnapshotsSortOrderDesc ListSnapshotsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListSnapshotsSortOrder
func GetListSnapshotsSortOrderEnumValues ¶
func GetListSnapshotsSortOrderEnumValues() []ListSnapshotsSortOrderEnum
GetListSnapshotsSortOrderEnumValues Enumerates the set of values for ListSnapshotsSortOrder
type MountTarget ¶
type MountTarget struct { // The OCID 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 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 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 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"` }
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.
func (MountTarget) String ¶
func (m MountTarget) String() string
type MountTargetLifecycleStateEnum ¶
type MountTargetLifecycleStateEnum string
MountTargetLifecycleStateEnum Enum with underlying type: string
const ( MountTargetLifecycleStateCreating MountTargetLifecycleStateEnum = "CREATING" MountTargetLifecycleStateActive MountTargetLifecycleStateEnum = "ACTIVE" MountTargetLifecycleStateDeleting MountTargetLifecycleStateEnum = "DELETING" MountTargetLifecycleStateDeleted MountTargetLifecycleStateEnum = "DELETED" MountTargetLifecycleStateFailed MountTargetLifecycleStateEnum = "FAILED" )
Set of constants representing the allowable values for MountTargetLifecycleState
func GetMountTargetLifecycleStateEnumValues ¶
func GetMountTargetLifecycleStateEnumValues() []MountTargetLifecycleStateEnum
GetMountTargetLifecycleStateEnumValues Enumerates the set of values for MountTargetLifecycleState
type MountTargetSummary ¶
type MountTargetSummary struct { // The OCID 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 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 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 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"` }
MountTargetSummary Summary information for the specified mount target.
func (MountTargetSummary) String ¶
func (m MountTargetSummary) String() string
type MountTargetSummaryLifecycleStateEnum ¶
type MountTargetSummaryLifecycleStateEnum string
MountTargetSummaryLifecycleStateEnum Enum with underlying type: string
const ( MountTargetSummaryLifecycleStateCreating MountTargetSummaryLifecycleStateEnum = "CREATING" MountTargetSummaryLifecycleStateActive MountTargetSummaryLifecycleStateEnum = "ACTIVE" MountTargetSummaryLifecycleStateDeleting MountTargetSummaryLifecycleStateEnum = "DELETING" MountTargetSummaryLifecycleStateDeleted MountTargetSummaryLifecycleStateEnum = "DELETED" MountTargetSummaryLifecycleStateFailed MountTargetSummaryLifecycleStateEnum = "FAILED" )
Set of constants representing the allowable values for MountTargetSummaryLifecycleState
func GetMountTargetSummaryLifecycleStateEnumValues ¶
func GetMountTargetSummaryLifecycleStateEnumValues() []MountTargetSummaryLifecycleStateEnum
GetMountTargetSummaryLifecycleStateEnumValues Enumerates the set of values for MountTargetSummaryLifecycleState
type Snapshot ¶
type Snapshot struct { // The OCID of the file system from which the snapshot // was created. FileSystemId *string `mandatory:"true" json:"fileSystemId"` // The OCID 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"` }
Snapshot A point-in-time snapshot of a specified file system.
type SnapshotLifecycleStateEnum ¶
type SnapshotLifecycleStateEnum string
SnapshotLifecycleStateEnum Enum with underlying type: string
const ( SnapshotLifecycleStateCreating SnapshotLifecycleStateEnum = "CREATING" SnapshotLifecycleStateActive SnapshotLifecycleStateEnum = "ACTIVE" SnapshotLifecycleStateDeleting SnapshotLifecycleStateEnum = "DELETING" SnapshotLifecycleStateDeleted SnapshotLifecycleStateEnum = "DELETED" )
Set of constants representing the allowable values for SnapshotLifecycleState
func GetSnapshotLifecycleStateEnumValues ¶
func GetSnapshotLifecycleStateEnumValues() []SnapshotLifecycleStateEnum
GetSnapshotLifecycleStateEnumValues Enumerates the set of values for SnapshotLifecycleState
type SnapshotSummary ¶
type SnapshotSummary struct { // The OCID of the file system from which the // snapshot was created. FileSystemId *string `mandatory:"true" json:"fileSystemId"` // The OCID 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"` }
SnapshotSummary Summary information for a snapshot.
func (SnapshotSummary) String ¶
func (m SnapshotSummary) String() string
type SnapshotSummaryLifecycleStateEnum ¶
type SnapshotSummaryLifecycleStateEnum string
SnapshotSummaryLifecycleStateEnum Enum with underlying type: string
const ( SnapshotSummaryLifecycleStateCreating SnapshotSummaryLifecycleStateEnum = "CREATING" SnapshotSummaryLifecycleStateActive SnapshotSummaryLifecycleStateEnum = "ACTIVE" SnapshotSummaryLifecycleStateDeleting SnapshotSummaryLifecycleStateEnum = "DELETING" SnapshotSummaryLifecycleStateDeleted SnapshotSummaryLifecycleStateEnum = "DELETED" )
Set of constants representing the allowable values for SnapshotSummaryLifecycleState
func GetSnapshotSummaryLifecycleStateEnumValues ¶
func GetSnapshotSummaryLifecycleStateEnumValues() []SnapshotSummaryLifecycleStateEnum
GetSnapshotSummaryLifecycleStateEnumValues Enumerates the set of values for SnapshotSummaryLifecycleState
type UpdateExportDetails ¶
type UpdateExportDetails struct { // 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"` }
UpdateExportDetails The representation of UpdateExportDetails
func (UpdateExportDetails) String ¶
func (m UpdateExportDetails) String() string
type UpdateExportRequest ¶
type UpdateExportRequest struct { // The OCID 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 Oracle-assigned 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 }
UpdateExportRequest wrapper for the UpdateExport operation
func (UpdateExportRequest) HTTPRequest ¶
func (request UpdateExportRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (UpdateExportRequest) RetryPolicy ¶
func (request UpdateExportRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (UpdateExportRequest) String ¶
func (request UpdateExportRequest) String() string
type UpdateExportResponse ¶
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"` }
UpdateExportResponse wrapper for the UpdateExport operation
func (UpdateExportResponse) HTTPResponse ¶
func (response UpdateExportResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (UpdateExportResponse) String ¶
func (response UpdateExportResponse) String() string
type UpdateExportSetDetails ¶
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"` }
UpdateExportSetDetails The representation of UpdateExportSetDetails
func (UpdateExportSetDetails) String ¶
func (m UpdateExportSetDetails) String() string
type UpdateExportSetRequest ¶
type UpdateExportSetRequest struct { // The OCID 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 Oracle-assigned 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 }
UpdateExportSetRequest wrapper for the UpdateExportSet operation
func (UpdateExportSetRequest) HTTPRequest ¶ added in v1.3.0
func (request UpdateExportSetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (UpdateExportSetRequest) RetryPolicy ¶ added in v1.3.0
func (request UpdateExportSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (UpdateExportSetRequest) String ¶
func (request UpdateExportSetRequest) String() string
type UpdateExportSetResponse ¶
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"` }
UpdateExportSetResponse wrapper for the UpdateExportSet operation
func (UpdateExportSetResponse) HTTPResponse ¶ added in v1.3.0
func (response UpdateExportSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (UpdateExportSetResponse) String ¶
func (response UpdateExportSetResponse) String() string
type UpdateFileSystemDetails ¶
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"` }
UpdateFileSystemDetails The representation of UpdateFileSystemDetails
func (UpdateFileSystemDetails) String ¶
func (m UpdateFileSystemDetails) String() string
type UpdateFileSystemRequest ¶
type UpdateFileSystemRequest struct { // The OCID 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 Oracle-assigned 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 }
UpdateFileSystemRequest wrapper for the UpdateFileSystem operation
func (UpdateFileSystemRequest) HTTPRequest ¶ added in v1.3.0
func (request UpdateFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (UpdateFileSystemRequest) RetryPolicy ¶ added in v1.3.0
func (request UpdateFileSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (UpdateFileSystemRequest) String ¶
func (request UpdateFileSystemRequest) String() string
type UpdateFileSystemResponse ¶
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"` }
UpdateFileSystemResponse wrapper for the UpdateFileSystem operation
func (UpdateFileSystemResponse) HTTPResponse ¶ added in v1.3.0
func (response UpdateFileSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (UpdateFileSystemResponse) String ¶
func (response UpdateFileSystemResponse) String() string
type UpdateMountTargetDetails ¶
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"` }
UpdateMountTargetDetails The representation of UpdateMountTargetDetails
func (UpdateMountTargetDetails) String ¶
func (m UpdateMountTargetDetails) String() string
type UpdateMountTargetRequest ¶
type UpdateMountTargetRequest struct { // The OCID 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 Oracle-assigned 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 }
UpdateMountTargetRequest wrapper for the UpdateMountTarget operation
func (UpdateMountTargetRequest) HTTPRequest ¶ added in v1.3.0
func (request UpdateMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (UpdateMountTargetRequest) RetryPolicy ¶ added in v1.3.0
func (request UpdateMountTargetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (UpdateMountTargetRequest) String ¶
func (request UpdateMountTargetRequest) String() string
type UpdateMountTargetResponse ¶
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"` }
UpdateMountTargetResponse wrapper for the UpdateMountTarget operation
func (UpdateMountTargetResponse) HTTPResponse ¶ added in v1.3.0
func (response UpdateMountTargetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (UpdateMountTargetResponse) String ¶
func (response UpdateMountTargetResponse) String() string
Source Files ¶
- client_options.go
- create_export_details.go
- create_export_request_response.go
- create_file_system_details.go
- create_file_system_request_response.go
- create_mount_target_details.go
- create_mount_target_request_response.go
- create_snapshot_details.go
- create_snapshot_request_response.go
- delete_export_request_response.go
- delete_file_system_request_response.go
- delete_mount_target_request_response.go
- delete_snapshot_request_response.go
- export.go
- export_set.go
- export_set_summary.go
- export_summary.go
- file_system.go
- file_system_summary.go
- filestorage_client.go
- get_export_request_response.go
- get_export_set_request_response.go
- get_file_system_request_response.go
- get_mount_target_request_response.go
- get_snapshot_request_response.go
- list_export_sets_request_response.go
- list_exports_request_response.go
- list_file_systems_request_response.go
- list_mount_targets_request_response.go
- list_snapshots_request_response.go
- mount_target.go
- mount_target_summary.go
- snapshot.go
- snapshot_summary.go
- update_export_details.go
- update_export_request_response.go
- update_export_set_details.go
- update_export_set_request_response.go
- update_file_system_details.go
- update_file_system_request_response.go
- update_mount_target_details.go
- update_mount_target_request_response.go