...

Package filestorage

import "github.com/oracle/oci-go-sdk/filestorage"
Overview
Index

Overview ▾

Index ▾

type ChangeFileSystemCompartmentDetails
    func (m ChangeFileSystemCompartmentDetails) String() string
type ChangeFileSystemCompartmentRequest
    func (request ChangeFileSystemCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeFileSystemCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeFileSystemCompartmentRequest) String() string
type ChangeFileSystemCompartmentResponse
    func (response ChangeFileSystemCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeFileSystemCompartmentResponse) String() string
type ChangeMountTargetCompartmentDetails
    func (m ChangeMountTargetCompartmentDetails) String() string
type ChangeMountTargetCompartmentRequest
    func (request ChangeMountTargetCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeMountTargetCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeMountTargetCompartmentRequest) String() string
type ChangeMountTargetCompartmentResponse
    func (response ChangeMountTargetCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeMountTargetCompartmentResponse) String() string
type ClientOptions
    func (m ClientOptions) String() string
type ClientOptionsAccessEnum
    func GetClientOptionsAccessEnumValues() []ClientOptionsAccessEnum
type ClientOptionsIdentitySquashEnum
    func GetClientOptionsIdentitySquashEnumValues() []ClientOptionsIdentitySquashEnum
type CreateExportDetails
    func (m CreateExportDetails) String() string
type CreateExportRequest
    func (request CreateExportRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateExportRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateExportRequest) String() string
type CreateExportResponse
    func (response CreateExportResponse) HTTPResponse() *http.Response
    func (response CreateExportResponse) String() string
type CreateFileSystemDetails
    func (m CreateFileSystemDetails) String() string
type CreateFileSystemRequest
    func (request CreateFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateFileSystemRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateFileSystemRequest) String() string
type CreateFileSystemResponse
    func (response CreateFileSystemResponse) HTTPResponse() *http.Response
    func (response CreateFileSystemResponse) String() string
type CreateMountTargetDetails
    func (m CreateMountTargetDetails) String() string
type CreateMountTargetRequest
    func (request CreateMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateMountTargetRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateMountTargetRequest) String() string
type CreateMountTargetResponse
    func (response CreateMountTargetResponse) HTTPResponse() *http.Response
    func (response CreateMountTargetResponse) String() string
type CreateSnapshotDetails
    func (m CreateSnapshotDetails) String() string
type CreateSnapshotRequest
    func (request CreateSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateSnapshotRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateSnapshotRequest) String() string
type CreateSnapshotResponse
    func (response CreateSnapshotResponse) HTTPResponse() *http.Response
    func (response CreateSnapshotResponse) String() string
type DeleteExportRequest
    func (request DeleteExportRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteExportRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteExportRequest) String() string
type DeleteExportResponse
    func (response DeleteExportResponse) HTTPResponse() *http.Response
    func (response DeleteExportResponse) String() string
type DeleteFileSystemRequest
    func (request DeleteFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteFileSystemRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteFileSystemRequest) String() string
type DeleteFileSystemResponse
    func (response DeleteFileSystemResponse) HTTPResponse() *http.Response
    func (response DeleteFileSystemResponse) String() string
type DeleteMountTargetRequest
    func (request DeleteMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteMountTargetRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteMountTargetRequest) String() string
type DeleteMountTargetResponse
    func (response DeleteMountTargetResponse) HTTPResponse() *http.Response
    func (response DeleteMountTargetResponse) String() string
type DeleteSnapshotRequest
    func (request DeleteSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteSnapshotRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteSnapshotRequest) String() string
type DeleteSnapshotResponse
    func (response DeleteSnapshotResponse) HTTPResponse() *http.Response
    func (response DeleteSnapshotResponse) String() string
type Export
    func (m Export) String() string
type ExportLifecycleStateEnum
    func GetExportLifecycleStateEnumValues() []ExportLifecycleStateEnum
type ExportSet
    func (m ExportSet) String() string
type ExportSetLifecycleStateEnum
    func GetExportSetLifecycleStateEnumValues() []ExportSetLifecycleStateEnum
type ExportSetSummary
    func (m ExportSetSummary) String() string
type ExportSetSummaryLifecycleStateEnum
    func GetExportSetSummaryLifecycleStateEnumValues() []ExportSetSummaryLifecycleStateEnum
type ExportSummary
    func (m ExportSummary) String() string
type ExportSummaryLifecycleStateEnum
    func GetExportSummaryLifecycleStateEnumValues() []ExportSummaryLifecycleStateEnum
type FileStorageClient
    func NewFileStorageClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client FileStorageClient, err error)
    func NewFileStorageClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client FileStorageClient, err error)
    func (client FileStorageClient) ChangeFileSystemCompartment(ctx context.Context, request ChangeFileSystemCompartmentRequest) (response ChangeFileSystemCompartmentResponse, err error)
    func (client FileStorageClient) ChangeMountTargetCompartment(ctx context.Context, request ChangeMountTargetCompartmentRequest) (response ChangeMountTargetCompartmentResponse, err error)
    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)
    func (client FileStorageClient) UpdateSnapshot(ctx context.Context, request UpdateSnapshotRequest) (response UpdateSnapshotResponse, err error)
type FileSystem
    func (m FileSystem) String() string
type FileSystemLifecycleStateEnum
    func GetFileSystemLifecycleStateEnumValues() []FileSystemLifecycleStateEnum
type FileSystemSummary
    func (m FileSystemSummary) String() string
type FileSystemSummaryLifecycleStateEnum
    func GetFileSystemSummaryLifecycleStateEnumValues() []FileSystemSummaryLifecycleStateEnum
type GetExportRequest
    func (request GetExportRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetExportRequest) RetryPolicy() *common.RetryPolicy
    func (request GetExportRequest) String() string
type GetExportResponse
    func (response GetExportResponse) HTTPResponse() *http.Response
    func (response GetExportResponse) String() string
type GetExportSetRequest
    func (request GetExportSetRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetExportSetRequest) RetryPolicy() *common.RetryPolicy
    func (request GetExportSetRequest) String() string
type GetExportSetResponse
    func (response GetExportSetResponse) HTTPResponse() *http.Response
    func (response GetExportSetResponse) String() string
type GetFileSystemRequest
    func (request GetFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetFileSystemRequest) RetryPolicy() *common.RetryPolicy
    func (request GetFileSystemRequest) String() string
type GetFileSystemResponse
    func (response GetFileSystemResponse) HTTPResponse() *http.Response
    func (response GetFileSystemResponse) String() string
type GetMountTargetRequest
    func (request GetMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetMountTargetRequest) RetryPolicy() *common.RetryPolicy
    func (request GetMountTargetRequest) String() string
type GetMountTargetResponse
    func (response GetMountTargetResponse) HTTPResponse() *http.Response
    func (response GetMountTargetResponse) String() string
type GetSnapshotRequest
    func (request GetSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetSnapshotRequest) RetryPolicy() *common.RetryPolicy
    func (request GetSnapshotRequest) String() string
type GetSnapshotResponse
    func (response GetSnapshotResponse) HTTPResponse() *http.Response
    func (response GetSnapshotResponse) String() string
type ListExportSetsLifecycleStateEnum
    func GetListExportSetsLifecycleStateEnumValues() []ListExportSetsLifecycleStateEnum
type ListExportSetsRequest
    func (request ListExportSetsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListExportSetsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListExportSetsRequest) String() string
type ListExportSetsResponse
    func (response ListExportSetsResponse) HTTPResponse() *http.Response
    func (response ListExportSetsResponse) String() string
type ListExportSetsSortByEnum
    func GetListExportSetsSortByEnumValues() []ListExportSetsSortByEnum
type ListExportSetsSortOrderEnum
    func GetListExportSetsSortOrderEnumValues() []ListExportSetsSortOrderEnum
type ListExportsLifecycleStateEnum
    func GetListExportsLifecycleStateEnumValues() []ListExportsLifecycleStateEnum
type ListExportsRequest
    func (request ListExportsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListExportsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListExportsRequest) String() string
type ListExportsResponse
    func (response ListExportsResponse) HTTPResponse() *http.Response
    func (response ListExportsResponse) String() string
type ListExportsSortByEnum
    func GetListExportsSortByEnumValues() []ListExportsSortByEnum
type ListExportsSortOrderEnum
    func GetListExportsSortOrderEnumValues() []ListExportsSortOrderEnum
type ListFileSystemsLifecycleStateEnum
    func GetListFileSystemsLifecycleStateEnumValues() []ListFileSystemsLifecycleStateEnum
type ListFileSystemsRequest
    func (request ListFileSystemsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListFileSystemsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListFileSystemsRequest) String() string
type ListFileSystemsResponse
    func (response ListFileSystemsResponse) HTTPResponse() *http.Response
    func (response ListFileSystemsResponse) String() string
type ListFileSystemsSortByEnum
    func GetListFileSystemsSortByEnumValues() []ListFileSystemsSortByEnum
type ListFileSystemsSortOrderEnum
    func GetListFileSystemsSortOrderEnumValues() []ListFileSystemsSortOrderEnum
type ListMountTargetsLifecycleStateEnum
    func GetListMountTargetsLifecycleStateEnumValues() []ListMountTargetsLifecycleStateEnum
type ListMountTargetsRequest
    func (request ListMountTargetsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListMountTargetsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListMountTargetsRequest) String() string
type ListMountTargetsResponse
    func (response ListMountTargetsResponse) HTTPResponse() *http.Response
    func (response ListMountTargetsResponse) String() string
type ListMountTargetsSortByEnum
    func GetListMountTargetsSortByEnumValues() []ListMountTargetsSortByEnum
type ListMountTargetsSortOrderEnum
    func GetListMountTargetsSortOrderEnumValues() []ListMountTargetsSortOrderEnum
type ListSnapshotsLifecycleStateEnum
    func GetListSnapshotsLifecycleStateEnumValues() []ListSnapshotsLifecycleStateEnum
type ListSnapshotsRequest
    func (request ListSnapshotsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListSnapshotsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListSnapshotsRequest) String() string
type ListSnapshotsResponse
    func (response ListSnapshotsResponse) HTTPResponse() *http.Response
    func (response ListSnapshotsResponse) String() string
