com.google.cloud.parallelstore.v1beta.InstanceOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/parallelstore/v1beta/parallelstore.proto

// Protobuf Java Version: 3.25.3
package com.google.cloud.parallelstore.v1beta;

public interface InstanceOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.parallelstore.v1beta.Instance)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * 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];
   *
   * @return The name.
   */
  java.lang.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];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Optional. The description of the instance. 2048 characters or less.
   * 
   *
   * string description = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   *    * Optional. The description of the instance. 2048 characters or less.
   * 
   *
   * string description = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   *    * Output only. The instance state.
   * 
   *
   * 
   * .google.cloud.parallelstore.v1beta.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *
   *
   *    * Output only. The instance state.
   * 
   *
   * 
   * .google.cloud.parallelstore.v1beta.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The state.
   */
  com.google.cloud.parallelstore.v1beta.Instance.State getState();

  /**
   *
   *
   *    * Output only. The time when the instance was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the createTime field is set.
   */
  boolean hasCreateTime();
  /**
   *
   *
   *    * Output only. The time when the instance was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The createTime.
   */
  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];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  /**
   *
   *
   *    * Output only. The time when the instance was updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the updateTime field is set.
   */
  boolean hasUpdateTime();
  /**
   *
   *
   *    * Output only. The time when the instance was updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The updateTime.
   */
  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];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();

  /**
   *
   *
   *    * 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. Cloud Labels can be used to
   * filter collections of resources. They can be used to control how resource
   * metrics are aggregated. And they can be used as arguments to policy
   * management rules (e.g. route, firewall, load balancing, etc.).
   *
   *  * Label keys must be between 1 and 63 characters long and must conform to
   *    the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
   *  * Label values must be between 0 and 63 characters long and must conform
   *    to the regular expression `[a-z0-9_-]{0,63}`.
   *  * No more than 64 labels can be associated with a given resource.
   *
   * See https://goo.gl/xmQnxf for more information on and examples of labels.
   *
   * If you plan to use labels in your own code, please note that additional
   * characters may be allowed in the future. Therefore, you are advised to use
   * an internal label representation, such as JSON, which doesn't rely upon
   * specific characters being disallowed.  For example, representing labels
   * as the string:  name + "_" + value  would prove problematic if we were to
   * allow "_" in a future release.
   * 
   *
   * map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
   */
  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. Cloud Labels can be used to
   * filter collections of resources. They can be used to control how resource
   * metrics are aggregated. And they can be used as arguments to policy
   * management rules (e.g. route, firewall, load balancing, etc.).
   *
   *  * Label keys must be between 1 and 63 characters long and must conform to
   *    the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
   *  * Label values must be between 0 and 63 characters long and must conform
   *    to the regular expression `[a-z0-9_-]{0,63}`.
   *  * No more than 64 labels can be associated with a given resource.
   *
   * See https://goo.gl/xmQnxf for more information on and examples of labels.
   *
   * If you plan to use labels in your own code, please note that additional
   * characters may be allowed in the future. Therefore, you are advised to use
   * an internal label representation, such as JSON, which doesn't rely upon
   * specific characters being disallowed.  For example, representing labels
   * as the string:  name + "_" + value  would prove problematic if we were to
   * allow "_" in a future release.
   * 
   *
   * map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
   */
  boolean containsLabels(java.lang.String key);
  /** Use {@link #getLabelsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getLabels();
  /**
   *
   *
   *    * 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. Cloud Labels can be used to
   * filter collections of resources. They can be used to control how resource
   * metrics are aggregated. And they can be used as arguments to policy
   * management rules (e.g. route, firewall, load balancing, etc.).
   *
   *  * Label keys must be between 1 and 63 characters long and must conform to
   *    the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
   *  * Label values must be between 0 and 63 characters long and must conform
   *    to the regular expression `[a-z0-9_-]{0,63}`.
   *  * No more than 64 labels can be associated with a given resource.
   *
   * See https://goo.gl/xmQnxf for more information on and examples of labels.
   *
   * If you plan to use labels in your own code, please note that additional
   * characters may be allowed in the future. Therefore, you are advised to use
   * an internal label representation, such as JSON, which doesn't rely upon
   * specific characters being disallowed.  For example, representing labels
   * as the string:  name + "_" + value  would prove problematic if we were to
   * allow "_" in a future release.
   * 
   *
   * map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.util.Map 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. Cloud Labels can be used to
   * filter collections of resources. They can be used to control how resource
   * metrics are aggregated. And they can be used as arguments to policy
   * management rules (e.g. route, firewall, load balancing, etc.).
   *
   *  * Label keys must be between 1 and 63 characters long and must conform to
   *    the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
   *  * Label values must be between 0 and 63 characters long and must conform
   *    to the regular expression `[a-z0-9_-]{0,63}`.
   *  * No more than 64 labels can be associated with a given resource.
   *
   * See https://goo.gl/xmQnxf for more information on and examples of labels.
   *
   * If you plan to use labels in your own code, please note that additional
   * characters may be allowed in the future. Therefore, you are advised to use
   * an internal label representation, such as JSON, which doesn't rely upon
   * specific characters being disallowed.  For example, representing labels
   * as the string:  name + "_" + value  would prove problematic if we were to
   * allow "_" in a future release.
   * 
   *
   * map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
   */
  /* nullable */
  java.lang.String getLabelsOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.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. Cloud Labels can be used to
   * filter collections of resources. They can be used to control how resource
   * metrics are aggregated. And they can be used as arguments to policy
   * management rules (e.g. route, firewall, load balancing, etc.).
   *
   *  * Label keys must be between 1 and 63 characters long and must conform to
   *    the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
   *  * Label values must be between 0 and 63 characters long and must conform
   *    to the regular expression `[a-z0-9_-]{0,63}`.
   *  * No more than 64 labels can be associated with a given resource.
   *
   * See https://goo.gl/xmQnxf for more information on and examples of labels.
   *
   * If you plan to use labels in your own code, please note that additional
   * characters may be allowed in the future. Therefore, you are advised to use
   * an internal label representation, such as JSON, which doesn't rely upon
   * specific characters being disallowed.  For example, representing labels
   * as the string:  name + "_" + value  would prove problematic if we were to
   * allow "_" in a future release.
   * 
   *
   * map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.lang.String getLabelsOrThrow(java.lang.String key);

  /**
   *
   *
   *    * Required. Immutable. Storage capacity of Parallelstore instance in
   * Gibibytes (GiB).
   * 
   *
   * 
   * int64 capacity_gib = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The capacityGib.
   */
  long getCapacityGib();

  /**
   *
   *
   *    * Output only. The version of DAOS software running in the instance
   * 
   *
   * string daos_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The daosVersion.
   */
  java.lang.String getDaosVersion();
  /**
   *
   *
   *    * Output only. The version of DAOS software running in the instance
   * 
   *
   * string daos_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for daosVersion.
   */
  com.google.protobuf.ByteString getDaosVersionBytes();

  /**
   *
   *
   *    * Output only. List of access_points.
   * Contains a list of IPv4 addresses used for client side configuration.
   * 
   *
   * repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return A list containing the accessPoints.
   */
  java.util.List getAccessPointsList();
  /**
   *
   *
   *    * Output only. List of access_points.
   * Contains a list of IPv4 addresses used for client side configuration.
   * 
   *
   * repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The count of accessPoints.
   */
  int getAccessPointsCount();
  /**
   *
   *
   *    * Output only. List of access_points.
   * Contains a list of IPv4 addresses used for client side configuration.
   * 
   *
   * repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @param index The index of the element to return.
   * @return The accessPoints at the given index.
   */
  java.lang.String getAccessPoints(int index);
  /**
   *
   *
   *    * Output only. List of access_points.
   * Contains a list of IPv4 addresses used for client side configuration.
   * 
   *
   * repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @param index The index of the value to return.
   * @return The bytes of the accessPoints at the given index.
   */
  com.google.protobuf.ByteString getAccessPointsBytes(int index);

  /**
   *
   *
   *    * Optional. Immutable. The name of the Google 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) = { ... }
   * 
   *
   * @return The network.
   */
  java.lang.String getNetwork();
  /**
   *
   *
   *    * Optional. Immutable. The name of the Google 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) = { ... }
   * 
   *
   * @return The bytes for network.
   */
  com.google.protobuf.ByteString getNetworkBytes();

  /**
   *
   *
   *    * Optional. Immutable. Contains the id of the allocated IP address range
   * associated with the private service access connection for example,
   * "test-default" associated with IP range 10.0.0.0/29. If no range id is
   * provided all ranges will be considered.
   * 
   *
   * 
   * string reserved_ip_range = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The reservedIpRange.
   */
  java.lang.String getReservedIpRange();
  /**
   *
   *
   *    * Optional. Immutable. Contains the id of the allocated IP address range
   * associated with the private service access connection for example,
   * "test-default" associated with IP range 10.0.0.0/29. If no range id is
   * provided all ranges will be considered.
   * 
   *
   * 
   * string reserved_ip_range = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for reservedIpRange.
   */
  com.google.protobuf.ByteString getReservedIpRangeBytes();

  /**
   *
   *
   *    * Output only. Immutable. Contains the id of the allocated IP address range
   * associated with the private service access connection for example,
   * "test-default" associated with IP range 10.0.0.0/29. This field is
   * populated by the service and 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) = { ... }
   * 
   *
   * @return The effectiveReservedIpRange.
   */
  java.lang.String getEffectiveReservedIpRange();
  /**
   *
   *
   *    * Output only. Immutable. Contains the id of the allocated IP address range
   * associated with the private service access connection for example,
   * "test-default" associated with IP range 10.0.0.0/29. This field is
   * populated by the service and 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) = { ... }
   * 
   *
   * @return The bytes for effectiveReservedIpRange.
   */
  com.google.protobuf.ByteString getEffectiveReservedIpRangeBytes();
}