Package com.google.cloud.securesourcemanager.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. A unique identifier for an instance. The name should be of the
 format:
 `projects/{project_number}/locations/{location_id}/instances/{instance_id}`

 `project_number`: Maps to a unique int64 id assigned to each project.

 `location_id`: Refers to the region where the instance will be deployed.
 Since Secure Source Manager is a regional service, it must be one of the
 valid GCP regions.

 `instance_id`: User provided name for the instance, must be unique for a
 project_number and location_id combination.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. A unique identifier for an instance. The name should be of the
 format:
 `projects/{project_number}/locations/{location_id}/instances/{instance_id}`

 `project_number`: Maps to a unique int64 id assigned to each project.

 `location_id`: Refers to the region where the instance will be deployed.
 Since Secure Source Manager is a regional service, it must be one of the
 valid GCP regions.

 `instance_id`: User provided name for the instance, must be unique for a
 project_number and location_id combination.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Create timestamp.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Create timestamp.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Create timestamp.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Update timestamp.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Update timestamp.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Update timestamp.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getLabelsCount

      int getLabelsCount()
       Optional. Labels as key value pairs.
 Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes.
 For more information, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/best-practices-labels#label_encoding).
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

    • containsLabels

      boolean containsLabels(String key)
       Optional. Labels as key value pairs.
 Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes.
 For more information, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/best-practices-labels#label_encoding).
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getLabels

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

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. Labels as key value pairs.
 Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes.
 For more information, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/best-practices-labels#label_encoding).
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Optional. Labels as key value pairs.
 Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes.
 For more information, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/best-practices-labels#label_encoding).
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional. Labels as key value pairs.
 Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes.
 For more information, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/best-practices-labels#label_encoding).
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

    • hasPrivateConfig

      boolean hasPrivateConfig()
       Optional. Private settings for private instance.
      .google.cloud.securesourcemanager.v1.Instance.PrivateConfig private_config = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the privateConfig field is set.

    • getPrivateConfig

      Instance.PrivateConfig getPrivateConfig()
       Optional. Private settings for private instance.
      .google.cloud.securesourcemanager.v1.Instance.PrivateConfig private_config = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The privateConfig.

    • getPrivateConfigOrBuilder

      Instance.PrivateConfigOrBuilder getPrivateConfigOrBuilder()
       Optional. Private settings for private instance.
      .google.cloud.securesourcemanager.v1.Instance.PrivateConfig private_config = 13 [(.google.api.field_behavior) = OPTIONAL];

    • getStateValue

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

    • getState

      Instance.State getState()
       Output only. Current state of the instance.
      .google.cloud.securesourcemanager.v1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • getStateNoteValue

      int getStateNoteValue()
       Output only. An optional field providing information about the current
 instance state.
      .google.cloud.securesourcemanager.v1.Instance.StateNote state_note = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for stateNote.

    • getStateNote

      Instance.StateNote getStateNote()
       Output only. An optional field providing information about the current
 instance state.
      .google.cloud.securesourcemanager.v1.Instance.StateNote state_note = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The stateNote.

    • getKmsKey

      String getKmsKey()
       Optional. Immutable. Customer-managed encryption key name, in the format
 projects/*/locations/*/keyRings/*/cryptoKeys/*.
      string kms_key = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The kmsKey.

    • getKmsKeyBytes

      com.google.protobuf.ByteString getKmsKeyBytes()
       Optional. Immutable. Customer-managed encryption key name, in the format
 projects/*/locations/*/keyRings/*/cryptoKeys/*.
      string kms_key = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for kmsKey.

    • hasHostConfig

      boolean hasHostConfig()
       Output only. A list of hostnames for this instance.
      .google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the hostConfig field is set.

    • getHostConfig

      Instance.HostConfig getHostConfig()
       Output only. A list of hostnames for this instance.
      .google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The hostConfig.

    • getHostConfigOrBuilder

      Instance.HostConfigOrBuilder getHostConfigOrBuilder()
       Output only. A list of hostnames for this instance.
      .google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasWorkforceIdentityFederationConfig

      boolean hasWorkforceIdentityFederationConfig()
       Optional. Configuration for Workforce Identity Federation to support
 third party identity provider. If unset, defaults to the Google OIDC IdP.
      .google.cloud.securesourcemanager.v1.Instance.WorkforceIdentityFederationConfig workforce_identity_federation_config = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the workforceIdentityFederationConfig field is set.

    • getWorkforceIdentityFederationConfig

      Instance.WorkforceIdentityFederationConfig getWorkforceIdentityFederationConfig()
       Optional. Configuration for Workforce Identity Federation to support
 third party identity provider. If unset, defaults to the Google OIDC IdP.
      .google.cloud.securesourcemanager.v1.Instance.WorkforceIdentityFederationConfig workforce_identity_federation_config = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The workforceIdentityFederationConfig.

    • getWorkforceIdentityFederationConfigOrBuilder

      Instance.WorkforceIdentityFederationConfigOrBuilder getWorkforceIdentityFederationConfigOrBuilder()
       Optional. Configuration for Workforce Identity Federation to support
 third party identity provider. If unset, defaults to the Google OIDC IdP.
      .google.cloud.securesourcemanager.v1.Instance.WorkforceIdentityFederationConfig workforce_identity_federation_config = 14 [(.google.api.field_behavior) = OPTIONAL];