Class FileSystem.Builder

  • Enclosing class:
    FileSystem

    public static class FileSystem.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • availabilityDomain

        public FileSystem.Builder availabilityDomain​(String availabilityDomain)
        The availability domain the file system is in.

        May be unset as a blank or NULL value.

        Example: Uocm:PHX-AD-1

        Parameters:
        availabilityDomain - the value to set
        Returns:
        this builder
      • meteredBytes

        public FileSystem.Builder meteredBytes​(Long meteredBytes)
        The number of bytes consumed by the file system, including any snapshots.

        This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.

        Parameters:
        meteredBytes - the value to set
        Returns:
        this builder
      • compartmentId

        public FileSystem.Builder compartmentId​(String compartmentId)
        The OCID of the compartment that contains the file system.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder
      • displayName

        public FileSystem.Builder displayName​(String displayName)
        A user-friendly name.

        It does not have to be unique, and it is changeable. Avoid entering confidential information.

        Example: My file system

        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • timeCreated

        public FileSystem.Builder timeCreated​(Date timeCreated)
        The date and time the file system was created, expressed in RFC 3339 timestamp format.

        Example: 2016-08-25T21:10:29.600Z

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • freeformTags

        public FileSystem.Builder freeformTags​(Map<String,​String> freeformTags)
        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. Example: {“Department”: “Finance”}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder
      • definedTags

        public FileSystem.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder
      • systemTags

        public FileSystem.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        System tags are applied to resources by internal OCI services.

        Parameters:
        systemTags - the value to set
        Returns:
        this builder
      • kmsKeyId

        public FileSystem.Builder kmsKeyId​(String kmsKeyId)
        The OCID of the KMS key which is the master encryption key for the file system.
        Parameters:
        kmsKeyId - the value to set
        Returns:
        this builder
      • isHydrated

        public FileSystem.Builder isHydrated​(Boolean isHydrated)
        Specifies whether the data has finished copying from the source to the clone.

        Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.

        Parameters:
        isHydrated - the value to set
        Returns:
        this builder
      • cloneCount

        public FileSystem.Builder cloneCount​(Integer cloneCount)
        Specifies the total number of children of a file system.
        Parameters:
        cloneCount - the value to set
        Returns:
        this builder
      • cloneAttachStatus

        public FileSystem.Builder cloneAttachStatus​(FileSystem.CloneAttachStatus cloneAttachStatus)
        Specifies whether the file system is attached to its parent file system.
        Parameters:
        cloneAttachStatus - the value to set
        Returns:
        this builder
      • lifecycleDetails

        public FileSystem.Builder lifecycleDetails​(String lifecycleDetails)
        Additional information about the current ‘lifecycleState’.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder
      • isTargetable

        public FileSystem.Builder isTargetable​(Boolean isTargetable)
        Specifies whether the file system can be used as a target file system for replication.

        The system sets this value to true if the file system is unexported, hasn’t yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.

        Parameters:
        isTargetable - the value to set
        Returns:
        this builder
      • replicationTargetId

        public FileSystem.Builder replicationTargetId​(String replicationTargetId)
        The OCID of the replication target associated with the file system.

        Empty if the file system is not being used as target in a replication.

        Parameters:
        replicationTargetId - the value to set
        Returns:
        this builder
      • filesystemSnapshotPolicyId

        public FileSystem.Builder filesystemSnapshotPolicyId​(String filesystemSnapshotPolicyId)
        The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.
        Parameters:
        filesystemSnapshotPolicyId - the value to set
        Returns:
        this builder
      • areQuotaRulesEnabled

        public FileSystem.Builder areQuotaRulesEnabled​(Boolean areQuotaRulesEnabled)
        Specifies the enforcement of quota rules on the file system.
        Parameters:
        areQuotaRulesEnabled - the value to set
        Returns:
        this builder
      • quotaEnforcementState

        public FileSystem.Builder quotaEnforcementState​(FileSystem.QuotaEnforcementState quotaEnforcementState)
        Displays the state of enforcement of quota rules on the file system.
        Parameters:
        quotaEnforcementState - the value to set
        Returns:
        this builder
      • replicationSourceCount

        public FileSystem.Builder replicationSourceCount​(Integer replicationSourceCount)
        Specifies the total number of replications for which this file system is a source.
        Parameters:
        replicationSourceCount - the value to set
        Returns:
        this builder