type ListSnapshotsSortOrderEnum
    func GetListSnapshotsSortOrderEnumValues() []ListSnapshotsSortOrderEnum
type MountTarget
    func (m MountTarget) String() string
type MountTargetLifecycleStateEnum
    func GetMountTargetLifecycleStateEnumValues() []MountTargetLifecycleStateEnum
type MountTargetSummary
    func (m MountTargetSummary) String() string
type MountTargetSummaryLifecycleStateEnum
    func GetMountTargetSummaryLifecycleStateEnumValues() []MountTargetSummaryLifecycleStateEnum
type Snapshot
    func (m Snapshot) String() string
type SnapshotLifecycleStateEnum
    func GetSnapshotLifecycleStateEnumValues() []SnapshotLifecycleStateEnum
type SnapshotSummary
    func (m SnapshotSummary) String() string
type SnapshotSummaryLifecycleStateEnum
    func GetSnapshotSummaryLifecycleStateEnumValues() []SnapshotSummaryLifecycleStateEnum
type SourceDetails
    func (m SourceDetails) String() string
type UpdateExportDetails
    func (m UpdateExportDetails) String() string
type UpdateExportRequest
    func (request UpdateExportRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateExportRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateExportRequest) String() string
type UpdateExportResponse
    func (response UpdateExportResponse) HTTPResponse() *http.Response
    func (response UpdateExportResponse) String() string
type UpdateExportSetDetails
    func (m UpdateExportSetDetails) String() string
type UpdateExportSetRequest
    func (request UpdateExportSetRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateExportSetRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateExportSetRequest) String() string
type UpdateExportSetResponse
    func (response UpdateExportSetResponse) HTTPResponse() *http.Response
    func (response UpdateExportSetResponse) String() string
type UpdateFileSystemDetails
    func (m UpdateFileSystemDetails) String() string
type UpdateFileSystemRequest
    func (request UpdateFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateFileSystemRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateFileSystemRequest) String() string
type UpdateFileSystemResponse
    func (response UpdateFileSystemResponse) HTTPResponse() *http.Response
    func (response UpdateFileSystemResponse) String() string
type UpdateMountTargetDetails
    func (m UpdateMountTargetDetails) String() string
type UpdateMountTargetRequest
    func (request UpdateMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateMountTargetRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateMountTargetRequest) String() string
type UpdateMountTargetResponse
    func (response UpdateMountTargetResponse) HTTPResponse() *http.Response
    func (response UpdateMountTargetResponse) String() string
type UpdateSnapshotDetails
    func (m UpdateSnapshotDetails) String() string
type UpdateSnapshotRequest
    func (request UpdateSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateSnapshotRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateSnapshotRequest) String() string
type UpdateSnapshotResponse
    func (response UpdateSnapshotResponse) HTTPResponse() *http.Response
    func (response UpdateSnapshotResponse) String() string

Package files

change_file_system_compartment_details.go change_file_system_compartment_request_response.go change_mount_target_compartment_details.go change_mount_target_compartment_request_response.go 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 source_details.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 update_snapshot_details.go update_snapshot_request_response.go

type ChangeFileSystemCompartmentDetails

ChangeFileSystemCompartmentDetails Details for changing the compartment.

type ChangeFileSystemCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment to move the file system to.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangeFileSystemCompartmentDetails) String

func (m ChangeFileSystemCompartmentDetails) String() string

type ChangeFileSystemCompartmentRequest

ChangeFileSystemCompartmentRequest wrapper for the ChangeFileSystemCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ChangeFileSystemCompartment.go.html to see an example of how to use ChangeFileSystemCompartmentRequest.

type ChangeFileSystemCompartmentRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system.
    FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`

    // Details for changing the compartment.
    ChangeFileSystemCompartmentDetails `contributesTo:"body"`

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

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

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

func (ChangeFileSystemCompartmentRequest) HTTPRequest

func (request ChangeFileSystemCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeFileSystemCompartmentRequest) RetryPolicy

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

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

func (ChangeFileSystemCompartmentRequest) String

func (request ChangeFileSystemCompartmentRequest) String() string

type ChangeFileSystemCompartmentResponse

ChangeFileSystemCompartmentResponse wrapper for the ChangeFileSystemCompartment operation

type ChangeFileSystemCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ChangeFileSystemCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeFileSystemCompartmentResponse) String

func (response ChangeFileSystemCompartmentResponse) String() string

type ChangeMountTargetCompartmentDetails

ChangeMountTargetCompartmentDetails Details for changing the compartment.

type ChangeMountTargetCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment to move the mount target to.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangeMountTargetCompartmentDetails) String

func (m ChangeMountTargetCompartmentDetails) String() string

type ChangeMountTargetCompartmentRequest

ChangeMountTargetCompartmentRequest wrapper for the ChangeMountTargetCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ChangeMountTargetCompartment.go.html to see an example of how to use ChangeMountTargetCompartmentRequest.

type ChangeMountTargetCompartmentRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the mount target.
    MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`

    // Details for changing the compartment.
    ChangeMountTargetCompartmentDetails `contributesTo:"body"`

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

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

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

func (ChangeMountTargetCompartmentRequest) HTTPRequest

func (request ChangeMountTargetCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeMountTargetCompartmentRequest) RetryPolicy

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

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

func (ChangeMountTargetCompartmentRequest) String

func (request ChangeMountTargetCompartmentRequest) String() string

type ChangeMountTargetCompartmentResponse

ChangeMountTargetCompartmentResponse wrapper for the ChangeMountTargetCompartment operation

type ChangeMountTargetCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ChangeMountTargetCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeMountTargetCompartmentResponse) String

func (response ChangeMountTargetCompartmentResponse) String() string

type ClientOptions

ClientOptions NFS export options applied to a specified set of clients. Only governs access through the associated export. Access to the same file system through a different export (on the same or different mount target) will be governed by that export's export options.

type ClientOptions struct {

    // Clients these options should apply to. Must be a either
    // single IPv4 address or single IPv4 CIDR block.
    // **Note:** Access will also be limited by any applicable VCN
    // security rules and the ability to route IP packets to the
    // mount target. Mount targets do not have Internet-routable IP addresses.
    Source *string `mandatory:"true" json:"source"`

    // If `true`, clients accessing the file system through this
    // export must connect from a privileged source port. If
    // unspecified, defaults to `true`.
    RequirePrivilegedSourcePort *bool `mandatory:"false" json:"requirePrivilegedSourcePort"`

    // Type of access to grant clients using the file system
    // through this export. If unspecified defaults to `READ_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"`
}

func (ClientOptions) String

func (m ClientOptions) String() string

type ClientOptionsAccessEnum

ClientOptionsAccessEnum Enum with underlying type: string

type ClientOptionsAccessEnum string

Set of constants representing the allowable values for ClientOptionsAccessEnum

const (
    ClientOptionsAccessWrite ClientOptionsAccessEnum = "READ_WRITE"
    ClientOptionsAccessOnly  ClientOptionsAccessEnum = "READ_ONLY"
)

func GetClientOptionsAccessEnumValues

func GetClientOptionsAccessEnumValues() []ClientOptionsAccessEnum

GetClientOptionsAccessEnumValues Enumerates the set of values for ClientOptionsAccessEnum

type ClientOptionsIdentitySquashEnum

ClientOptionsIdentitySquashEnum Enum with underlying type: string

type ClientOptionsIdentitySquashEnum string

Set of constants representing the allowable values for ClientOptionsIdentitySquashEnum

const (
    ClientOptionsIdentitySquashNone ClientOptionsIdentitySquashEnum = "NONE"
    ClientOptionsIdentitySquashRoot ClientOptionsIdentitySquashEnum = "ROOT"
    ClientOptionsIdentitySquashAll  ClientOptionsIdentitySquashEnum = "ALL"
)

func GetClientOptionsIdentitySquashEnumValues

func GetClientOptionsIdentitySquashEnumValues() []ClientOptionsIdentitySquashEnum

GetClientOptionsIdentitySquashEnumValues Enumerates the set of values for ClientOptionsIdentitySquashEnum

type CreateExportDetails

CreateExportDetails Details for creating the export.

type CreateExportDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of this export's export set.
    ExportSetId *string `mandatory:"true" json:"exportSetId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of this export's file system.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

    // Path used to access the associated file system.
    // Avoid entering confidential information.
    // Example: `/mediafiles`
    Path *string `mandatory:"true" json:"path"`

    // Export options for the new export. 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"`
}

func (CreateExportDetails) String

func (m CreateExportDetails) String() string

type CreateExportRequest

CreateExportRequest wrapper for the CreateExport operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/CreateExport.go.html to see an example of how to use CreateExportRequest.

