Class BackendAuthenticationConfig.Builder (0.94.0)

public static final class BackendAuthenticationConfig.Builder extends GeneratedMessage.Builder<BackendAuthenticationConfig.Builder> 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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public BackendAuthenticationConfig build()
Returns
Type Description
BackendAuthenticationConfig

buildPartial()

public BackendAuthenticationConfig buildPartial()
Returns
Type Description
BackendAuthenticationConfig

clear()

public BackendAuthenticationConfig.Builder clear()
Returns
Type Description
BackendAuthenticationConfig.Builder
Overrides

clearClientCertificate()

public BackendAuthenticationConfig.Builder clearClientCertificate()

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) = { ... }

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

clearCreateTime()

public BackendAuthenticationConfig.Builder clearCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackendAuthenticationConfig.Builder

clearDescription()

public BackendAuthenticationConfig.Builder clearDescription()

Optional. Free-text description of the resource.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

clearEtag()

public BackendAuthenticationConfig.Builder clearEtag()

Output only. Etag of the resource.

string etag = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

clearLabels()

public BackendAuthenticationConfig.Builder clearLabels()
Returns
Type Description
BackendAuthenticationConfig.Builder

clearName()

public BackendAuthenticationConfig.Builder clearName()

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];

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

clearTrustConfig()

public BackendAuthenticationConfig.Builder clearTrustConfig()

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) = { ... }

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

clearUpdateTime()

public BackendAuthenticationConfig.Builder clearUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackendAuthenticationConfig.Builder

clearWellKnownRoots()

public BackendAuthenticationConfig.Builder clearWellKnownRoots()

Well known roots to use for server certificate validation.

.google.cloud.networksecurity.v1.BackendAuthenticationConfig.WellKnownRoots well_known_roots = 8;

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

containsLabels(String key)

public boolean containsLabels(String key)

Set of label tags associated with the resource.

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

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) = { ... }

Returns
Type Description
String

The clientCertificate.

getClientCertificateBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for clientCertificate.

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public BackendAuthenticationConfig getDefaultInstanceForType()
Returns
Type Description
BackendAuthenticationConfig

getDescription()

public String getDescription()

Optional. Free-text description of the resource.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Free-text description of the resource.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEtag()

public String getEtag()

Output only. Etag of the resource.

string etag = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. Etag of the resource.

string etag = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Set of label tags associated with the resource.

map<string, string> labels = 5;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Set of label tags associated with the resource.

map<string, string> labels = 5;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Set of label tags associated with the resource.

map<string, string> labels = 5;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Set of label tags associated with the resource.

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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];

Returns
Type Description
String

The name.

getNameBytes()

public 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];

Returns
Type Description
ByteString

The bytes for name.

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) = { ... }

Returns
Type Description
String

The trustConfig.

getTrustConfigBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for trustConfig.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getWellKnownRoots()

public BackendAuthenticationConfig.WellKnownRoots getWellKnownRoots()

Well known roots to use for server certificate validation.

.google.cloud.networksecurity.v1.BackendAuthenticationConfig.WellKnownRoots well_known_roots = 8;

Returns
Type Description
BackendAuthenticationConfig.WellKnownRoots

The wellKnownRoots.

getWellKnownRootsValue()

public int getWellKnownRootsValue()

Well known roots to use for server certificate validation.

.google.cloud.networksecurity.v1.BackendAuthenticationConfig.WellKnownRoots well_known_roots = 8;

Returns
Type Description
int

The enum numeric value on the wire for wellKnownRoots.

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];

Returns
Type Description
boolean

Whether the createTime field is set.

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];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public BackendAuthenticationConfig.Builder mergeCreateTime(Timestamp value)

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackendAuthenticationConfig.Builder

mergeFrom(BackendAuthenticationConfig other)

public BackendAuthenticationConfig.Builder mergeFrom(BackendAuthenticationConfig other)
Parameter
Name Description
other BackendAuthenticationConfig
Returns
Type Description
BackendAuthenticationConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackendAuthenticationConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendAuthenticationConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BackendAuthenticationConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BackendAuthenticationConfig.Builder
Overrides

mergeUpdateTime(Timestamp value)

public BackendAuthenticationConfig.Builder mergeUpdateTime(Timestamp value)

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackendAuthenticationConfig.Builder

putAllLabels(Map<String,String> values)

public BackendAuthenticationConfig.Builder putAllLabels(Map<String,String> values)

Set of label tags associated with the resource.

map<string, string> labels = 5;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
BackendAuthenticationConfig.Builder

putLabels(String key, String value)

public BackendAuthenticationConfig.Builder putLabels(String key, String value)

Set of label tags associated with the resource.

map<string, string> labels = 5;

Parameters
Name Description
key String
value String
Returns
Type Description
BackendAuthenticationConfig.Builder

removeLabels(String key)

public BackendAuthenticationConfig.Builder removeLabels(String key)

Set of label tags associated with the resource.

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
BackendAuthenticationConfig.Builder

setClientCertificate(String value)

public BackendAuthenticationConfig.Builder setClientCertificate(String value)

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) = { ... }

Parameter
Name Description
value String

The clientCertificate to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setClientCertificateBytes(ByteString value)

public BackendAuthenticationConfig.Builder setClientCertificateBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for clientCertificate to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public BackendAuthenticationConfig.Builder setCreateTime(Timestamp value)

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackendAuthenticationConfig.Builder

setCreateTime(Timestamp.Builder builderForValue)

public BackendAuthenticationConfig.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BackendAuthenticationConfig.Builder

setDescription(String value)

public BackendAuthenticationConfig.Builder setDescription(String value)

Optional. Free-text description of the resource.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public BackendAuthenticationConfig.Builder setDescriptionBytes(ByteString value)

Optional. Free-text description of the resource.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setEtag(String value)

public BackendAuthenticationConfig.Builder setEtag(String value)

Output only. Etag of the resource.

string etag = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public BackendAuthenticationConfig.Builder setEtagBytes(ByteString value)

Output only. Etag of the resource.

string etag = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setName(String value)

public BackendAuthenticationConfig.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public BackendAuthenticationConfig.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setTrustConfig(String value)

public BackendAuthenticationConfig.Builder setTrustConfig(String value)

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) = { ... }

Parameter
Name Description
value String

The trustConfig to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setTrustConfigBytes(ByteString value)

public BackendAuthenticationConfig.Builder setTrustConfigBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for trustConfig to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public BackendAuthenticationConfig.Builder setUpdateTime(Timestamp value)

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackendAuthenticationConfig.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public BackendAuthenticationConfig.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BackendAuthenticationConfig.Builder

setWellKnownRoots(BackendAuthenticationConfig.WellKnownRoots value)

public BackendAuthenticationConfig.Builder setWellKnownRoots(BackendAuthenticationConfig.WellKnownRoots value)

Well known roots to use for server certificate validation.

.google.cloud.networksecurity.v1.BackendAuthenticationConfig.WellKnownRoots well_known_roots = 8;

Parameter
Name Description
value BackendAuthenticationConfig.WellKnownRoots

The wellKnownRoots to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.

setWellKnownRootsValue(int value)

public BackendAuthenticationConfig.Builder setWellKnownRootsValue(int value)

Well known roots to use for server certificate validation.

.google.cloud.networksecurity.v1.BackendAuthenticationConfig.WellKnownRoots well_known_roots = 8;

Parameter
Name Description
value int

The enum numeric value on the wire for wellKnownRoots to set.

Returns
Type Description
BackendAuthenticationConfig.Builder

This builder for chaining.