Class SharePatch

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel

    public class SharePatch
    extends com.ibm.cloud.sdk.core.service.model.GenericModel
    SharePatch.
    • Method Detail

      • newBuilder

        public SharePatch.Builder newBuilder()
        New builder.
        Returns:
        a SharePatch builder
      • accessControlMode

        public String accessControlMode()
        Gets the accessControlMode. The access control mode for the share: - `security_group`: The security groups on the virtual network interface for a mount target control access to the mount target. - `vpc`: All clients in the VPC for a mount target have access to the mount target. For this property to be changed, the share must have no mount targets, `replication_role` must be `none` and `accessor_binding_role` must not be `accessor`.
        Returns:
        the accessControlMode
      • allowedTransitEncryptionModes

        public List<String> allowedTransitEncryptionModes()
        Gets the allowedTransitEncryptionModes. The transit encryption modes to allow for this share. For this property to be updated, the `accessor_binding_role` must be `none`.
        Returns:
        the allowedTransitEncryptionModes
      • iops

        public Long iops()
        Gets the iops. The maximum input/output operations per second (IOPS) for the file share. In addition, each client accessing the share will be restricted to 48,000 IOPS. The maximum IOPS for a share may increase in the future. For this property to be changed, the share `accessor_binding_role` must not be `accessor`.
        Returns:
        the iops
      • name

        public String name()
        Gets the name. The name for this share. The name must not be used by another share in the region.
        Returns:
        the name
      • profile

        public ShareProfileIdentity profile()
        Gets the profile. The profile to use for this file share. The requested profile must be in the same `family`.
        Returns:
        the profile
      • replicationCronSpec

        public String replicationCronSpec()
        Gets the replicationCronSpec. The cron specification for the file share replication schedule. Replication of a share can be scheduled to occur at most once every 15 minutes. For this property to be changed, the share `replication_role` must be `replica`.
        Returns:
        the replicationCronSpec
      • size

        public Long size()
        Gets the size. The size of the file share rounded up to the next gigabyte. The value must not be less than the share's current size, and must not exceed the maximum supported by the share's profile and IOPS. For this property to be changed: - The share `lifecycle_state` must be `stable` - The share `replication_role` must not be `replica` - The share `accessor_binding_role` must not be `accessor`.
        Returns:
        the size
      • userTags

        public List<String> userTags()
        Gets the userTags. Tags for this resource.
        Returns:
        the userTags
      • asPatch

        public Map<String,​Object> asPatch()
        Construct a JSON merge-patch from the SharePatch. Note that properties of the SharePatch with null values are not represented in the constructed JSON merge-patch object, but can be explicitly set afterward to signify a property delete.
        Returns:
        a JSON merge-patch for the SharePatch