type CreateExportRequest struct {

    // Details for creating a new export.
    CreateExportDetails `contributesTo:"body"`

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

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

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

func (CreateExportRequest) HTTPRequest

func (request CreateExportRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateExportRequest) RetryPolicy

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

CreateExportResponse wrapper for the CreateExport operation

type CreateExportResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (CreateExportResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateExportResponse) String

func (response CreateExportResponse) String() string

type CreateFileSystemDetails

CreateFileSystemDetails Details for creating the file system.

type CreateFileSystemDetails struct {

    // The availability domain to create the file system in.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment to create the file system in.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `My file system`
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system.
    KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    SourceSnapshotId *string `mandatory:"false" json:"sourceSnapshotId"`
}

func (CreateFileSystemDetails) String

func (m CreateFileSystemDetails) String() string

type CreateFileSystemRequest

CreateFileSystemRequest wrapper for the CreateFileSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/CreateFileSystem.go.html to see an example of how to use CreateFileSystemRequest.

type CreateFileSystemRequest struct {

    // Details for creating a new file system.
    CreateFileSystemDetails `contributesTo:"body"`

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

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

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

func (CreateFileSystemRequest) HTTPRequest

func (request CreateFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateFileSystemRequest) RetryPolicy

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

CreateFileSystemResponse wrapper for the CreateFileSystem operation

type CreateFileSystemResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (CreateFileSystemResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateFileSystemResponse) String

func (response CreateFileSystemResponse) String() string

type CreateMountTargetDetails

CreateMountTargetDetails Details for creating the mount target.

type CreateMountTargetDetails struct {

    // The availability domain in which to create the mount target.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which to create the mount target.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet in which to create the mount target.
    SubnetId *string `mandatory:"true" json:"subnetId"`

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `My mount target`
    DisplayName *string `mandatory:"false" json:"displayName"`

    // The hostname for the mount target's IP address, used for
    // DNS resolution. The value is the hostname portion of the private IP
    // address's fully qualified domain name (FQDN). For example,
    // `files-1` in the FQDN `files-1.subnet123.vcn1.oraclevcn.com`.
    // Must be unique across all VNICs in the subnet and comply
    // with RFC 952 (https://tools.ietf.org/html/rfc952)
    // and RFC 1123 (https://tools.ietf.org/html/rfc1123).
    // For more information, see
    // DNS in Your Virtual Cloud Network (https://docs.cloud.oracle.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"`

    // A list of Network Security Group OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with this mount target.
    // A maximum of 5 is allowed.
    // Setting this to an empty array after the list is created removes the mount target from all NSGs.
    // For more information about NSGs, see Security Rules (https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
    NsgIds []string `mandatory:"false" json:"nsgIds"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateMountTargetDetails) String

func (m CreateMountTargetDetails) String() string

type CreateMountTargetRequest

CreateMountTargetRequest wrapper for the CreateMountTarget operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/CreateMountTarget.go.html to see an example of how to use CreateMountTargetRequest.

type CreateMountTargetRequest struct {

    // Details for creating a new mount target.
    CreateMountTargetDetails `contributesTo:"body"`

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

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

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

func (CreateMountTargetRequest) HTTPRequest

func (request CreateMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateMountTargetRequest) RetryPolicy

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

CreateMountTargetResponse wrapper for the CreateMountTarget operation

type CreateMountTargetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (CreateMountTargetResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateMountTargetResponse) String

func (response CreateMountTargetResponse) String() string

type CreateSnapshotDetails

CreateSnapshotDetails Details for creating the snapshot.

type CreateSnapshotDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system to take a snapshot of.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

    // Name of the snapshot. This value is immutable. It must also be unique with respect
    // to all other non-DELETED snapshots on the associated file
    // system.
    // Avoid entering confidential information.
    // Example: `Sunday`
    Name *string `mandatory:"true" json:"name"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateSnapshotDetails) String

func (m CreateSnapshotDetails) String() string

type CreateSnapshotRequest

CreateSnapshotRequest wrapper for the CreateSnapshot operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/CreateSnapshot.go.html to see an example of how to use CreateSnapshotRequest.

type CreateSnapshotRequest struct {

    // Details for creating a new snapshot.
    CreateSnapshotDetails `contributesTo:"body"`

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

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

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

func (CreateSnapshotRequest) HTTPRequest

func (request CreateSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSnapshotRequest) RetryPolicy

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

CreateSnapshotResponse wrapper for the CreateSnapshot operation

type CreateSnapshotResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (CreateSnapshotResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateSnapshotResponse) String

func (response CreateSnapshotResponse) String() string

type DeleteExportRequest

DeleteExportRequest wrapper for the DeleteExport operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/DeleteExport.go.html to see an example of how to use DeleteExportRequest.

type DeleteExportRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the export.
    ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"`

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

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

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

func (DeleteExportRequest) HTTPRequest

func (request DeleteExportRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteExportRequest) RetryPolicy

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

DeleteExportResponse wrapper for the DeleteExport operation

type DeleteExportResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (DeleteExportResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteExportResponse) String

func (response DeleteExportResponse) String() string

type DeleteFileSystemRequest

DeleteFileSystemRequest wrapper for the DeleteFileSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/DeleteFileSystem.go.html to see an example of how to use DeleteFileSystemRequest.

type DeleteFileSystemRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system.
    FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`

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

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

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

func (DeleteFileSystemRequest) HTTPRequest

func (request DeleteFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteFileSystemRequest) RetryPolicy

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

DeleteFileSystemResponse wrapper for the DeleteFileSystem operation

type DeleteFileSystemResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (DeleteFileSystemResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteFileSystemResponse) String

func (response DeleteFileSystemResponse) String() string

type DeleteMountTargetRequest

DeleteMountTargetRequest wrapper for the DeleteMountTarget operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/DeleteMountTarget.go.html to see an example of how to use DeleteMountTargetRequest.

type DeleteMountTargetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the mount target.
    MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`

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

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

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

func (DeleteMountTargetRequest) HTTPRequest

func (request DeleteMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteMountTargetRequest) RetryPolicy

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

DeleteMountTargetResponse wrapper for the DeleteMountTarget operation

type DeleteMountTargetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (DeleteMountTargetResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteMountTargetResponse) String

func (response DeleteMountTargetResponse) String() string

type DeleteSnapshotRequest

DeleteSnapshotRequest wrapper for the DeleteSnapshot operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/DeleteSnapshot.go.html to see an example of how to use DeleteSnapshotRequest.

type DeleteSnapshotRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the snapshot.
    SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`

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

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

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

func (DeleteSnapshotRequest) HTTPRequest

func (request DeleteSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSnapshotRequest) RetryPolicy

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

DeleteSnapshotResponse wrapper for the DeleteSnapshot operation

type DeleteSnapshotResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (DeleteSnapshotResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteSnapshotResponse) String

func (response DeleteSnapshotResponse) String() string

type Export

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.cloud.oracle.com/Content/File/Tasks/exportoptions.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

type Export struct {

    // Policies that apply to NFS requests made through this
    // export. `exportOptions` contains a sequential list of
    // `ClientOptions`. Each `ClientOptions` item defines the
    // export options that are applied to a specified
    // set of clients.
    // For each NFS request, the first `ClientOptions` option
    // in the list whose `source` attribute matches the source
    // IP address of the request is applied.
    // If a client source IP address does not match the `source`
    // property of any `ClientOptions` in the list, then the
    // export will be invisible to that client. This export will
    // not be returned by `MOUNTPROC_EXPORT` calls made by the client
    // and any attempt to mount or access the file system through
    // this export will result in an error.
    // **Exports without defined `ClientOptions` are invisible to all clients.**
    // If one export is invisible to a particular client, associated file
    // systems may still be accessible through other exports on the same
    // or different mount targets.
    // To completely deny client access to a file system, be sure that the client
    // source IP address is not included in any export for any mount target
    // associated with the file system.
    ExportOptions []ClientOptions `mandatory:"true" json:"exportOptions"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of this export's export set.
    ExportSetId *string `mandatory:"true" json:"exportSetId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of this export's file system.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of this export.
    Id *string `mandatory:"true" json:"id"`

    // The current state of this export.
    LifecycleState ExportLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // Path used to access the associated file system.
    // Avoid entering confidential information.
    // Example: `/accounting`
    Path *string `mandatory:"true" json:"path"`

    // The date and time the export was created, expressed
    // in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}

func (Export) String

func (m Export) String() string

type ExportLifecycleStateEnum

ExportLifecycleStateEnum Enum with underlying type: string

type ExportLifecycleStateEnum string

Set of constants representing the allowable values for ExportLifecycleStateEnum

const (
    ExportLifecycleStateCreating ExportLifecycleStateEnum = "CREATING"
    ExportLifecycleStateActive   ExportLifecycleStateEnum = "ACTIVE"
    ExportLifecycleStateDeleting ExportLifecycleStateEnum = "DELETING"
    ExportLifecycleStateDeleted  ExportLifecycleStateEnum = "DELETED"
)

func GetExportLifecycleStateEnumValues

func GetExportLifecycleStateEnumValues() []ExportLifecycleStateEnum

GetExportLifecycleStateEnumValues Enumerates the set of values for ExportLifecycleStateEnum

type ExportSet

ExportSet A set of file systems to export through one or more mount targets. Composed of zero or more export resources. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

type ExportSet struct {

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

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `My export set`
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the export set.
    Id *string `mandatory:"true" json:"id"`

    // The current state of the export set.
    LifecycleState ExportSetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The date and time the export set was created, expressed
    // in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the virtual cloud network (VCN) the export set is in.
    VcnId *string `mandatory:"true" json:"vcnId"`

    // The availability domain the export set is in. May be unset
    // as a blank or NULL value.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

    // Controls the maximum `tbytes`, `fbytes`, and `abytes`,
    // values reported by `NFS FSSTAT` calls through any associated
    // mount targets. This is an advanced feature. For most
    // applications, use the default value. The
    // `tbytes` value reported by `FSSTAT` will be
    // `maxFsStatBytes`. The value of `fbytes` and `abytes` will be
    // `maxFsStatBytes` minus the metered size of the file
    // system. If the metered size is larger than `maxFsStatBytes`,
    // then `fbytes` and `abytes` will both be '0'.
    MaxFsStatBytes *int64 `mandatory:"false" json:"maxFsStatBytes"`

    // Controls the maximum `tfiles`, `ffiles`, and `afiles`
    // values reported by `NFS FSSTAT` calls through any associated
    // mount targets. This is an advanced feature. For most
    // applications, use the default value. The
    // `tfiles` value reported by `FSSTAT` will be
    // `maxFsStatFiles`. The value of `ffiles` and `afiles` will be
    // `maxFsStatFiles` minus the metered size of the file
    // system. If the metered size is larger than `maxFsStatFiles`,
    // then `ffiles` and `afiles` will both be '0'.
    MaxFsStatFiles *int64 `mandatory:"false" json:"maxFsStatFiles"`
}

func (ExportSet) String

func (m ExportSet) String() string

type ExportSetLifecycleStateEnum

ExportSetLifecycleStateEnum Enum with underlying type: string

type ExportSetLifecycleStateEnum string

Set of constants representing the allowable values for ExportSetLifecycleStateEnum

const (
    ExportSetLifecycleStateCreating ExportSetLifecycleStateEnum = "CREATING"
    ExportSetLifecycleStateActive   ExportSetLifecycleStateEnum = "ACTIVE"
    ExportSetLifecycleStateDeleting ExportSetLifecycleStateEnum = "DELETING"
    ExportSetLifecycleStateDeleted  ExportSetLifecycleStateEnum = "DELETED"
)

func GetExportSetLifecycleStateEnumValues

func GetExportSetLifecycleStateEnumValues() []ExportSetLifecycleStateEnum

GetExportSetLifecycleStateEnumValues Enumerates the set of values for ExportSetLifecycleStateEnum

type ExportSetSummary

ExportSetSummary Summary information for an export set.

type ExportSetSummary struct {

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

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `My export set`
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the export set.
    Id *string `mandatory:"true" json:"id"`

    // The current state of the export set.
    LifecycleState ExportSetSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The date and time the export set was created, expressed
    // in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the virtual cloud network (VCN) the export set is in.
    VcnId *string `mandatory:"true" json:"vcnId"`

    // The availability domain the export set is in. May be unset
    // as a blank or NULL value.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
}

func (ExportSetSummary) String

func (m ExportSetSummary) String() string

type ExportSetSummaryLifecycleStateEnum

ExportSetSummaryLifecycleStateEnum Enum with underlying type: string

type ExportSetSummaryLifecycleStateEnum string

Set of constants representing the allowable values for ExportSetSummaryLifecycleStateEnum

const (
    ExportSetSummaryLifecycleStateCreating ExportSetSummaryLifecycleStateEnum = "CREATING"
    ExportSetSummaryLifecycleStateActive   ExportSetSummaryLifecycleStateEnum = "ACTIVE"
    ExportSetSummaryLifecycleStateDeleting ExportSetSummaryLifecycleStateEnum = "DELETING"
    ExportSetSummaryLifecycleStateDeleted  ExportSetSummaryLifecycleStateEnum = "DELETED"
)

func GetExportSetSummaryLifecycleStateEnumValues

func GetExportSetSummaryLifecycleStateEnumValues() []ExportSetSummaryLifecycleStateEnum

GetExportSetSummaryLifecycleStateEnumValues Enumerates the set of values for ExportSetSummaryLifecycleStateEnum

type ExportSummary

ExportSummary Summary information for an export.

type ExportSummary struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of this export's export set.
    ExportSetId *string `mandatory:"true" json:"exportSetId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of this export's file system.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of this export.
    Id *string `mandatory:"true" json:"id"`

    // The current state of this export.
    LifecycleState ExportSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // Path used to access the associated file system.
    // Avoid entering confidential information.
    // Example: `/mediafiles`
    Path *string `mandatory:"true" json:"path"`

    // The date and time the export was created, expressed
    // in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}

func (ExportSummary) String

func (m ExportSummary) String() string

type ExportSummaryLifecycleStateEnum

ExportSummaryLifecycleStateEnum Enum with underlying type: string

type ExportSummaryLifecycleStateEnum string

Set of constants representing the allowable values for ExportSummaryLifecycleStateEnum

const (
    ExportSummaryLifecycleStateCreating ExportSummaryLifecycleStateEnum = "CREATING"
    ExportSummaryLifecycleStateActive   ExportSummaryLifecycleStateEnum = "ACTIVE"
    ExportSummaryLifecycleStateDeleting ExportSummaryLifecycleStateEnum = "DELETING"
    ExportSummaryLifecycleStateDeleted  ExportSummaryLifecycleStateEnum = "DELETED"
)

func GetExportSummaryLifecycleStateEnumValues

func GetExportSummaryLifecycleStateEnumValues() []ExportSummaryLifecycleStateEnum

GetExportSummaryLifecycleStateEnumValues Enumerates the set of values for ExportSummaryLifecycleStateEnum

type FileStorageClient

FileStorageClient a client for FileStorage

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

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 NewFileStorageClientWithOboToken

func NewFileStorageClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client FileStorageClient, err error)

NewFileStorageClientWithOboToken Creates a new default FileStorage client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (FileStorageClient) ChangeFileSystemCompartment

func (client FileStorageClient) ChangeFileSystemCompartment(ctx context.Context, request ChangeFileSystemCompartmentRequest) (response ChangeFileSystemCompartmentResponse, err error)

ChangeFileSystemCompartment Moves a file system and its associated snapshots into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ChangeFileSystemCompartment.go.html to see an example of how to use ChangeFileSystemCompartment API.

func (FileStorageClient) ChangeMountTargetCompartment

func (client FileStorageClient) ChangeMountTargetCompartment(ctx context.Context, request ChangeMountTargetCompartmentRequest) (response ChangeMountTargetCompartmentResponse, err error)

ChangeMountTargetCompartment Moves a mount target and its associated export set into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ChangeMountTargetCompartment.go.html to see an example of how to use ChangeMountTargetCompartment API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/CreateExport.go.html to see an example of how to use CreateExport API.

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.cloud.oracle.com/Content/Identity/Concepts/overview.htm). For information about Network Security Groups access control, see Network Security Groups (https://docs.cloud.oracle.com/Content/Network/Concepts/networksecuritygroups.htm). For information about availability domains, see Regions and Availability Domains (https://docs.cloud.oracle.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 (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type or by viewing the resource in the Console.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/CreateFileSystem.go.html to see an example of how to use CreateFileSystem API.

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.cloud.oracle.com/Content/Identity/Concepts/overview.htm). For information about availability domains, see Regions and Availability Domains (https://docs.cloud.oracle.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 (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/CreateMountTarget.go.html to see an example of how to use CreateMountTarget API.

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>`.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/CreateSnapshot.go.html to see an example of how to use CreateSnapshot API.

func (FileStorageClient) DeleteExport

func (client FileStorageClient) DeleteExport(ctx context.Context, request DeleteExportRequest) (response DeleteExportResponse, err error)

DeleteExport Deletes the specified export.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/DeleteExport.go.html to see an example of how to use DeleteExport API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/DeleteFileSystem.go.html to see an example of how to use DeleteFileSystem API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/DeleteMountTarget.go.html to see an example of how to use DeleteMountTarget API.

func (FileStorageClient) DeleteSnapshot

func (client FileStorageClient) DeleteSnapshot(ctx context.Context, request DeleteSnapshotRequest) (response DeleteSnapshotResponse, err error)

DeleteSnapshot Deletes the specified snapshot.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/DeleteSnapshot.go.html to see an example of how to use DeleteSnapshot API.

func (FileStorageClient) GetExport

func (client FileStorageClient) GetExport(ctx context.Context, request GetExportRequest) (response GetExportResponse, err error)

GetExport Gets the specified export's information.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/GetExport.go.html to see an example of how to use GetExport API.

func (FileStorageClient) GetExportSet

func (client FileStorageClient) GetExportSet(ctx context.Context, request GetExportSetRequest) (response GetExportSetResponse, err error)

GetExportSet Gets the specified export set's information.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/GetExportSet.go.html to see an example of how to use GetExportSet API.

func (FileStorageClient) GetFileSystem

func (client FileStorageClient) GetFileSystem(ctx context.Context, request GetFileSystemRequest) (response GetFileSystemResponse, err error)

GetFileSystem Gets the specified file system's information.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/GetFileSystem.go.html to see an example of how to use GetFileSystem API.

func (FileStorageClient) GetMountTarget

func (client FileStorageClient) GetMountTarget(ctx context.Context, request GetMountTargetRequest) (response GetMountTargetResponse, err error)

GetMountTarget Gets the specified mount target's information.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/GetMountTarget.go.html to see an example of how to use GetMountTarget API.

func (FileStorageClient) GetSnapshot

func (client FileStorageClient) GetSnapshot(ctx context.Context, request GetSnapshotRequest) (response GetSnapshotResponse, err error)

GetSnapshot Gets the specified snapshot's information.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/GetSnapshot.go.html to see an example of how to use GetSnapshot API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ListExportSets.go.html to see an example of how to use ListExportSets API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ListExports.go.html to see an example of how to use ListExports API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ListFileSystems.go.html to see an example of how to use ListFileSystems API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ListMountTargets.go.html to see an example of how to use ListMountTargets API.

func (FileStorageClient) ListSnapshots

func (client FileStorageClient) ListSnapshots(ctx context.Context, request ListSnapshotsRequest) (response ListSnapshotsResponse, err error)

ListSnapshots Lists snapshots of the specified file system.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ListSnapshots.go.html to see an example of how to use ListSnapshots API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/UpdateExport.go.html to see an example of how to use UpdateExport API.

func (FileStorageClient) UpdateExportSet

func (client FileStorageClient) UpdateExportSet(ctx context.Context, request UpdateExportSetRequest) (response UpdateExportSetResponse, err error)

UpdateExportSet Updates the specified export set's information.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/UpdateExportSet.go.html to see an example of how to use UpdateExportSet API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/UpdateFileSystem.go.html to see an example of how to use UpdateFileSystem API.

func (FileStorageClient) UpdateMountTarget

func (client FileStorageClient) UpdateMountTarget(ctx context.Context, request UpdateMountTargetRequest) (response UpdateMountTargetResponse, err error)

UpdateMountTarget Updates the specified mount target's information.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/UpdateMountTarget.go.html to see an example of how to use UpdateMountTarget API.

func (FileStorageClient) UpdateSnapshot

func (client FileStorageClient) UpdateSnapshot(ctx context.Context, request UpdateSnapshotRequest) (response UpdateSnapshotResponse, err error)

UpdateSnapshot Updates the specified snapshot's information.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/UpdateSnapshot.go.html to see an example of how to use UpdateSnapshot API.

type FileSystem

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

type FileSystem struct {

    // The number of bytes consumed by the file system, including
    // any snapshots. This number reflects the metered size of the file
    // system and is updated asynchronously with respect to
    // updates to the file system.
    // For more information, see File System Usage and Metering (https://docs.cloud.oracle.com/Content/File/Concepts/FSutilization.htm).
    MeteredBytes *int64 `mandatory:"true" json:"meteredBytes"`

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

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `My file system`
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system.
    Id *string `mandatory:"true" json:"id"`

    // The current state of the file system.
    LifecycleState FileSystemLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The date and time the file system was created, expressed in
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The availability domain the file system is in. May be unset
    // as a blank or NULL value.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the KMS key which is the master encryption key for the file system.
    KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`

    SourceDetails *SourceDetails `mandatory:"false" json:"sourceDetails"`

    // Specifies whether the file system has been cloned.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    IsCloneParent *bool `mandatory:"false" json:"isCloneParent"`

    // Specifies whether the data has finished copying from the source to the clone.
    // Hydration can take up to several hours to complete depending on the size of the source.
    // The source and clone remain available during hydration, but there may be some performance impact.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm#hydration).
    IsHydrated *bool `mandatory:"false" json:"isHydrated"`

    // Additional information about the current 'lifecycleState'.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}

func (FileSystem) String

func (m FileSystem) String() string

type FileSystemLifecycleStateEnum

FileSystemLifecycleStateEnum Enum with underlying type: string

type FileSystemLifecycleStateEnum string

Set of constants representing the allowable values for FileSystemLifecycleStateEnum

const (
    FileSystemLifecycleStateCreating FileSystemLifecycleStateEnum = "CREATING"
    FileSystemLifecycleStateActive   FileSystemLifecycleStateEnum = "ACTIVE"
    FileSystemLifecycleStateDeleting FileSystemLifecycleStateEnum = "DELETING"
    FileSystemLifecycleStateDeleted  FileSystemLifecycleStateEnum = "DELETED"
)

func GetFileSystemLifecycleStateEnumValues

func GetFileSystemLifecycleStateEnumValues() []FileSystemLifecycleStateEnum

GetFileSystemLifecycleStateEnumValues Enumerates the set of values for FileSystemLifecycleStateEnum

type FileSystemSummary

FileSystemSummary Summary information for a file system.

type FileSystemSummary struct {

    // The number of bytes consumed by the file system, including
    // any snapshots. This number reflects the metered size of the file
    // system and is updated asynchronously with respect to
    // updates to the file system.
    MeteredBytes *int64 `mandatory:"true" json:"meteredBytes"`

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

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `My file system`
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system.
    Id *string `mandatory:"true" json:"id"`

    // The current state of the file system.
    LifecycleState FileSystemSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The date and time the file system was created, expressed
    // in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The availability domain the file system is in. May be unset
    // as a blank or NULL value.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system.
    KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`

    SourceDetails *SourceDetails `mandatory:"false" json:"sourceDetails"`

    // Specifies whether the file system has been cloned.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    IsCloneParent *bool `mandatory:"false" json:"isCloneParent"`

    // Specifies whether the data has finished copying from the source to the clone.
    // Hydration can take up to several hours to complete depending on the size of the source.
    // The source and clone remain available during hydration, but there may be some performance impact.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm#hydration).
    IsHydrated *bool `mandatory:"false" json:"isHydrated"`

    // Additional information about the current 'lifecycleState'.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}

func (FileSystemSummary) String

func (m FileSystemSummary) String() string

type FileSystemSummaryLifecycleStateEnum

FileSystemSummaryLifecycleStateEnum Enum with underlying type: string

type FileSystemSummaryLifecycleStateEnum string

Set of constants representing the allowable values for FileSystemSummaryLifecycleStateEnum

const (
    FileSystemSummaryLifecycleStateCreating FileSystemSummaryLifecycleStateEnum = "CREATING"
    FileSystemSummaryLifecycleStateActive   FileSystemSummaryLifecycleStateEnum = "ACTIVE"
    FileSystemSummaryLifecycleStateDeleting FileSystemSummaryLifecycleStateEnum = "DELETING"
    FileSystemSummaryLifecycleStateDeleted  FileSystemSummaryLifecycleStateEnum = "DELETED"
)

func GetFileSystemSummaryLifecycleStateEnumValues

func GetFileSystemSummaryLifecycleStateEnumValues() []FileSystemSummaryLifecycleStateEnum

GetFileSystemSummaryLifecycleStateEnumValues Enumerates the set of values for FileSystemSummaryLifecycleStateEnum

type GetExportRequest

GetExportRequest wrapper for the GetExport operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/GetExport.go.html to see an example of how to use GetExportRequest.

type GetExportRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the export.
    ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"`

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

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

func (GetExportRequest) HTTPRequest

func (request GetExportRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetExportRequest) RetryPolicy

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

GetExportResponse wrapper for the GetExport operation

type GetExportResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (GetExportResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetExportResponse) String

func (response GetExportResponse) String() string

type GetExportSetRequest

GetExportSetRequest wrapper for the GetExportSet operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/GetExportSet.go.html to see an example of how to use GetExportSetRequest.

type GetExportSetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the export set.
    ExportSetId *string `mandatory:"true" contributesTo:"path" name:"exportSetId"`

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

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

func (GetExportSetRequest) HTTPRequest

func (request GetExportSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetExportSetRequest) RetryPolicy

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

GetExportSetResponse wrapper for the GetExportSet operation

type GetExportSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (GetExportSetResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetExportSetResponse) String

func (response GetExportSetResponse) String() string

type GetFileSystemRequest

GetFileSystemRequest wrapper for the GetFileSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/GetFileSystem.go.html to see an example of how to use GetFileSystemRequest.

type GetFileSystemRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system.
    FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`

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

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

func (GetFileSystemRequest) HTTPRequest

func (request GetFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetFileSystemRequest) RetryPolicy

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

GetFileSystemResponse wrapper for the GetFileSystem operation

type GetFileSystemResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (GetFileSystemResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetFileSystemResponse) String

func (response GetFileSystemResponse) String() string

type GetMountTargetRequest

GetMountTargetRequest wrapper for the GetMountTarget operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/GetMountTarget.go.html to see an example of how to use GetMountTargetRequest.

type GetMountTargetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the mount target.
    MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`

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

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

func (GetMountTargetRequest) HTTPRequest

func (request GetMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetMountTargetRequest) RetryPolicy

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

GetMountTargetResponse wrapper for the GetMountTarget operation

type GetMountTargetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (GetMountTargetResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetMountTargetResponse) String

func (response GetMountTargetResponse) String() string

type GetSnapshotRequest

GetSnapshotRequest wrapper for the GetSnapshot operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/GetSnapshot.go.html to see an example of how to use GetSnapshotRequest.

type GetSnapshotRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the snapshot.
    SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`

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

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

func (GetSnapshotRequest) HTTPRequest

func (request GetSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSnapshotRequest) RetryPolicy

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

GetSnapshotResponse wrapper for the GetSnapshot operation

type GetSnapshotResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (GetSnapshotResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetSnapshotResponse) String

func (response GetSnapshotResponse) String() string

type ListExportSetsLifecycleStateEnum

ListExportSetsLifecycleStateEnum Enum with underlying type: string

type ListExportSetsLifecycleStateEnum string

Set of constants representing the allowable values for ListExportSetsLifecycleStateEnum

const (
    ListExportSetsLifecycleStateCreating ListExportSetsLifecycleStateEnum = "CREATING"
    ListExportSetsLifecycleStateActive   ListExportSetsLifecycleStateEnum = "ACTIVE"
    ListExportSetsLifecycleStateDeleting ListExportSetsLifecycleStateEnum = "DELETING"
    ListExportSetsLifecycleStateDeleted  ListExportSetsLifecycleStateEnum = "DELETED"
    ListExportSetsLifecycleStateFailed   ListExportSetsLifecycleStateEnum = "FAILED"
)

func GetListExportSetsLifecycleStateEnumValues

func GetListExportSetsLifecycleStateEnumValues() []ListExportSetsLifecycleStateEnum

GetListExportSetsLifecycleStateEnumValues Enumerates the set of values for ListExportSetsLifecycleStateEnum

type ListExportSetsRequest

ListExportSetsRequest wrapper for the ListExportSets operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ListExportSets.go.html to see an example of how to use ListExportSetsRequest.

type ListExportSetsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The name of the availability domain.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`

    // For list pagination. The maximum number of results per page,
    // or items to return in a paginated "List" call.
    // 1 is the minimum, 1000 is the maximum.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `500`
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response
    // header from the previous "List" call.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Example: `My resource`
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // Filter results by the specified lifecycle state. Must be a valid
    // state for the resource type.
    LifecycleState ListExportSetsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // Filter results by OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
    // the resouce type.
    Id *string `mandatory:"false" contributesTo:"query" name:"id"`

    // The field to sort by. You can provide either value, but not both.
    // By default, when you sort by time created, results are shown
    // in descending order. When you sort by display name, results are
    // shown in ascending order.
    SortBy ListExportSetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc', where 'asc' is
    // ascending and 'desc' is descending. The default order is 'desc'
    // except for numeric values.
    SortOrder ListExportSetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

func (ListExportSetsRequest) HTTPRequest

func (request ListExportSetsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListExportSetsRequest) RetryPolicy

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

ListExportSetsResponse wrapper for the ListExportSets operation

type ListExportSetsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For list pagination. When this header appears in the response,
    // additional pages of results remain.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

func (ListExportSetsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListExportSetsResponse) String

func (response ListExportSetsResponse) String() string

type ListExportSetsSortByEnum

ListExportSetsSortByEnum Enum with underlying type: string

type ListExportSetsSortByEnum string

Set of constants representing the allowable values for ListExportSetsSortByEnum

const (
    ListExportSetsSortByTimecreated ListExportSetsSortByEnum = "TIMECREATED"
    ListExportSetsSortByDisplayname ListExportSetsSortByEnum = "DISPLAYNAME"
)

func GetListExportSetsSortByEnumValues

func GetListExportSetsSortByEnumValues() []ListExportSetsSortByEnum

GetListExportSetsSortByEnumValues Enumerates the set of values for ListExportSetsSortByEnum

type ListExportSetsSortOrderEnum

ListExportSetsSortOrderEnum Enum with underlying type: string

type ListExportSetsSortOrderEnum string

Set of constants representing the allowable values for ListExportSetsSortOrderEnum

const (
    ListExportSetsSortOrderAsc  ListExportSetsSortOrderEnum = "ASC"
    ListExportSetsSortOrderDesc ListExportSetsSortOrderEnum = "DESC"
)

func GetListExportSetsSortOrderEnumValues

func GetListExportSetsSortOrderEnumValues() []ListExportSetsSortOrderEnum

GetListExportSetsSortOrderEnumValues Enumerates the set of values for ListExportSetsSortOrderEnum

type ListExportsLifecycleStateEnum

ListExportsLifecycleStateEnum Enum with underlying type: string

type ListExportsLifecycleStateEnum string

Set of constants representing the allowable values for ListExportsLifecycleStateEnum

const (
    ListExportsLifecycleStateCreating ListExportsLifecycleStateEnum = "CREATING"
    ListExportsLifecycleStateActive   ListExportsLifecycleStateEnum = "ACTIVE"
    ListExportsLifecycleStateDeleting ListExportsLifecycleStateEnum = "DELETING"
    ListExportsLifecycleStateDeleted  ListExportsLifecycleStateEnum = "DELETED"
    ListExportsLifecycleStateFailed   ListExportsLifecycleStateEnum = "FAILED"
)

func GetListExportsLifecycleStateEnumValues

func GetListExportsLifecycleStateEnumValues() []ListExportsLifecycleStateEnum

GetListExportsLifecycleStateEnumValues Enumerates the set of values for ListExportsLifecycleStateEnum

type ListExportsRequest

ListExportsRequest wrapper for the ListExports operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ListExports.go.html to see an example of how to use ListExportsRequest.

type ListExportsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // For list pagination. The maximum number of results per page,
    // or items to return in a paginated "List" call.
    // 1 is the minimum, 1000 is the maximum.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `500`
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response
    // header from the previous "List" call.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the export set.
    ExportSetId *string `mandatory:"false" contributesTo:"query" name:"exportSetId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system.
    FileSystemId *string `mandatory:"false" contributesTo:"query" name:"fileSystemId"`

    // Filter results by the specified lifecycle state. Must be a valid
    // state for the resource type.
    LifecycleState ListExportsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // Filter results by OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
    // the resouce type.
    Id *string `mandatory:"false" contributesTo:"query" name:"id"`

    // The field to sort by. You can provide either value, but not both.
    // By default, when you sort by time created, results are shown
    // in descending order. When you sort by path, results are
    // shown in ascending alphanumeric order.
    SortBy ListExportsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc', where 'asc' is
    // ascending and 'desc' is descending. The default order is 'desc'
    // except for numeric values.
    SortOrder ListExportsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

func (ListExportsRequest) HTTPRequest

func (request ListExportsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListExportsRequest) RetryPolicy

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

ListExportsResponse wrapper for the ListExports operation

type ListExportsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For list pagination. When this header appears in the response,
    // additional pages of results remain.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

func (ListExportsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListExportsResponse) String

func (response ListExportsResponse) String() string

type ListExportsSortByEnum

ListExportsSortByEnum Enum with underlying type: string

type ListExportsSortByEnum string

Set of constants representing the allowable values for ListExportsSortByEnum

const (
    ListExportsSortByTimecreated ListExportsSortByEnum = "TIMECREATED"
    ListExportsSortByPath        ListExportsSortByEnum = "PATH"
)

func GetListExportsSortByEnumValues

func GetListExportsSortByEnumValues() []ListExportsSortByEnum

GetListExportsSortByEnumValues Enumerates the set of values for ListExportsSortByEnum

type ListExportsSortOrderEnum

ListExportsSortOrderEnum Enum with underlying type: string

type ListExportsSortOrderEnum string

Set of constants representing the allowable values for ListExportsSortOrderEnum

const (
    ListExportsSortOrderAsc  ListExportsSortOrderEnum = "ASC"
    ListExportsSortOrderDesc ListExportsSortOrderEnum = "DESC"
)

func GetListExportsSortOrderEnumValues

func GetListExportsSortOrderEnumValues() []ListExportsSortOrderEnum

GetListExportsSortOrderEnumValues Enumerates the set of values for ListExportsSortOrderEnum

type ListFileSystemsLifecycleStateEnum

ListFileSystemsLifecycleStateEnum Enum with underlying type: string

type ListFileSystemsLifecycleStateEnum string

Set of constants representing the allowable values for ListFileSystemsLifecycleStateEnum

const (
    ListFileSystemsLifecycleStateCreating ListFileSystemsLifecycleStateEnum = "CREATING"
    ListFileSystemsLifecycleStateActive   ListFileSystemsLifecycleStateEnum = "ACTIVE"
    ListFileSystemsLifecycleStateDeleting ListFileSystemsLifecycleStateEnum = "DELETING"
    ListFileSystemsLifecycleStateDeleted  ListFileSystemsLifecycleStateEnum = "DELETED"
    ListFileSystemsLifecycleStateFailed   ListFileSystemsLifecycleStateEnum = "FAILED"
)

func GetListFileSystemsLifecycleStateEnumValues

func GetListFileSystemsLifecycleStateEnumValues() []ListFileSystemsLifecycleStateEnum

GetListFileSystemsLifecycleStateEnumValues Enumerates the set of values for ListFileSystemsLifecycleStateEnum

type ListFileSystemsRequest

ListFileSystemsRequest wrapper for the ListFileSystems operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ListFileSystems.go.html to see an example of how to use ListFileSystemsRequest.

type ListFileSystemsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The name of the availability domain.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`

    // For list pagination. The maximum number of results per page,
    // or items to return in a paginated "List" call.
    // 1 is the minimum, 1000 is the maximum.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `500`
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response
    // header from the previous "List" call.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Example: `My resource`
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // Filter results by the specified lifecycle state. Must be a valid
    // state for the resource type.
    LifecycleState ListFileSystemsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // Filter results by OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
    // the resouce type.
    Id *string `mandatory:"false" contributesTo:"query" name:"id"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system. See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    SourceSnapshotId *string `mandatory:"false" contributesTo:"query" name:"sourceSnapshotId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system that contains the source snapshot of a cloned file system. See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    ParentFileSystemId *string `mandatory:"false" contributesTo:"query" name:"parentFileSystemId"`

    // The field to sort by. You can provide either value, but not both.
    // By default, when you sort by time created, results are shown
    // in descending order. When you sort by display name, results are
    // shown in ascending order.
    SortBy ListFileSystemsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc', where 'asc' is
    // ascending and 'desc' is descending. The default order is 'desc'
    // except for numeric values.
    SortOrder ListFileSystemsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

func (ListFileSystemsRequest) HTTPRequest

func (request ListFileSystemsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListFileSystemsRequest) RetryPolicy

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

ListFileSystemsResponse wrapper for the ListFileSystems operation

type ListFileSystemsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For list pagination. When this header appears in the response,
    // additional pages of results remain.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

func (ListFileSystemsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListFileSystemsResponse) String

func (response ListFileSystemsResponse) String() string

type ListFileSystemsSortByEnum

ListFileSystemsSortByEnum Enum with underlying type: string

type ListFileSystemsSortByEnum string

Set of constants representing the allowable values for ListFileSystemsSortByEnum

const (
    ListFileSystemsSortByTimecreated ListFileSystemsSortByEnum = "TIMECREATED"
    ListFileSystemsSortByDisplayname ListFileSystemsSortByEnum = "DISPLAYNAME"
)

func GetListFileSystemsSortByEnumValues

func GetListFileSystemsSortByEnumValues() []ListFileSystemsSortByEnum

GetListFileSystemsSortByEnumValues Enumerates the set of values for ListFileSystemsSortByEnum

type ListFileSystemsSortOrderEnum

ListFileSystemsSortOrderEnum Enum with underlying type: string

type ListFileSystemsSortOrderEnum string

Set of constants representing the allowable values for ListFileSystemsSortOrderEnum

const (
    ListFileSystemsSortOrderAsc  ListFileSystemsSortOrderEnum = "ASC"
    ListFileSystemsSortOrderDesc ListFileSystemsSortOrderEnum = "DESC"
)

func GetListFileSystemsSortOrderEnumValues

func GetListFileSystemsSortOrderEnumValues() []ListFileSystemsSortOrderEnum

GetListFileSystemsSortOrderEnumValues Enumerates the set of values for ListFileSystemsSortOrderEnum

type ListMountTargetsLifecycleStateEnum

ListMountTargetsLifecycleStateEnum Enum with underlying type: string

type ListMountTargetsLifecycleStateEnum string

Set of constants representing the allowable values for ListMountTargetsLifecycleStateEnum

const (
    ListMountTargetsLifecycleStateCreating ListMountTargetsLifecycleStateEnum = "CREATING"
    ListMountTargetsLifecycleStateActive   ListMountTargetsLifecycleStateEnum = "ACTIVE"
    ListMountTargetsLifecycleStateDeleting ListMountTargetsLifecycleStateEnum = "DELETING"
    ListMountTargetsLifecycleStateDeleted  ListMountTargetsLifecycleStateEnum = "DELETED"
    ListMountTargetsLifecycleStateFailed   ListMountTargetsLifecycleStateEnum = "FAILED"
)

func GetListMountTargetsLifecycleStateEnumValues

func GetListMountTargetsLifecycleStateEnumValues() []ListMountTargetsLifecycleStateEnum

GetListMountTargetsLifecycleStateEnumValues Enumerates the set of values for ListMountTargetsLifecycleStateEnum

type ListMountTargetsRequest

ListMountTargetsRequest wrapper for the ListMountTargets operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ListMountTargets.go.html to see an example of how to use ListMountTargetsRequest.

type ListMountTargetsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The name of the availability domain.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`

    // For list pagination. The maximum number of results per page,
    // or items to return in a paginated "List" call.
    // 1 is the minimum, 1000 is the maximum.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `500`
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response
    // header from the previous "List" call.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Example: `My resource`
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the export set.
    ExportSetId *string `mandatory:"false" contributesTo:"query" name:"exportSetId"`

    // Filter results by the specified lifecycle state. Must be a valid
    // state for the resource type.
    LifecycleState ListMountTargetsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // Filter results by OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
    // the resouce type.
    Id *string `mandatory:"false" contributesTo:"query" name:"id"`

    // The field to sort by. You can choose either value, but not both.
    // By default, when you sort by time created, results are shown
    // in descending order. When you sort by display name, results are
    // shown in ascending order.
    SortBy ListMountTargetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc', where 'asc' is
    // ascending and 'desc' is descending. The default order is 'desc'
    // except for numeric values.
    SortOrder ListMountTargetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

func (ListMountTargetsRequest) HTTPRequest

func (request ListMountTargetsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListMountTargetsRequest) RetryPolicy

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

ListMountTargetsResponse wrapper for the ListMountTargets operation

type ListMountTargetsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For list pagination. When this header appears in the response,
    // additional pages of results remain.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

func (ListMountTargetsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListMountTargetsResponse) String

func (response ListMountTargetsResponse) String() string

type ListMountTargetsSortByEnum

ListMountTargetsSortByEnum Enum with underlying type: string

type ListMountTargetsSortByEnum string

Set of constants representing the allowable values for ListMountTargetsSortByEnum

const (
    ListMountTargetsSortByTimecreated ListMountTargetsSortByEnum = "TIMECREATED"
    ListMountTargetsSortByDisplayname ListMountTargetsSortByEnum = "DISPLAYNAME"
)

func GetListMountTargetsSortByEnumValues

func GetListMountTargetsSortByEnumValues() []ListMountTargetsSortByEnum

GetListMountTargetsSortByEnumValues Enumerates the set of values for ListMountTargetsSortByEnum

type ListMountTargetsSortOrderEnum

ListMountTargetsSortOrderEnum Enum with underlying type: string

type ListMountTargetsSortOrderEnum string

Set of constants representing the allowable values for ListMountTargetsSortOrderEnum

const (
    ListMountTargetsSortOrderAsc  ListMountTargetsSortOrderEnum = "ASC"
    ListMountTargetsSortOrderDesc ListMountTargetsSortOrderEnum = "DESC"
)

func GetListMountTargetsSortOrderEnumValues

func GetListMountTargetsSortOrderEnumValues() []ListMountTargetsSortOrderEnum

GetListMountTargetsSortOrderEnumValues Enumerates the set of values for ListMountTargetsSortOrderEnum

type ListSnapshotsLifecycleStateEnum

ListSnapshotsLifecycleStateEnum Enum with underlying type: string

type ListSnapshotsLifecycleStateEnum string

Set of constants representing the allowable values for ListSnapshotsLifecycleStateEnum

const (
    ListSnapshotsLifecycleStateCreating ListSnapshotsLifecycleStateEnum = "CREATING"
    ListSnapshotsLifecycleStateActive   ListSnapshotsLifecycleStateEnum = "ACTIVE"
    ListSnapshotsLifecycleStateDeleting ListSnapshotsLifecycleStateEnum = "DELETING"
    ListSnapshotsLifecycleStateDeleted  ListSnapshotsLifecycleStateEnum = "DELETED"
    ListSnapshotsLifecycleStateFailed   ListSnapshotsLifecycleStateEnum = "FAILED"
)

func GetListSnapshotsLifecycleStateEnumValues

func GetListSnapshotsLifecycleStateEnumValues() []ListSnapshotsLifecycleStateEnum

GetListSnapshotsLifecycleStateEnumValues Enumerates the set of values for ListSnapshotsLifecycleStateEnum

type ListSnapshotsRequest

ListSnapshotsRequest wrapper for the ListSnapshots operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/ListSnapshots.go.html to see an example of how to use ListSnapshotsRequest.

type ListSnapshotsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system.
    FileSystemId *string `mandatory:"true" contributesTo:"query" name:"fileSystemId"`

    // For list pagination. The maximum number of results per page,
    // or items to return in a paginated "List" call.
    // 1 is the minimum, 100 is the maximum.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `100`
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response
    // header from the previous "List" call.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Filter results by the specified lifecycle state. Must be a valid
    // state for the resource type.
    LifecycleState ListSnapshotsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // Filter results by OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
    // the resouce type.
    Id *string `mandatory:"false" contributesTo:"query" name:"id"`

    // The sort order to use, either 'asc' or 'desc', where 'asc' is
    // ascending and 'desc' is descending. The default order is 'desc'
    // except for numeric values.
    SortOrder ListSnapshotsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

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

func (ListSnapshotsRequest) HTTPRequest

func (request ListSnapshotsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSnapshotsRequest) RetryPolicy

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

ListSnapshotsResponse wrapper for the ListSnapshots operation

type ListSnapshotsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For list pagination. When this header appears in the response,
    // additional pages of results remain.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

func (ListSnapshotsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListSnapshotsResponse) String

func (response ListSnapshotsResponse) String() string

type ListSnapshotsSortOrderEnum

ListSnapshotsSortOrderEnum Enum with underlying type: string

type ListSnapshotsSortOrderEnum string

Set of constants representing the allowable values for ListSnapshotsSortOrderEnum

const (
    ListSnapshotsSortOrderAsc  ListSnapshotsSortOrderEnum = "ASC"
    ListSnapshotsSortOrderDesc ListSnapshotsSortOrderEnum = "DESC"
)

func GetListSnapshotsSortOrderEnumValues

func GetListSnapshotsSortOrderEnumValues() []ListSnapshotsSortOrderEnum

GetListSnapshotsSortOrderEnumValues Enumerates the set of values for ListSnapshotsSortOrderEnum

type MountTarget

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. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

type MountTarget struct {

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

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `My mount target`
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the mount target.
    Id *string `mandatory:"true" json:"id"`

    // Additional information about the current 'lifecycleState'.
    LifecycleDetails *string `mandatory:"true" json:"lifecycleDetails"`

    // The current state of the mount target.
    LifecycleState MountTargetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The OCIDs of the private IP addresses associated with this mount target.
    PrivateIpIds []string `mandatory:"true" json:"privateIpIds"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet the mount target is in.
    SubnetId *string `mandatory:"true" json:"subnetId"`

    // The date and time the mount target was created, expressed
    // in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The availability domain the mount target is in. May be unset
    // as a blank or NULL value.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the associated export set. Controls what file
    // systems will be exported through Network File System (NFS) protocol on this
    // mount target.
    ExportSetId *string `mandatory:"false" json:"exportSetId"`

    // A list of Network Security Group OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with this mount target.
    // A maximum of 5 is allowed.
    // Setting this to an empty array after the list is created removes the mount target from all NSGs.
    // For more information about NSGs, see Security Rules (https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
    NsgIds []string `mandatory:"false" json:"nsgIds"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (MountTarget) String

func (m MountTarget) String() string

type MountTargetLifecycleStateEnum

MountTargetLifecycleStateEnum Enum with underlying type: string

type MountTargetLifecycleStateEnum string

Set of constants representing the allowable values for MountTargetLifecycleStateEnum

const (
    MountTargetLifecycleStateCreating MountTargetLifecycleStateEnum = "CREATING"
    MountTargetLifecycleStateActive   MountTargetLifecycleStateEnum = "ACTIVE"
    MountTargetLifecycleStateDeleting MountTargetLifecycleStateEnum = "DELETING"
    MountTargetLifecycleStateDeleted  MountTargetLifecycleStateEnum = "DELETED"
    MountTargetLifecycleStateFailed   MountTargetLifecycleStateEnum = "FAILED"
)

func GetMountTargetLifecycleStateEnumValues

func GetMountTargetLifecycleStateEnumValues() []MountTargetLifecycleStateEnum

GetMountTargetLifecycleStateEnumValues Enumerates the set of values for MountTargetLifecycleStateEnum

type MountTargetSummary

MountTargetSummary Summary information for the specified mount target.

type MountTargetSummary struct {

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

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `My mount target`
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the mount target.
    Id *string `mandatory:"true" json:"id"`

    // The current state of the mount target.
    LifecycleState MountTargetSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The OCIDs of the private IP addresses associated with this mount target.
    PrivateIpIds []string `mandatory:"true" json:"privateIpIds"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet the mount target is in.
    SubnetId *string `mandatory:"true" json:"subnetId"`

    // The date and time the mount target was created, expressed
    // in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The availability domain the mount target is in. May be unset
    // as a blank or NULL value.
    // Example: `Uocm:PHX-AD-1`
    AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the associated export set. Controls what file
    // systems will be exported using Network File System (NFS) protocol on
    // this mount target.
    ExportSetId *string `mandatory:"false" json:"exportSetId"`

    // A list of Network Security Group OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with this mount target.
    // A maximum of 5 is allowed.
    // Setting this to an empty array after the list is created removes the mount target from all NSGs.
    // For more information about NSGs, see Security Rules (https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
    NsgIds []string `mandatory:"false" json:"nsgIds"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (MountTargetSummary) String

func (m MountTargetSummary) String() string

type MountTargetSummaryLifecycleStateEnum

MountTargetSummaryLifecycleStateEnum Enum with underlying type: string

type MountTargetSummaryLifecycleStateEnum string

Set of constants representing the allowable values for MountTargetSummaryLifecycleStateEnum

const (
    MountTargetSummaryLifecycleStateCreating MountTargetSummaryLifecycleStateEnum = "CREATING"
    MountTargetSummaryLifecycleStateActive   MountTargetSummaryLifecycleStateEnum = "ACTIVE"
    MountTargetSummaryLifecycleStateDeleting MountTargetSummaryLifecycleStateEnum = "DELETING"
    MountTargetSummaryLifecycleStateDeleted  MountTargetSummaryLifecycleStateEnum = "DELETED"
    MountTargetSummaryLifecycleStateFailed   MountTargetSummaryLifecycleStateEnum = "FAILED"
)

func GetMountTargetSummaryLifecycleStateEnumValues

func GetMountTargetSummaryLifecycleStateEnumValues() []MountTargetSummaryLifecycleStateEnum

GetMountTargetSummaryLifecycleStateEnumValues Enumerates the set of values for MountTargetSummaryLifecycleStateEnum

type Snapshot

Snapshot A point-in-time snapshot of a specified file system. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

type Snapshot struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system from which the snapshot
    // was created.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the snapshot.
    Id *string `mandatory:"true" json:"id"`

    // The current state of the snapshot.
    LifecycleState SnapshotLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // Name of the snapshot. This value is immutable.
    // Avoid entering confidential information.
    // Example: `Sunday`
    Name *string `mandatory:"true" json:"name"`

    // The date and time the snapshot was created, expressed
    // in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // An OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) identifying the parent from which this snapshot was cloned.
    // If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value.
    // If this snapshot was cloned, then the `provenanceId` value is the parent's `provenanceId`.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    ProvenanceId *string `mandatory:"false" json:"provenanceId"`

    // Specifies whether the snapshot has been cloned.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    IsCloneSource *bool `mandatory:"false" json:"isCloneSource"`

    // Additional information about the current 'lifecycleState'.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (Snapshot) String

func (m Snapshot) String() string

type SnapshotLifecycleStateEnum

SnapshotLifecycleStateEnum Enum with underlying type: string

type SnapshotLifecycleStateEnum string

Set of constants representing the allowable values for SnapshotLifecycleStateEnum

const (
    SnapshotLifecycleStateCreating SnapshotLifecycleStateEnum = "CREATING"
    SnapshotLifecycleStateActive   SnapshotLifecycleStateEnum = "ACTIVE"
    SnapshotLifecycleStateDeleting SnapshotLifecycleStateEnum = "DELETING"
    SnapshotLifecycleStateDeleted  SnapshotLifecycleStateEnum = "DELETED"
)

func GetSnapshotLifecycleStateEnumValues

func GetSnapshotLifecycleStateEnumValues() []SnapshotLifecycleStateEnum

GetSnapshotLifecycleStateEnumValues Enumerates the set of values for SnapshotLifecycleStateEnum

type SnapshotSummary

SnapshotSummary Summary information for a snapshot.

type SnapshotSummary struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system from which the snapshot was created.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the snapshot.
    Id *string `mandatory:"true" json:"id"`

    // The current state of the snapshot.
    LifecycleState SnapshotSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // Name of the snapshot. This value is immutable.
    // Avoid entering confidential information.
    // Example: `Sunday`
    Name *string `mandatory:"true" json:"name"`

    // The date and time the snapshot was created, expressed
    // in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // An OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) identifying the parent from which this snapshot was cloned.
    // If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value.
    // If this snapshot was cloned, then the `provenanceId` value is the parent's `provenanceId`.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    ProvenanceId *string `mandatory:"false" json:"provenanceId"`

    // Specifies whether the snapshot has been cloned.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    IsCloneSource *bool `mandatory:"false" json:"isCloneSource"`

    // Additional information about the current 'lifecycleState'.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (SnapshotSummary) String

func (m SnapshotSummary) String() string

type SnapshotSummaryLifecycleStateEnum

SnapshotSummaryLifecycleStateEnum Enum with underlying type: string

type SnapshotSummaryLifecycleStateEnum string

Set of constants representing the allowable values for SnapshotSummaryLifecycleStateEnum

const (
    SnapshotSummaryLifecycleStateCreating SnapshotSummaryLifecycleStateEnum = "CREATING"
    SnapshotSummaryLifecycleStateActive   SnapshotSummaryLifecycleStateEnum = "ACTIVE"
    SnapshotSummaryLifecycleStateDeleting SnapshotSummaryLifecycleStateEnum = "DELETING"
    SnapshotSummaryLifecycleStateDeleted  SnapshotSummaryLifecycleStateEnum = "DELETED"
)

func GetSnapshotSummaryLifecycleStateEnumValues

func GetSnapshotSummaryLifecycleStateEnumValues() []SnapshotSummaryLifecycleStateEnum

GetSnapshotSummaryLifecycleStateEnumValues Enumerates the set of values for SnapshotSummaryLifecycleStateEnum

type SourceDetails

SourceDetails Source information for the file system.

type SourceDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system that contains the source snapshot of a cloned file system.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    ParentFileSystemId *string `mandatory:"false" json:"parentFileSystemId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the source snapshot used to create a cloned file system.
    // See Cloning a File System (https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm).
    SourceSnapshotId *string `mandatory:"false" json:"sourceSnapshotId"`
}

func (SourceDetails) String

func (m SourceDetails) String() string

type UpdateExportDetails

UpdateExportDetails Details for updating the export.

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"`
}

func (UpdateExportDetails) String

func (m UpdateExportDetails) String() string

type UpdateExportRequest

UpdateExportRequest wrapper for the UpdateExport operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/UpdateExport.go.html to see an example of how to use UpdateExportRequest.

type UpdateExportRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the export.
    ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"`

    // Details object for updating an export.
    UpdateExportDetails `contributesTo:"body"`

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

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

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

func (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

UpdateExportResponse wrapper for the UpdateExport operation

type UpdateExportResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (UpdateExportResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateExportResponse) String

func (response UpdateExportResponse) String() string

type UpdateExportSetDetails

UpdateExportSetDetails Details for updating the export set.

type UpdateExportSetDetails struct {

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `My export set`
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Controls the maximum `tbytes`, `fbytes`, and `abytes`
    // values reported by `NFS FSSTAT` calls through any associated
    // mount targets. This is an advanced feature. For most
    // applications, use the default value. The
    // `tbytes` value reported by `FSSTAT` will be
    // `maxFsStatBytes`. The value of `fbytes` and `abytes` will be
    // `maxFsStatBytes` minus the metered size of the file
    // system. If the metered size is larger than `maxFsStatBytes`,
    // then `fbytes` and `abytes` will both be '0'.
    MaxFsStatBytes *int64 `mandatory:"false" json:"maxFsStatBytes"`

    // Controls the maximum `ffiles`, `ffiles`, and `afiles`
    // values reported by `NFS FSSTAT` calls through any associated
    // mount targets. This is an advanced feature. For most
    // applications, use the default value. The
    // `tfiles` value reported by `FSSTAT` will be
    // `maxFsStatFiles`. The value of `ffiles` and `afiles` will be
    // `maxFsStatFiles` minus the metered size of the file
    // system. If the metered size is larger than `maxFsStatFiles`,
    // then `ffiles` and `afiles` will both be '0'.
    MaxFsStatFiles *int64 `mandatory:"false" json:"maxFsStatFiles"`
}

func (UpdateExportSetDetails) String

func (m UpdateExportSetDetails) String() string

type UpdateExportSetRequest

UpdateExportSetRequest wrapper for the UpdateExportSet operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/UpdateExportSet.go.html to see an example of how to use UpdateExportSetRequest.

type UpdateExportSetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the export set.
    ExportSetId *string `mandatory:"true" contributesTo:"path" name:"exportSetId"`

    // Details object for updating an export set.
    UpdateExportSetDetails `contributesTo:"body"`

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

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

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

func (UpdateExportSetRequest) HTTPRequest

func (request UpdateExportSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateExportSetRequest) RetryPolicy

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

UpdateExportSetResponse wrapper for the UpdateExportSet operation

type UpdateExportSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (UpdateExportSetResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateExportSetResponse) String

func (response UpdateExportSetResponse) String() string

type UpdateFileSystemDetails

UpdateFileSystemDetails Details for updating the file system.

type UpdateFileSystemDetails struct {

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `My file system`
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Key Management master encryption key to associate with the specified file system. If this value is empty, the Update operation will remove the associated key, if there is one, from the file system. (The file system will continue to be encrypted, but with an encryption key managed by Oracle.)
    // If updating to a new Key Management key, the old key must remain enabled so that files previously encrypted continue
    // to be accessible. For more information, see Overview of Key Management (https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm).
    KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

func (UpdateFileSystemDetails) String

func (m UpdateFileSystemDetails) String() string

type UpdateFileSystemRequest

UpdateFileSystemRequest wrapper for the UpdateFileSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/UpdateFileSystem.go.html to see an example of how to use UpdateFileSystemRequest.

type UpdateFileSystemRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the file system.
    FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`

    // Details object for updating a file system.
    UpdateFileSystemDetails `contributesTo:"body"`

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

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

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

func (UpdateFileSystemRequest) HTTPRequest

func (request UpdateFileSystemRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateFileSystemRequest) RetryPolicy

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

UpdateFileSystemResponse wrapper for the UpdateFileSystem operation

type UpdateFileSystemResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (UpdateFileSystemResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateFileSystemResponse) String

func (response UpdateFileSystemResponse) String() string

type UpdateMountTargetDetails

UpdateMountTargetDetails Details for updating the mount target.

type UpdateMountTargetDetails struct {

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

    // A list of Network Security Group OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with this mount target.
    // A maximum of 5 is allowed.
    // Setting this to an empty array after the list is created removes the mount target from all NSGs.
    // For more information about NSGs, see Security Rules (https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
    NsgIds []string `mandatory:"false" json:"nsgIds"`

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateMountTargetDetails) String

func (m UpdateMountTargetDetails) String() string

type UpdateMountTargetRequest

UpdateMountTargetRequest wrapper for the UpdateMountTarget operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/UpdateMountTarget.go.html to see an example of how to use UpdateMountTargetRequest.

type UpdateMountTargetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the mount target.
    MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`

    // Details object for updating a mount target.
    UpdateMountTargetDetails `contributesTo:"body"`

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

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

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

func (UpdateMountTargetRequest) HTTPRequest

func (request UpdateMountTargetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateMountTargetRequest) RetryPolicy

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

UpdateMountTargetResponse wrapper for the UpdateMountTarget operation

type UpdateMountTargetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (UpdateMountTargetResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateMountTargetResponse) String

func (response UpdateMountTargetResponse) String() string

type UpdateSnapshotDetails

UpdateSnapshotDetails Details for updating the snapshot.

type UpdateSnapshotDetails struct {

    // Free-form tags for this resource. Each tag is a simple key-value pair
    //  with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateSnapshotDetails) String

func (m UpdateSnapshotDetails) String() string

type UpdateSnapshotRequest

UpdateSnapshotRequest wrapper for the UpdateSnapshot operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/filestorage/UpdateSnapshot.go.html to see an example of how to use UpdateSnapshotRequest.

type UpdateSnapshotRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the snapshot.
    SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`

    // Details object for updating a snapshot.
    UpdateSnapshotDetails `contributesTo:"body"`

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

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

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

func (UpdateSnapshotRequest) HTTPRequest

func (request UpdateSnapshotRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSnapshotRequest) RetryPolicy

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

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

func (UpdateSnapshotRequest) String

func (request UpdateSnapshotRequest) String() string

type UpdateSnapshotResponse

UpdateSnapshotResponse wrapper for the UpdateSnapshot operation

type UpdateSnapshotResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (UpdateSnapshotResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateSnapshotResponse) String

func (response UpdateSnapshotResponse) String() string