Package com.google.cloud.networksecurity.v1

Class BackendAuthenticationConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.networksecurity.v1.BackendAuthenticationConfig
All Implemented Interfaces:
BackendAuthenticationConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class BackendAuthenticationConfig extends com.google.protobuf.GeneratedMessage implements BackendAuthenticationConfigOrBuilder
 BackendAuthenticationConfig message groups the TrustConfig together with
 other settings that control how the load balancer authenticates, and
 expresses its identity to, the backend:

 * `trustConfig` is the attached TrustConfig.

 * `wellKnownRoots` indicates whether the load balance should trust backend
 server certificates that are issued by public certificate authorities, in
 addition to certificates trusted by the TrustConfig.

 * `clientCertificate` is a client certificate that the load balancer uses to
 express its identity to the backend, if the connection to the backend uses
 mTLS.

 You can attach the BackendAuthenticationConfig to the load balancer's
 BackendService directly determining how that BackendService negotiates TLS.
Protobuf type google.cloud.networksecurity.v1.BackendAuthenticationConfig
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_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:

    • CLIENT_CERTIFICATE_FIELD_NUMBER

      public static final int CLIENT_CERTIFICATE_FIELD_NUMBER
      See Also:

    • TRUST_CONFIG_FIELD_NUMBER

      public static final int TRUST_CONFIG_FIELD_NUMBER
      See Also:

    • WELL_KNOWN_ROOTS_FIELD_NUMBER

      public static final int WELL_KNOWN_ROOTS_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_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()
       Required. Name of the BackendAuthenticationConfig resource. It matches the
 pattern
 `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. Name of the BackendAuthenticationConfig resource. It matches the
 pattern
 `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The bytes for name.

    • getDescription

      public String getDescription()
       Optional. Free-text description of the resource.
      string description = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Free-text description of the resource.
      string description = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The bytes for description.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The timestamp when the resource was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface BackendAuthenticationConfigOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp when the resource was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp when the resource was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface BackendAuthenticationConfigOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The timestamp when the resource was updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface BackendAuthenticationConfigOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The timestamp when the resource was updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The timestamp when the resource was updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface BackendAuthenticationConfigOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: BackendAuthenticationConfigOrBuilder
       Set of label tags associated with the resource.
      map<string, string> labels = 5;
      Specified by:
      getLabelsCount in interface BackendAuthenticationConfigOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Set of label tags associated with the resource.
      map<string, string> labels = 5;
      Specified by:
      containsLabels in interface BackendAuthenticationConfigOrBuilder

    • getLabels

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

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Set of label tags associated with the resource.
      map<string, string> labels = 5;
      Specified by:
      getLabelsMap in interface BackendAuthenticationConfigOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Set of label tags associated with the resource.
      map<string, string> labels = 5;
      Specified by:
      getLabelsOrDefault in interface BackendAuthenticationConfigOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Set of label tags associated with the resource.
      map<string, string> labels = 5;
      Specified by:
      getLabelsOrThrow in interface BackendAuthenticationConfigOrBuilder

    • getClientCertificate

      public String getClientCertificate()
       Optional. A reference to a certificatemanager.googleapis.com.Certificate
 resource. This is a relative resource path following the form
 "projects/{project}/locations/{location}/certificates/{certificate}".

 Used by a BackendService to negotiate mTLS when the backend connection uses
 TLS and the backend requests a client certificate. Must have a CLIENT_AUTH
 scope.
      string client_certificate = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getClientCertificate in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The clientCertificate.

    • getClientCertificateBytes

      public com.google.protobuf.ByteString getClientCertificateBytes()
       Optional. A reference to a certificatemanager.googleapis.com.Certificate
 resource. This is a relative resource path following the form
 "projects/{project}/locations/{location}/certificates/{certificate}".

 Used by a BackendService to negotiate mTLS when the backend connection uses
 TLS and the backend requests a client certificate. Must have a CLIENT_AUTH
 scope.
      string client_certificate = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getClientCertificateBytes in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The bytes for clientCertificate.

    • getTrustConfig

      public String getTrustConfig()
       Optional. A reference to a TrustConfig resource from the
 certificatemanager.googleapis.com namespace. This is a relative resource
 path following the form
 "projects/{project}/locations/{location}/trustConfigs/{trust_config}".

 A BackendService uses the chain of trust represented by this TrustConfig,
 if specified, to validate the server certificates presented by the backend.
 Required unless wellKnownRoots is set to PUBLIC_ROOTS.
      string trust_config = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getTrustConfig in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The trustConfig.

    • getTrustConfigBytes

      public com.google.protobuf.ByteString getTrustConfigBytes()
       Optional. A reference to a TrustConfig resource from the
 certificatemanager.googleapis.com namespace. This is a relative resource
 path following the form
 "projects/{project}/locations/{location}/trustConfigs/{trust_config}".

 A BackendService uses the chain of trust represented by this TrustConfig,
 if specified, to validate the server certificates presented by the backend.
 Required unless wellKnownRoots is set to PUBLIC_ROOTS.
      string trust_config = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getTrustConfigBytes in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The bytes for trustConfig.

    • getWellKnownRootsValue

      public int getWellKnownRootsValue()
       Well known roots to use for server certificate validation.
      .google.cloud.networksecurity.v1.BackendAuthenticationConfig.WellKnownRoots well_known_roots = 8;
      Specified by:
      getWellKnownRootsValue in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The enum numeric value on the wire for wellKnownRoots.

    • getWellKnownRoots

      public BackendAuthenticationConfig.WellKnownRoots getWellKnownRoots()
       Well known roots to use for server certificate validation.
      .google.cloud.networksecurity.v1.BackendAuthenticationConfig.WellKnownRoots well_known_roots = 8;
      Specified by:
      getWellKnownRoots in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The wellKnownRoots.

    • getEtag

      public String getEtag()
       Output only. Etag of the resource.
      string etag = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEtag in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       Output only. Etag of the resource.
      string etag = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEtagBytes in interface BackendAuthenticationConfigOrBuilder
      Returns:
      The bytes for etag.

    • 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 BackendAuthenticationConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BackendAuthenticationConfig.Builder newBuilder()

    • newBuilder

      public static BackendAuthenticationConfig.Builder newBuilder(BackendAuthenticationConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static BackendAuthenticationConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<BackendAuthenticationConfig> 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 BackendAuthenticationConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder