Package com.google.cloud.securesourcemanager.v1

Class Instance

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.securesourcemanager.v1.Instance
All Implemented Interfaces:
InstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Instance extends com.google.protobuf.GeneratedMessage implements InstanceOrBuilder
 A resource that represents a Secure Source Manager instance.
Protobuf type google.cloud.securesourcemanager.v1.Instance
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • PRIVATE_CONFIG_FIELD_NUMBER

      public static final int PRIVATE_CONFIG_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • STATE_NOTE_FIELD_NUMBER

      public static final int STATE_NOTE_FIELD_NUMBER
      See Also:

    • KMS_KEY_FIELD_NUMBER

      public static final int KMS_KEY_FIELD_NUMBER
      See Also:

    • HOST_CONFIG_FIELD_NUMBER

      public static final int HOST_CONFIG_FIELD_NUMBER
      See Also:

    • WORKFORCE_IDENTITY_FEDERATION_CONFIG_FIELD_NUMBER

      public static final int WORKFORCE_IDENTITY_FEDERATION_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public 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];
      Specified by:
      getName in interface InstanceOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface InstanceOrBuilder
      Returns:
      The bytes for name.

    • hasCreateTime

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

    • getCreateTime

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

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Create timestamp.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface InstanceOrBuilder

    • hasUpdateTime

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

    • getUpdateTime

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

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Update timestamp.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface InstanceOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: InstanceOrBuilder
       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];
      Specified by:
      getLabelsCount in interface InstanceOrBuilder

    • containsLabels

      public 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];
      Specified by:
      containsLabels in interface InstanceOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface InstanceOrBuilder

    • getLabelsMap

      public 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];
      Specified by:
      getLabelsMap in interface InstanceOrBuilder

    • getLabelsOrDefault

      public 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];
      Specified by:
      getLabelsOrDefault in interface InstanceOrBuilder

    • getLabelsOrThrow

      public 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];
      Specified by:
      getLabelsOrThrow in interface InstanceOrBuilder

    • hasPrivateConfig

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

    • getPrivateConfig

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

    • getPrivateConfigOrBuilder

      public Instance.PrivateConfigOrBuilder getPrivateConfigOrBuilder()
       Optional. Private settings for private instance.
      .google.cloud.securesourcemanager.v1.Instance.PrivateConfig private_config = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrivateConfigOrBuilder in interface InstanceOrBuilder

    • getStateValue

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

    • getState

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

    • getStateNoteValue

      public 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];
      Specified by:
      getStateNoteValue in interface InstanceOrBuilder
      Returns:
      The enum numeric value on the wire for stateNote.

    • getStateNote

      public 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];
      Specified by:
      getStateNote in interface InstanceOrBuilder
      Returns:
      The stateNote.

    • getKmsKey

      public 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) = { ... }
      Specified by:
      getKmsKey in interface InstanceOrBuilder
      Returns:
      The kmsKey.

    • getKmsKeyBytes

      public 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) = { ... }
      Specified by:
      getKmsKeyBytes in interface InstanceOrBuilder
      Returns:
      The bytes for kmsKey.

    • hasHostConfig

      public 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];
      Specified by:
      hasHostConfig in interface InstanceOrBuilder
      Returns:
      Whether the hostConfig field is set.

    • getHostConfig

      public 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];
      Specified by:
      getHostConfig in interface InstanceOrBuilder
      Returns:
      The hostConfig.

    • getHostConfigOrBuilder

      public 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];
      Specified by:
      getHostConfigOrBuilder in interface InstanceOrBuilder

    • hasWorkforceIdentityFederationConfig

      public 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];
      Specified by:
      hasWorkforceIdentityFederationConfig in interface InstanceOrBuilder
      Returns:
      Whether the workforceIdentityFederationConfig field is set.

    • getWorkforceIdentityFederationConfig

      public 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];
      Specified by:
      getWorkforceIdentityFederationConfig in interface InstanceOrBuilder
      Returns:
      The workforceIdentityFederationConfig.

    • getWorkforceIdentityFederationConfigOrBuilder

      public 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];
      Specified by:
      getWorkforceIdentityFederationConfigOrBuilder in interface InstanceOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Instance parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Instance parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Instance parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Instance parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Instance parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Instance parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Instance parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Instance parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Instance parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Instance parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Instance parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Instance parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Instance.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Instance.Builder newBuilder()

    • newBuilder

      public static Instance.Builder newBuilder(Instance prototype)

    • toBuilder

      public Instance.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Instance.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Instance getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Instance> parser()

    • getParserForType

      public com.google.protobuf.Parser<Instance> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Instance getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder