oci-go-sdk: github.com/oracle/oci-go-sdk/filestorage Index | Files

package filestorage

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

Index

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 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 Uses

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

ChangeFileSystemCompartmentDetails Details for changing the compartment.

func (ChangeFileSystemCompartmentDetails) String Uses

func (m ChangeFileSystemCompartmentDetails) String() string

type ChangeFileSystemCompartmentRequest Uses

type ChangeFileSystemCompartmentRequest struct {

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

ChangeFileSystemCompartmentRequest wrapper for the ChangeFileSystemCompartment operation

func (ChangeFileSystemCompartmentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ChangeFileSystemCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeFileSystemCompartmentRequest) String Uses

func (request ChangeFileSystemCompartmentRequest) String() string

type ChangeFileSystemCompartmentResponse Uses

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

ChangeFileSystemCompartmentResponse wrapper for the ChangeFileSystemCompartment operation

func (ChangeFileSystemCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeFileSystemCompartmentResponse) String Uses

func (response ChangeFileSystemCompartmentResponse) String() string

type ChangeMountTargetCompartmentDetails Uses

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

ChangeMountTargetCompartmentDetails Details for changing the compartment.

func (ChangeMountTargetCompartmentDetails) String Uses

func (m ChangeMountTargetCompartmentDetails) String() string

type ChangeMountTargetCompartmentRequest Uses

type ChangeMountTargetCompartmentRequest struct {

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

ChangeMountTargetCompartmentRequest wrapper for the ChangeMountTargetCompartment operation

func (ChangeMountTargetCompartmentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ChangeMountTargetCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeMountTargetCompartmentRequest) String Uses

func (request ChangeMountTargetCompartmentRequest) String() string

type ChangeMountTargetCompartmentResponse Uses

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

ChangeMountTargetCompartmentResponse wrapper for the ChangeMountTargetCompartment operation

func (ChangeMountTargetCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeMountTargetCompartmentResponse) String Uses

func (response ChangeMountTargetCompartmentResponse) String() string

type ClientOptions Uses

type ClientOptions struct {

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

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

    // Type of access to grant clients using the file system
    // through this export. If unspecified defaults to `READ_ONLY`.
    Access ClientOptionsAccessEnum `mandatory:"false" json:"access,omitempty"`

    // Used when clients accessing the file system through this export
    // have their UID and GID remapped to 'anonymousUid' and
    // 'anonymousGid'. If `ALL`, all users and groups are remapped;
    // if `ROOT`, only the root user and group (UID/GID 0) are
    // remapped; if `NONE`, no remapping is done. If unspecified,
    // defaults to `ROOT`.
    IdentitySquash ClientOptionsIdentitySquashEnum `mandatory:"false" json:"identitySquash,omitempty"`

    // UID value to remap to when squashing a client UID (see
    // identitySquash for more details.) If unspecified, defaults
    // to `65534`.
    AnonymousUid *int64 `mandatory:"false" json:"anonymousUid"`

    // GID value to remap to when squashing a client GID (see
    // identitySquash for more details.) If unspecified defaults
    // to `65534`.
    AnonymousGid *int64 `mandatory:"false" json:"anonymousGid"`
}

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

func (ClientOptions) String Uses

func (m ClientOptions) String() string

type ClientOptionsAccessEnum Uses

type ClientOptionsAccessEnum string

ClientOptionsAccessEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ClientOptionsAccessEnum

func GetClientOptionsAccessEnumValues Uses

func GetClientOptionsAccessEnumValues() []ClientOptionsAccessEnum

GetClientOptionsAccessEnumValues Enumerates the set of values for ClientOptionsAccessEnum

type ClientOptionsIdentitySquashEnum Uses

type ClientOptionsIdentitySquashEnum string

ClientOptionsIdentitySquashEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ClientOptionsIdentitySquashEnum

func GetClientOptionsIdentitySquashEnumValues Uses

func GetClientOptionsIdentitySquashEnumValues() []ClientOptionsIdentitySquashEnum

GetClientOptionsIdentitySquashEnumValues Enumerates the set of values for ClientOptionsIdentitySquashEnum

type CreateExportDetails Uses

type CreateExportDetails struct {

    // The OCID of this export's export set.
    ExportSetId *string `mandatory:"true" json:"exportSetId"`

    // The OCID of this export's file system.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

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

    // Export options for the new export. If left unspecified,
    // defaults to:
    //        [
    //          {
    //             "source" : "0.0.0.0/0",
    //             "requirePrivilegedSourcePort" : false,
    //             "access" : "READ_WRITE",
    //             "identitySquash" : "NONE"
    //           }
    //        ]
    //   **Note:** Mount targets do not have Internet-routable IP
    //   addresses.  Therefore they will not be reachable from the
    //   Internet, even if an associated `ClientOptions` item has
    //   a source of `0.0.0.0/0`.
    //   **If set to the empty array then the export will not be
    //   visible to any clients.**
    //   The export's `exportOptions` can be changed after creation
    //   using the `UpdateExport` operation.
    ExportOptions []ClientOptions `mandatory:"false" json:"exportOptions"`
}

CreateExportDetails Details for creating the export.

func (CreateExportDetails) String Uses

func (m CreateExportDetails) String() string

type CreateExportRequest Uses

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
}

CreateExportRequest wrapper for the CreateExport operation

func (CreateExportRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateExportRequest) RetryPolicy Uses

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

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

func (CreateExportRequest) String Uses

func (request CreateExportRequest) String() string

type CreateExportResponse Uses

type CreateExportResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

CreateExportResponse wrapper for the CreateExport operation

func (CreateExportResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateExportResponse) String Uses

func (response CreateExportResponse) String() string

type CreateFileSystemDetails Uses

type CreateFileSystemDetails struct {

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

    // The OCID of the compartment to create the file system in.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

    // 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 of KMS key used to encrypt the encryption keys associated with this file system.
    KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

CreateFileSystemDetails Details for creating the file system.

func (CreateFileSystemDetails) String Uses

func (m CreateFileSystemDetails) String() string

type CreateFileSystemRequest Uses

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
}

CreateFileSystemRequest wrapper for the CreateFileSystem operation

func (CreateFileSystemRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateFileSystemRequest) RetryPolicy Uses

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

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

func (CreateFileSystemRequest) String Uses

func (request CreateFileSystemRequest) String() string

type CreateFileSystemResponse Uses

type CreateFileSystemResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

CreateFileSystemResponse wrapper for the CreateFileSystem operation

func (CreateFileSystemResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateFileSystemResponse) String Uses

func (response CreateFileSystemResponse) String() string

type CreateMountTargetDetails Uses

type CreateMountTargetDetails struct {

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

    // The OCID of the compartment in which to create the mount target.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The OCID of the subnet in which to create the mount target.
    SubnetId *string `mandatory:"true" json:"subnetId"`

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

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

CreateMountTargetDetails Details for creating the mount target.

func (CreateMountTargetDetails) String Uses

func (m CreateMountTargetDetails) String() string

type CreateMountTargetRequest Uses

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
}

CreateMountTargetRequest wrapper for the CreateMountTarget operation

func (CreateMountTargetRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateMountTargetRequest) RetryPolicy Uses

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

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

func (CreateMountTargetRequest) String Uses

func (request CreateMountTargetRequest) String() string

type CreateMountTargetResponse Uses

type CreateMountTargetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

CreateMountTargetResponse wrapper for the CreateMountTarget operation

func (CreateMountTargetResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateMountTargetResponse) String Uses

func (response CreateMountTargetResponse) String() string

type CreateSnapshotDetails Uses

type CreateSnapshotDetails struct {

    // The OCID of the file system to take a snapshot of.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

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

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

CreateSnapshotDetails Details for creating the snapshot.

func (CreateSnapshotDetails) String Uses

func (m CreateSnapshotDetails) String() string

type CreateSnapshotRequest Uses

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
}

CreateSnapshotRequest wrapper for the CreateSnapshot operation

func (CreateSnapshotRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateSnapshotRequest) RetryPolicy Uses

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

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

func (CreateSnapshotRequest) String Uses

func (request CreateSnapshotRequest) String() string

type CreateSnapshotResponse Uses

type CreateSnapshotResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

CreateSnapshotResponse wrapper for the CreateSnapshot operation

func (CreateSnapshotResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateSnapshotResponse) String Uses

func (response CreateSnapshotResponse) String() string

type DeleteExportRequest Uses

type DeleteExportRequest struct {

    // The OCID of the export.
    ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"`

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

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

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

DeleteExportRequest wrapper for the DeleteExport operation

func (DeleteExportRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteExportRequest) RetryPolicy Uses

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

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

func (DeleteExportRequest) String Uses

func (request DeleteExportRequest) String() string

type DeleteExportResponse Uses

type DeleteExportResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

DeleteExportResponse wrapper for the DeleteExport operation

func (DeleteExportResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteExportResponse) String Uses

func (response DeleteExportResponse) String() string

type DeleteFileSystemRequest Uses

type DeleteFileSystemRequest struct {

    // The OCID of the file system.
    FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`

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

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

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

DeleteFileSystemRequest wrapper for the DeleteFileSystem operation

func (DeleteFileSystemRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteFileSystemRequest) RetryPolicy Uses

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

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

func (DeleteFileSystemRequest) String Uses

func (request DeleteFileSystemRequest) String() string

type DeleteFileSystemResponse Uses

type DeleteFileSystemResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

DeleteFileSystemResponse wrapper for the DeleteFileSystem operation

func (DeleteFileSystemResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteFileSystemResponse) String Uses

func (response DeleteFileSystemResponse) String() string

type DeleteMountTargetRequest Uses

type DeleteMountTargetRequest struct {

    // The OCID of the mount target.
    MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`

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

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

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

DeleteMountTargetRequest wrapper for the DeleteMountTarget operation

func (DeleteMountTargetRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteMountTargetRequest) RetryPolicy Uses

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

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

func (DeleteMountTargetRequest) String Uses

func (request DeleteMountTargetRequest) String() string

type DeleteMountTargetResponse Uses

type DeleteMountTargetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

DeleteMountTargetResponse wrapper for the DeleteMountTarget operation

func (DeleteMountTargetResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteMountTargetResponse) String Uses

func (response DeleteMountTargetResponse) String() string

type DeleteSnapshotRequest Uses

type DeleteSnapshotRequest struct {

    // The OCID of the snapshot.
    SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`

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

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

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

DeleteSnapshotRequest wrapper for the DeleteSnapshot operation

func (DeleteSnapshotRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteSnapshotRequest) RetryPolicy Uses

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

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

func (DeleteSnapshotRequest) String Uses

func (request DeleteSnapshotRequest) String() string

type DeleteSnapshotResponse Uses

type DeleteSnapshotResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

DeleteSnapshotResponse wrapper for the DeleteSnapshot operation

func (DeleteSnapshotResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteSnapshotResponse) String Uses

func (response DeleteSnapshotResponse) String() string

type Export Uses

type Export struct {

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

    // The OCID of this export's export set.
    ExportSetId *string `mandatory:"true" json:"exportSetId"`

    // The OCID of this export's file system.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

    // The OCID of this export.
    Id  *string `mandatory:"true" json:"id"`

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

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

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

Export A file system and the path that you can use to mount it. Each export resource belongs to exactly one export set. The export's path attribute is not a path in the referenced file system, but the value used by clients for the path component of the remotetarget argument when mounting the file system. The path must start with a slash (/) followed by a sequence of zero or more slash-separated path elements. For any two export resources associated with the same export set, except those in a 'DELETED' state, the path element sequence for the first export resource can't contain the complete path element sequence of the second export resource.

For example, the following are acceptable:

* /example and /path
* /example1 and /example2
* /example and /example1

The following examples are not acceptable:

* /example and /example/path
* / and /example

Paths may not end in a slash (/). No path element can be a period (.) or two periods in sequence (..). All path elements must be 255 bytes or less. No two non-'DELETED' export resources in the same export set can reference the same file system. Use `exportOptions` to control access to an export. For more information, see Export Options (https://docs.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.

func (Export) String Uses

func (m Export) String() string

type ExportLifecycleStateEnum Uses

type ExportLifecycleStateEnum string

ExportLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ExportLifecycleStateEnum

func GetExportLifecycleStateEnumValues Uses

func GetExportLifecycleStateEnumValues() []ExportLifecycleStateEnum

GetExportLifecycleStateEnumValues Enumerates the set of values for ExportLifecycleStateEnum

type ExportSet Uses

type ExportSet struct {

    // The OCID of the compartment that contains the export set.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

    // The OCID of the export set.
    Id  *string `mandatory:"true" json:"id"`

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

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

    // The OCID of the virtual cloud network (VCN) the export set is in.
    VcnId *string `mandatory:"true" json:"vcnId"`

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

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

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

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

func (ExportSet) String Uses

func (m ExportSet) String() string

type ExportSetLifecycleStateEnum Uses

type ExportSetLifecycleStateEnum string

ExportSetLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ExportSetLifecycleStateEnum

func GetExportSetLifecycleStateEnumValues Uses

func GetExportSetLifecycleStateEnumValues() []ExportSetLifecycleStateEnum

GetExportSetLifecycleStateEnumValues Enumerates the set of values for ExportSetLifecycleStateEnum

type ExportSetSummary Uses

type ExportSetSummary struct {

    // The OCID of the compartment that contains the export set.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

    // The OCID of the export set.
    Id  *string `mandatory:"true" json:"id"`

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

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

    // The OCID of the virtual cloud network (VCN) the export set is in.
    VcnId *string `mandatory:"true" json:"vcnId"`

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

ExportSetSummary Summary information for an export set.

func (ExportSetSummary) String Uses

func (m ExportSetSummary) String() string

type ExportSetSummaryLifecycleStateEnum Uses

type ExportSetSummaryLifecycleStateEnum string

ExportSetSummaryLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ExportSetSummaryLifecycleStateEnum

func GetExportSetSummaryLifecycleStateEnumValues Uses

func GetExportSetSummaryLifecycleStateEnumValues() []ExportSetSummaryLifecycleStateEnum

GetExportSetSummaryLifecycleStateEnumValues Enumerates the set of values for ExportSetSummaryLifecycleStateEnum

type ExportSummary Uses

type ExportSummary struct {

    // The OCID of this export's export set.
    ExportSetId *string `mandatory:"true" json:"exportSetId"`

    // The OCID of this export's file system.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

    // The OCID of this export.
    Id  *string `mandatory:"true" json:"id"`

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

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

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

ExportSummary Summary information for an export.

func (ExportSummary) String Uses

func (m ExportSummary) String() string

type ExportSummaryLifecycleStateEnum Uses

type ExportSummaryLifecycleStateEnum string

ExportSummaryLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ExportSummaryLifecycleStateEnum

func GetExportSummaryLifecycleStateEnumValues Uses

func GetExportSummaryLifecycleStateEnumValues() []ExportSummaryLifecycleStateEnum

GetExportSummaryLifecycleStateEnumValues Enumerates the set of values for ExportSummaryLifecycleStateEnum

type FileStorageClient Uses

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

FileStorageClient a client for FileStorage

func NewFileStorageClientWithConfigurationProvider Uses

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 Uses

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 Uses

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)

func (FileStorageClient) ChangeMountTargetCompartment Uses

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)

func (*FileStorageClient) ConfigurationProvider Uses

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

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

func (FileStorageClient) CreateExport Uses

func (client FileStorageClient) CreateExport(ctx context.Context, request CreateExportRequest) (response CreateExportResponse, err error)

CreateExport Creates a new export in the specified export set, path, and file system.

func (FileStorageClient) CreateFileSystem Uses

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). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type or by viewing the resource in the Console.

func (FileStorageClient) CreateMountTarget Uses

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). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

func (FileStorageClient) CreateSnapshot Uses

func (client FileStorageClient) CreateSnapshot(ctx context.Context, request CreateSnapshotRequest) (response CreateSnapshotResponse, err error)

CreateSnapshot Creates a new snapshot of the specified file system. You can access the snapshot at `.snapshot/<name>`.

func (FileStorageClient) DeleteExport Uses

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

DeleteExport Deletes the specified export.

func (FileStorageClient) DeleteFileSystem Uses

func (client FileStorageClient) DeleteFileSystem(ctx context.Context, request DeleteFileSystemRequest) (response DeleteFileSystemResponse, err error)

DeleteFileSystem Deletes the specified file system. Before you delete the file system, verify that no remaining export resources still reference it. Deleting a file system also deletes all of its snapshots.

func (FileStorageClient) DeleteMountTarget Uses

func (client FileStorageClient) DeleteMountTarget(ctx context.Context, request DeleteMountTargetRequest) (response DeleteMountTargetResponse, err error)

DeleteMountTarget Deletes the specified mount target. This operation also deletes the mount target's VNICs.

func (FileStorageClient) DeleteSnapshot Uses

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

DeleteSnapshot Deletes the specified snapshot.

func (FileStorageClient) GetExport Uses

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

GetExport Gets the specified export's information.

func (FileStorageClient) GetExportSet Uses

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

GetExportSet Gets the specified export set's information.

func (FileStorageClient) GetFileSystem Uses

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

GetFileSystem Gets the specified file system's information.

func (FileStorageClient) GetMountTarget Uses

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

GetMountTarget Gets the specified mount target's information.

func (FileStorageClient) GetSnapshot Uses

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

GetSnapshot Gets the specified snapshot's information.

func (FileStorageClient) ListExportSets Uses

func (client FileStorageClient) ListExportSets(ctx context.Context, request ListExportSetsRequest) (response ListExportSetsResponse, err error)

ListExportSets Lists the export set resources in the specified compartment.

func (FileStorageClient) ListExports Uses

func (client FileStorageClient) ListExports(ctx context.Context, request ListExportsRequest) (response ListExportsResponse, err error)

ListExports Lists export resources by compartment, file system, or export set. You must specify an export set ID, a file system ID, and / or a compartment ID.

func (FileStorageClient) ListFileSystems Uses

func (client FileStorageClient) ListFileSystems(ctx context.Context, request ListFileSystemsRequest) (response ListFileSystemsResponse, err error)

ListFileSystems Lists the file system resources in the specified compartment.

func (FileStorageClient) ListMountTargets Uses

func (client FileStorageClient) ListMountTargets(ctx context.Context, request ListMountTargetsRequest) (response ListMountTargetsResponse, err error)

ListMountTargets Lists the mount target resources in the specified compartment.

func (FileStorageClient) ListSnapshots Uses

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

ListSnapshots Lists snapshots of the specified file system.

func (*FileStorageClient) SetRegion Uses

func (client *FileStorageClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (FileStorageClient) UpdateExport Uses

func (client FileStorageClient) UpdateExport(ctx context.Context, request UpdateExportRequest) (response UpdateExportResponse, err error)

UpdateExport Updates the specified export's information.

func (FileStorageClient) UpdateExportSet Uses

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

UpdateExportSet Updates the specified export set's information.

func (FileStorageClient) UpdateFileSystem Uses

func (client FileStorageClient) UpdateFileSystem(ctx context.Context, request UpdateFileSystemRequest) (response UpdateFileSystemResponse, err error)

UpdateFileSystem Updates the specified file system's information. You can use this operation to rename a file system.

func (FileStorageClient) UpdateMountTarget Uses

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

UpdateMountTarget Updates the specified mount target's information.

func (FileStorageClient) UpdateSnapshot Uses

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

UpdateSnapshot Updates the specified snapshot's information.

type FileSystem Uses

type FileSystem struct {

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

    // The OCID of the compartment that contains the file system.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

    // The OCID of the file system.
    Id  *string `mandatory:"true" json:"id"`

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

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

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

    // 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 of the KMS key which is the master encryption key for the file system.
    KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

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.

func (FileSystem) String Uses

func (m FileSystem) String() string

type FileSystemLifecycleStateEnum Uses

type FileSystemLifecycleStateEnum string

FileSystemLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for FileSystemLifecycleStateEnum

func GetFileSystemLifecycleStateEnumValues Uses

func GetFileSystemLifecycleStateEnumValues() []FileSystemLifecycleStateEnum

GetFileSystemLifecycleStateEnumValues Enumerates the set of values for FileSystemLifecycleStateEnum

type FileSystemSummary Uses

type FileSystemSummary struct {

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

    // The OCID of the compartment that contains the file system.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

    // The OCID of the file system.
    Id  *string `mandatory:"true" json:"id"`

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

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

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

    // 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 of KMS key used to encrypt the encryption keys associated with this file system.
    KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

FileSystemSummary Summary information for a file system.

func (FileSystemSummary) String Uses

func (m FileSystemSummary) String() string

type FileSystemSummaryLifecycleStateEnum Uses

type FileSystemSummaryLifecycleStateEnum string

FileSystemSummaryLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for FileSystemSummaryLifecycleStateEnum

func GetFileSystemSummaryLifecycleStateEnumValues Uses

func GetFileSystemSummaryLifecycleStateEnumValues() []FileSystemSummaryLifecycleStateEnum

GetFileSystemSummaryLifecycleStateEnumValues Enumerates the set of values for FileSystemSummaryLifecycleStateEnum

type GetExportRequest Uses

type GetExportRequest struct {

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

GetExportRequest wrapper for the GetExport operation

func (GetExportRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetExportRequest) RetryPolicy Uses

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

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

func (GetExportRequest) String Uses

func (request GetExportRequest) String() string

type GetExportResponse Uses

type GetExportResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

GetExportResponse wrapper for the GetExport operation

func (GetExportResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetExportResponse) String Uses

func (response GetExportResponse) String() string

type GetExportSetRequest Uses

type GetExportSetRequest struct {

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

GetExportSetRequest wrapper for the GetExportSet operation

func (GetExportSetRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetExportSetRequest) RetryPolicy Uses

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

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

func (GetExportSetRequest) String Uses

func (request GetExportSetRequest) String() string

type GetExportSetResponse Uses

type GetExportSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

GetExportSetResponse wrapper for the GetExportSet operation

func (GetExportSetResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetExportSetResponse) String Uses

func (response GetExportSetResponse) String() string

type GetFileSystemRequest Uses

type GetFileSystemRequest struct {

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

GetFileSystemRequest wrapper for the GetFileSystem operation

func (GetFileSystemRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetFileSystemRequest) RetryPolicy Uses

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

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

func (GetFileSystemRequest) String Uses

func (request GetFileSystemRequest) String() string

type GetFileSystemResponse Uses

type GetFileSystemResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

GetFileSystemResponse wrapper for the GetFileSystem operation

func (GetFileSystemResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetFileSystemResponse) String Uses

func (response GetFileSystemResponse) String() string

type GetMountTargetRequest Uses

type GetMountTargetRequest struct {

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

GetMountTargetRequest wrapper for the GetMountTarget operation

func (GetMountTargetRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetMountTargetRequest) RetryPolicy Uses

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

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

func (GetMountTargetRequest) String Uses

func (request GetMountTargetRequest) String() string

type GetMountTargetResponse Uses

type GetMountTargetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

GetMountTargetResponse wrapper for the GetMountTarget operation

func (GetMountTargetResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetMountTargetResponse) String Uses

func (response GetMountTargetResponse) String() string

type GetSnapshotRequest Uses

type GetSnapshotRequest struct {

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

GetSnapshotRequest wrapper for the GetSnapshot operation

func (GetSnapshotRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetSnapshotRequest) RetryPolicy Uses

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

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

func (GetSnapshotRequest) String Uses

func (request GetSnapshotRequest) String() string

type GetSnapshotResponse Uses

type GetSnapshotResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

GetSnapshotResponse wrapper for the GetSnapshot operation

func (GetSnapshotResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetSnapshotResponse) String Uses

func (response GetSnapshotResponse) String() string

type ListExportSetsLifecycleStateEnum Uses

type ListExportSetsLifecycleStateEnum string

ListExportSetsLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListExportSetsLifecycleStateEnum

func GetListExportSetsLifecycleStateEnumValues Uses

func GetListExportSetsLifecycleStateEnumValues() []ListExportSetsLifecycleStateEnum

GetListExportSetsLifecycleStateEnumValues Enumerates the set of values for ListExportSetsLifecycleStateEnum

type ListExportSetsRequest Uses

type ListExportSetsRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

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

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

ListExportSetsRequest wrapper for the ListExportSets operation

func (ListExportSetsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListExportSetsRequest) RetryPolicy Uses

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

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

func (ListExportSetsRequest) String Uses

func (request ListExportSetsRequest) String() string

type ListExportSetsResponse Uses

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

ListExportSetsResponse wrapper for the ListExportSets operation

func (ListExportSetsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListExportSetsResponse) String Uses

func (response ListExportSetsResponse) String() string

type ListExportSetsSortByEnum Uses

type ListExportSetsSortByEnum string

ListExportSetsSortByEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListExportSetsSortByEnum

func GetListExportSetsSortByEnumValues Uses

func GetListExportSetsSortByEnumValues() []ListExportSetsSortByEnum

GetListExportSetsSortByEnumValues Enumerates the set of values for ListExportSetsSortByEnum

type ListExportSetsSortOrderEnum Uses

type ListExportSetsSortOrderEnum string

ListExportSetsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListExportSetsSortOrderEnum

func GetListExportSetsSortOrderEnumValues Uses

func GetListExportSetsSortOrderEnumValues() []ListExportSetsSortOrderEnum

GetListExportSetsSortOrderEnumValues Enumerates the set of values for ListExportSetsSortOrderEnum

type ListExportsLifecycleStateEnum Uses

type ListExportsLifecycleStateEnum string

ListExportsLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListExportsLifecycleStateEnum

func GetListExportsLifecycleStateEnumValues Uses

func GetListExportsLifecycleStateEnumValues() []ListExportsLifecycleStateEnum

GetListExportsLifecycleStateEnumValues Enumerates the set of values for ListExportsLifecycleStateEnum

type ListExportsRequest Uses

type ListExportsRequest struct {

    // The OCID 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 of the export set.
    ExportSetId *string `mandatory:"false" contributesTo:"query" name:"exportSetId"`

    // The OCID of the file system.
    FileSystemId *string `mandatory:"false" contributesTo:"query" name:"fileSystemId"`

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

    // Filter results by OCID. Must be an OCID of the correct type for
    // the resouce type.
    Id  *string `mandatory:"false" contributesTo:"query" name:"id"`

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

    // The sort order to use, either 'asc' or 'desc', where 'asc' is
    // ascending and 'desc' is descending. 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
}

ListExportsRequest wrapper for the ListExports operation

func (ListExportsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListExportsRequest) RetryPolicy Uses

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

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

func (ListExportsRequest) String Uses

func (request ListExportsRequest) String() string

type ListExportsResponse Uses

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

ListExportsResponse wrapper for the ListExports operation

func (ListExportsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListExportsResponse) String Uses

func (response ListExportsResponse) String() string

type ListExportsSortByEnum Uses

type ListExportsSortByEnum string

ListExportsSortByEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListExportsSortByEnum

func GetListExportsSortByEnumValues Uses

func GetListExportsSortByEnumValues() []ListExportsSortByEnum

GetListExportsSortByEnumValues Enumerates the set of values for ListExportsSortByEnum

type ListExportsSortOrderEnum Uses

type ListExportsSortOrderEnum string

ListExportsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListExportsSortOrderEnum

func GetListExportsSortOrderEnumValues Uses

func GetListExportsSortOrderEnumValues() []ListExportsSortOrderEnum

GetListExportsSortOrderEnumValues Enumerates the set of values for ListExportsSortOrderEnum

type ListFileSystemsLifecycleStateEnum Uses

type ListFileSystemsLifecycleStateEnum string

ListFileSystemsLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListFileSystemsLifecycleStateEnum

func GetListFileSystemsLifecycleStateEnumValues Uses

func GetListFileSystemsLifecycleStateEnumValues() []ListFileSystemsLifecycleStateEnum

GetListFileSystemsLifecycleStateEnumValues Enumerates the set of values for ListFileSystemsLifecycleStateEnum

type ListFileSystemsRequest Uses

type ListFileSystemsRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

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

    // 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. Must be an OCID of the correct type for
    // the resouce type.
    Id  *string `mandatory:"false" contributesTo:"query" name:"id"`

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

    // The sort order to use, either 'asc' or 'desc', where 'asc' is
    // ascending and 'desc' is descending. 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
}

ListFileSystemsRequest wrapper for the ListFileSystems operation

func (ListFileSystemsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListFileSystemsRequest) RetryPolicy Uses

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

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

func (ListFileSystemsRequest) String Uses

func (request ListFileSystemsRequest) String() string

type ListFileSystemsResponse Uses

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

ListFileSystemsResponse wrapper for the ListFileSystems operation

func (ListFileSystemsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListFileSystemsResponse) String Uses

func (response ListFileSystemsResponse) String() string

type ListFileSystemsSortByEnum Uses

type ListFileSystemsSortByEnum string

ListFileSystemsSortByEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListFileSystemsSortByEnum

func GetListFileSystemsSortByEnumValues Uses

func GetListFileSystemsSortByEnumValues() []ListFileSystemsSortByEnum

GetListFileSystemsSortByEnumValues Enumerates the set of values for ListFileSystemsSortByEnum

type ListFileSystemsSortOrderEnum Uses

type ListFileSystemsSortOrderEnum string

ListFileSystemsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListFileSystemsSortOrderEnum

func GetListFileSystemsSortOrderEnumValues Uses

func GetListFileSystemsSortOrderEnumValues() []ListFileSystemsSortOrderEnum

GetListFileSystemsSortOrderEnumValues Enumerates the set of values for ListFileSystemsSortOrderEnum

type ListMountTargetsLifecycleStateEnum Uses

type ListMountTargetsLifecycleStateEnum string

ListMountTargetsLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListMountTargetsLifecycleStateEnum

func GetListMountTargetsLifecycleStateEnumValues Uses

func GetListMountTargetsLifecycleStateEnumValues() []ListMountTargetsLifecycleStateEnum

GetListMountTargetsLifecycleStateEnumValues Enumerates the set of values for ListMountTargetsLifecycleStateEnum

type ListMountTargetsRequest Uses

type ListMountTargetsRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

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

    // 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 of the export set.
    ExportSetId *string `mandatory:"false" contributesTo:"query" name:"exportSetId"`

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

    // Filter results by OCID. Must be an OCID of the correct type for
    // the resouce type.
    Id  *string `mandatory:"false" contributesTo:"query" name:"id"`

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

    // The sort order to use, either 'asc' or 'desc', where 'asc' is
    // ascending and 'desc' is descending. 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
}

ListMountTargetsRequest wrapper for the ListMountTargets operation

func (ListMountTargetsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListMountTargetsRequest) RetryPolicy Uses

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

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

func (ListMountTargetsRequest) String Uses

func (request ListMountTargetsRequest) String() string

type ListMountTargetsResponse Uses

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

ListMountTargetsResponse wrapper for the ListMountTargets operation

func (ListMountTargetsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListMountTargetsResponse) String Uses

func (response ListMountTargetsResponse) String() string

type ListMountTargetsSortByEnum Uses

type ListMountTargetsSortByEnum string

ListMountTargetsSortByEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListMountTargetsSortByEnum

func GetListMountTargetsSortByEnumValues Uses

func GetListMountTargetsSortByEnumValues() []ListMountTargetsSortByEnum

GetListMountTargetsSortByEnumValues Enumerates the set of values for ListMountTargetsSortByEnum

type ListMountTargetsSortOrderEnum Uses

type ListMountTargetsSortOrderEnum string

ListMountTargetsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListMountTargetsSortOrderEnum

func GetListMountTargetsSortOrderEnumValues Uses

func GetListMountTargetsSortOrderEnumValues() []ListMountTargetsSortOrderEnum

GetListMountTargetsSortOrderEnumValues Enumerates the set of values for ListMountTargetsSortOrderEnum

type ListSnapshotsLifecycleStateEnum Uses

type ListSnapshotsLifecycleStateEnum string

ListSnapshotsLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListSnapshotsLifecycleStateEnum

func GetListSnapshotsLifecycleStateEnumValues Uses

func GetListSnapshotsLifecycleStateEnumValues() []ListSnapshotsLifecycleStateEnum

GetListSnapshotsLifecycleStateEnumValues Enumerates the set of values for ListSnapshotsLifecycleStateEnum

type ListSnapshotsRequest Uses

type ListSnapshotsRequest struct {

    // The OCID 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. 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
}

ListSnapshotsRequest wrapper for the ListSnapshots operation

func (ListSnapshotsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListSnapshotsRequest) RetryPolicy Uses

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

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

func (ListSnapshotsRequest) String Uses

func (request ListSnapshotsRequest) String() string

type ListSnapshotsResponse Uses

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

ListSnapshotsResponse wrapper for the ListSnapshots operation

func (ListSnapshotsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListSnapshotsResponse) String Uses

func (response ListSnapshotsResponse) String() string

type ListSnapshotsSortOrderEnum Uses

type ListSnapshotsSortOrderEnum string

ListSnapshotsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListSnapshotsSortOrderEnum

func GetListSnapshotsSortOrderEnumValues Uses

func GetListSnapshotsSortOrderEnumValues() []ListSnapshotsSortOrderEnum

GetListSnapshotsSortOrderEnumValues Enumerates the set of values for ListSnapshotsSortOrderEnum

type MountTarget Uses

type MountTarget struct {

    // The OCID of the compartment that contains the mount target.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

    // The OCID of the mount target.
    Id  *string `mandatory:"true" json:"id"`

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

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

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

    // The OCID of the subnet the mount target is in.
    SubnetId *string `mandatory:"true" json:"subnetId"`

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

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

    // The OCID of the associated export set. Controls what file
    // systems will be exported through Network File System (NFS) protocol on this
    // mount target.
    ExportSetId *string `mandatory:"false" json:"exportSetId"`

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

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.

func (MountTarget) String Uses

func (m MountTarget) String() string

type MountTargetLifecycleStateEnum Uses

type MountTargetLifecycleStateEnum string

MountTargetLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for MountTargetLifecycleStateEnum

func GetMountTargetLifecycleStateEnumValues Uses

func GetMountTargetLifecycleStateEnumValues() []MountTargetLifecycleStateEnum

GetMountTargetLifecycleStateEnumValues Enumerates the set of values for MountTargetLifecycleStateEnum

type MountTargetSummary Uses

type MountTargetSummary struct {

    // The OCID of the compartment that contains the mount target.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

    // The OCID of the mount target.
    Id  *string `mandatory:"true" json:"id"`

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

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

    // The OCID of the subnet the mount target is in.
    SubnetId *string `mandatory:"true" json:"subnetId"`

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

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

    // The OCID of the associated export set. Controls what file
    // systems will be exported using Network File System (NFS) protocol on
    // this mount target.
    ExportSetId *string `mandatory:"false" json:"exportSetId"`

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

MountTargetSummary Summary information for the specified mount target.

func (MountTargetSummary) String Uses

func (m MountTargetSummary) String() string

type MountTargetSummaryLifecycleStateEnum Uses

type MountTargetSummaryLifecycleStateEnum string

MountTargetSummaryLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for MountTargetSummaryLifecycleStateEnum

func GetMountTargetSummaryLifecycleStateEnumValues Uses

func GetMountTargetSummaryLifecycleStateEnumValues() []MountTargetSummaryLifecycleStateEnum

GetMountTargetSummaryLifecycleStateEnumValues Enumerates the set of values for MountTargetSummaryLifecycleStateEnum

type Snapshot Uses

type Snapshot struct {

    // The OCID of the file system from which the snapshot
    // was created.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

    // The OCID of the snapshot.
    Id  *string `mandatory:"true" json:"id"`

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

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

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

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

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.

func (Snapshot) String Uses

func (m Snapshot) String() string

type SnapshotLifecycleStateEnum Uses

type SnapshotLifecycleStateEnum string

SnapshotLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for SnapshotLifecycleStateEnum

func GetSnapshotLifecycleStateEnumValues Uses

func GetSnapshotLifecycleStateEnumValues() []SnapshotLifecycleStateEnum

GetSnapshotLifecycleStateEnumValues Enumerates the set of values for SnapshotLifecycleStateEnum

type SnapshotSummary Uses

type SnapshotSummary struct {

    // The OCID of the file system from which the
    // snapshot was created.
    FileSystemId *string `mandatory:"true" json:"fileSystemId"`

    // The OCID of the snapshot.
    Id  *string `mandatory:"true" json:"id"`

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

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

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

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

SnapshotSummary Summary information for a snapshot.

func (SnapshotSummary) String Uses

func (m SnapshotSummary) String() string

type SnapshotSummaryLifecycleStateEnum Uses

type SnapshotSummaryLifecycleStateEnum string

SnapshotSummaryLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for SnapshotSummaryLifecycleStateEnum

func GetSnapshotSummaryLifecycleStateEnumValues Uses

func GetSnapshotSummaryLifecycleStateEnumValues() []SnapshotSummaryLifecycleStateEnum

GetSnapshotSummaryLifecycleStateEnumValues Enumerates the set of values for SnapshotSummaryLifecycleStateEnum

type UpdateExportDetails Uses

type UpdateExportDetails struct {

    // New export options for the export.
    // **Setting to the empty array will make the export invisible to all clients.**
    // Leaving unset will leave the `exportOptions` unchanged.
    ExportOptions []ClientOptions `mandatory:"false" json:"exportOptions"`
}

UpdateExportDetails Details for updating the export.

func (UpdateExportDetails) String Uses

func (m UpdateExportDetails) String() string

type UpdateExportRequest Uses

type UpdateExportRequest struct {

    // The OCID of the export.
    ExportId *string `mandatory:"true" contributesTo:"path" name:"exportId"`

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

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

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

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

UpdateExportRequest wrapper for the UpdateExport operation

func (UpdateExportRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateExportRequest) RetryPolicy Uses

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

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

func (UpdateExportRequest) String Uses

func (request UpdateExportRequest) String() string

type UpdateExportResponse Uses

type UpdateExportResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

UpdateExportResponse wrapper for the UpdateExport operation

func (UpdateExportResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateExportResponse) String Uses

func (response UpdateExportResponse) String() string

type UpdateExportSetDetails Uses

type UpdateExportSetDetails struct {

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

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

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

UpdateExportSetDetails Details for updating the export set.

func (UpdateExportSetDetails) String Uses

func (m UpdateExportSetDetails) String() string

type UpdateExportSetRequest Uses

type UpdateExportSetRequest struct {

    // The OCID of the export set.
    ExportSetId *string `mandatory:"true" contributesTo:"path" name:"exportSetId"`

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

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

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

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

UpdateExportSetRequest wrapper for the UpdateExportSet operation

func (UpdateExportSetRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateExportSetRequest) RetryPolicy Uses

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

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

func (UpdateExportSetRequest) String Uses

func (request UpdateExportSetRequest) String() string

type UpdateExportSetResponse Uses

type UpdateExportSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

UpdateExportSetResponse wrapper for the UpdateExportSet operation

func (UpdateExportSetResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateExportSetResponse) String Uses

func (response UpdateExportSetResponse) String() string

type UpdateFileSystemDetails Uses

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

UpdateFileSystemDetails Details for updating the file system.

func (UpdateFileSystemDetails) String Uses

func (m UpdateFileSystemDetails) String() string

type UpdateFileSystemRequest Uses

type UpdateFileSystemRequest struct {

    // The OCID of the file system.
    FileSystemId *string `mandatory:"true" contributesTo:"path" name:"fileSystemId"`

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

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

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

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

UpdateFileSystemRequest wrapper for the UpdateFileSystem operation

func (UpdateFileSystemRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateFileSystemRequest) RetryPolicy Uses

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

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

func (UpdateFileSystemRequest) String Uses

func (request UpdateFileSystemRequest) String() string

type UpdateFileSystemResponse Uses

type UpdateFileSystemResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

UpdateFileSystemResponse wrapper for the UpdateFileSystem operation

func (UpdateFileSystemResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateFileSystemResponse) String Uses

func (response UpdateFileSystemResponse) String() string

type UpdateMountTargetDetails Uses

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

UpdateMountTargetDetails Details for updating the mount target.

func (UpdateMountTargetDetails) String Uses

func (m UpdateMountTargetDetails) String() string

type UpdateMountTargetRequest Uses

type UpdateMountTargetRequest struct {

    // The OCID of the mount target.
    MountTargetId *string `mandatory:"true" contributesTo:"path" name:"mountTargetId"`

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

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

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

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

UpdateMountTargetRequest wrapper for the UpdateMountTarget operation

func (UpdateMountTargetRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateMountTargetRequest) RetryPolicy Uses

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

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

func (UpdateMountTargetRequest) String Uses

func (request UpdateMountTargetRequest) String() string

type UpdateMountTargetResponse Uses

type UpdateMountTargetResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

UpdateMountTargetResponse wrapper for the UpdateMountTarget operation

func (UpdateMountTargetResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateMountTargetResponse) String Uses

func (response UpdateMountTargetResponse) String() string

type UpdateSnapshotDetails Uses

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

UpdateSnapshotDetails Details for updating the snapshot.

func (UpdateSnapshotDetails) String Uses

func (m UpdateSnapshotDetails) String() string

type UpdateSnapshotRequest Uses

type UpdateSnapshotRequest struct {

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

UpdateSnapshotRequest wrapper for the UpdateSnapshot operation

func (UpdateSnapshotRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateSnapshotRequest) RetryPolicy Uses

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

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

func (UpdateSnapshotRequest) String Uses

func (request UpdateSnapshotRequest) String() string

type UpdateSnapshotResponse Uses

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

UpdateSnapshotResponse wrapper for the UpdateSnapshot operation

func (UpdateSnapshotResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateSnapshotResponse) String Uses

func (response UpdateSnapshotResponse) String() string

Package filestorage imports 4 packages (graph) and is imported by 2 packages. Updated 2020-04-08. Refresh now. Tools for package owners.