Package com.google.cloud.parallelstore.v1

Interface InstanceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Instance, Instance.Builder
@Generated public interface InstanceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Identifier. The resource name of the instance, in the format
 `projects/{project}/locations/{location}/instances/{instance_id}`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name of the instance, in the format
 `projects/{project}/locations/{location}/instances/{instance_id}`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • getDescription

      String getDescription()
       Optional. The description of the instance. 2048 characters or less.
      string description = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The description of the instance. 2048 characters or less.
      string description = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getStateValue

      int getStateValue()
       Output only. The instance state.
      .google.cloud.parallelstore.v1.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Instance.State getState()
       Output only. The instance state.
      .google.cloud.parallelstore.v1.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time when the instance was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The time when the instance was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time when the instance was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The time when the instance was updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time when the instance was updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time when the instance was updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getLabelsCount

      int getLabelsCount()
       Optional. Cloud Labels are a flexible and lightweight mechanism for
 organizing cloud resources into groups that reflect a customer's
 organizational needs and deployment strategies. See
 https://cloud.google.com/resource-manager/docs/labels-overview for details.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • containsLabels

      boolean containsLabels(String key)
       Optional. Cloud Labels are a flexible and lightweight mechanism for
 organizing cloud resources into groups that reflect a customer's
 organizational needs and deployment strategies. See
 https://cloud.google.com/resource-manager/docs/labels-overview for details.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. Cloud Labels are a flexible and lightweight mechanism for
 organizing cloud resources into groups that reflect a customer's
 organizational needs and deployment strategies. See
 https://cloud.google.com/resource-manager/docs/labels-overview for details.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Optional. Cloud Labels are a flexible and lightweight mechanism for
 organizing cloud resources into groups that reflect a customer's
 organizational needs and deployment strategies. See
 https://cloud.google.com/resource-manager/docs/labels-overview for details.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional. Cloud Labels are a flexible and lightweight mechanism for
 organizing cloud resources into groups that reflect a customer's
 organizational needs and deployment strategies. See
 https://cloud.google.com/resource-manager/docs/labels-overview for details.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getCapacityGib

      long getCapacityGib()
       Required. Immutable. The instance's storage capacity in Gibibytes (GiB).
 Allowed values are between 12000 and 100000, in multiples of 4000; e.g.,
 12000, 16000, 20000, ...
      int64 capacity_gib = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
      Returns:
      The capacityGib.

    • getDaosVersion

      @Deprecated String getDaosVersion()
      Deprecated.
      google.cloud.parallelstore.v1.Instance.daos_version is deprecated. See google/cloud/parallelstore/v1/parallelstore.proto;l=274
       Output only. Deprecated: The version of DAOS software running in the
 instance.
      string daos_version = 9 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The daosVersion.

    • getDaosVersionBytes

      @Deprecated com.google.protobuf.ByteString getDaosVersionBytes()
      Deprecated.
      google.cloud.parallelstore.v1.Instance.daos_version is deprecated. See google/cloud/parallelstore/v1/parallelstore.proto;l=274
       Output only. Deprecated: The version of DAOS software running in the
 instance.
      string daos_version = 9 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for daosVersion.

    • getAccessPointsList

      List<String> getAccessPointsList()
       Output only. A list of IPv4 addresses used for client side configuration.
      repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the accessPoints.

    • getAccessPointsCount

      int getAccessPointsCount()
       Output only. A list of IPv4 addresses used for client side configuration.
      repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of accessPoints.

    • getAccessPoints

      String getAccessPoints(int index)
       Output only. A list of IPv4 addresses used for client side configuration.
      repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The accessPoints at the given index.

    • getAccessPointsBytes

      com.google.protobuf.ByteString getAccessPointsBytes(int index)
       Output only. A list of IPv4 addresses used for client side configuration.
      repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the accessPoints at the given index.

    • getNetwork

      String getNetwork()
       Optional. Immutable. The name of the Compute Engine
 [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the
 instance is connected.
      string network = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The network.

    • getNetworkBytes

      com.google.protobuf.ByteString getNetworkBytes()
       Optional. Immutable. The name of the Compute Engine
 [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the
 instance is connected.
      string network = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for network.

    • getReservedIpRange

      String getReservedIpRange()
       Optional. Immutable. The ID of the IP address range being used by the
 instance's VPC network. See [Configure a VPC
 network](https://cloud.google.com/parallelstore/docs/vpc#create_and_configure_the_vpc).
 If no ID is provided, all ranges are considered.
      string reserved_ip_range = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The reservedIpRange.

    • getReservedIpRangeBytes

      com.google.protobuf.ByteString getReservedIpRangeBytes()
       Optional. Immutable. The ID of the IP address range being used by the
 instance's VPC network. See [Configure a VPC
 network](https://cloud.google.com/parallelstore/docs/vpc#create_and_configure_the_vpc).
 If no ID is provided, all ranges are considered.
      string reserved_ip_range = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for reservedIpRange.

    • getEffectiveReservedIpRange

      String getEffectiveReservedIpRange()
       Output only. Immutable. The ID of the IP address range being used by the
 instance's VPC network. This field is populated by the service and contains
 the value currently used by the service.
      string effective_reserved_ip_range = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The effectiveReservedIpRange.

    • getEffectiveReservedIpRangeBytes

      com.google.protobuf.ByteString getEffectiveReservedIpRangeBytes()
       Output only. Immutable. The ID of the IP address range being used by the
 instance's VPC network. This field is populated by the service and contains
 the value currently used by the service.
      string effective_reserved_ip_range = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for effectiveReservedIpRange.

    • getFileStripeLevelValue

      int getFileStripeLevelValue()
       Optional. Immutable. Stripe level for files. Allowed values are:

 * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size
 files.
 * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads
 involving a mix of small and large files.
 * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files.
      .google.cloud.parallelstore.v1.FileStripeLevel file_stripe_level = 15 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for fileStripeLevel.

    • getFileStripeLevel

      FileStripeLevel getFileStripeLevel()
       Optional. Immutable. Stripe level for files. Allowed values are:

 * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size
 files.
 * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads
 involving a mix of small and large files.
 * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files.
      .google.cloud.parallelstore.v1.FileStripeLevel file_stripe_level = 15 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The fileStripeLevel.

    • getDirectoryStripeLevelValue

      int getDirectoryStripeLevelValue()
       Optional. Immutable. Stripe level for directories. Allowed values are:

 * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a
 small number of files.
 * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads
 involving a mix of small and large directories.
 * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large
 number of files.
      .google.cloud.parallelstore.v1.DirectoryStripeLevel directory_stripe_level = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for directoryStripeLevel.

    • getDirectoryStripeLevel

      DirectoryStripeLevel getDirectoryStripeLevel()
       Optional. Immutable. Stripe level for directories. Allowed values are:

 * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a
 small number of files.
 * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads
 involving a mix of small and large directories.
 * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large
 number of files.
      .google.cloud.parallelstore.v1.DirectoryStripeLevel directory_stripe_level = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The directoryStripeLevel.

    • getDeploymentTypeValue

      int getDeploymentTypeValue()
       Optional. Immutable. The deployment type of the instance. Allowed values
 are:

 * `SCRATCH`: the instance is a scratch instance.
 * `PERSISTENT`: the instance is a persistent instance.
      .google.cloud.parallelstore.v1.DeploymentType deployment_type = 17 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for deploymentType.

    • getDeploymentType

      DeploymentType getDeploymentType()
       Optional. Immutable. The deployment type of the instance. Allowed values
 are:

 * `SCRATCH`: the instance is a scratch instance.
 * `PERSISTENT`: the instance is a persistent instance.
      .google.cloud.parallelstore.v1.DeploymentType deployment_type = 17 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The deploymentType.