Interface BackendServiceTlsSettingsOrBuilder (1.109.0)

1.109.0 (latest) 1.105.0 1.104.0 1.103.0 1.101.0 1.98.0 1.97.0 1.95.0 1.93.0 1.92.0 1.91.0 1.90.0 1.88.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.80.0 1.78.0 1.77.0 1.74.0 1.73.0 1.72.0 1.70.0 1.69.0 1.68.0 1.67.0 1.66.0 1.65.0 1.64.0 1.63.0 1.62.0 1.61.0 1.59.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.0 1.12.1 1.11.0 1.9.1 1.8.1 1.7.2 1.6.0-beta

public interface BackendServiceTlsSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuthenticationConfig()

public abstract String getAuthenticationConfig()

Reference to the BackendAuthenticationConfig resource from the networksecurity.googleapis.com namespace. Can be used in authenticating TLS connections to the backend, as specified by the authenticationMode field. Can only be specified if authenticationMode is not NONE.

optional string authentication_config = 408053481;

Returns
Type	Description
String	The authenticationConfig.

getAuthenticationConfigBytes()

public abstract ByteString getAuthenticationConfigBytes()

Reference to the BackendAuthenticationConfig resource from the networksecurity.googleapis.com namespace. Can be used in authenticating TLS connections to the backend, as specified by the authenticationMode field. Can only be specified if authenticationMode is not NONE.

optional string authentication_config = 408053481;

Returns
Type	Description
ByteString	The bytes for authenticationConfig.

getIdentity()

public abstract String getIdentity()

Assigns the Managed Identity for the BackendService Workload.

Use this property to configure the load balancer back-end to use certificates and roots of trust provisioned by the Managed Workload Identity system.

The identity property is the fully-specified SPIFFE ID to use in the SVID presented by the Load Balancer Workload.

The SPIFFE ID must be a resource starting with the trustDomain property value, followed by the path to the Managed Workload Identity.

Supported SPIFFE ID format:

• //<trust_domain>/ns/<namespace>/sa/<subject>

The Trust Domain within the Managed Identity must refer to a valid Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig will be inherited from the Workload Identity Pool.

Restrictions:

• If you set the identity property, you cannot manually set the following fields:
• tlsSettings.sni
• tlsSettings.subjectAltNames
• tlsSettings.authenticationConfig

When defining a identity for a RegionBackendServices, the corresponding Workload Identity Pool must have a ca_pool configured in the same region.

The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.

optional string identity = 401109182;

Returns
Type	Description
String	The identity.

getIdentityBytes()

public abstract ByteString getIdentityBytes()

Assigns the Managed Identity for the BackendService Workload.

Use this property to configure the load balancer back-end to use certificates and roots of trust provisioned by the Managed Workload Identity system.

The identity property is the fully-specified SPIFFE ID to use in the SVID presented by the Load Balancer Workload.

The SPIFFE ID must be a resource starting with the trustDomain property value, followed by the path to the Managed Workload Identity.

Supported SPIFFE ID format:

• //<trust_domain>/ns/<namespace>/sa/<subject>

The Trust Domain within the Managed Identity must refer to a valid Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig will be inherited from the Workload Identity Pool.

Restrictions:

• If you set the identity property, you cannot manually set the following fields:
• tlsSettings.sni
• tlsSettings.subjectAltNames
• tlsSettings.authenticationConfig

When defining a identity for a RegionBackendServices, the corresponding Workload Identity Pool must have a ca_pool configured in the same region.

The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.

optional string identity = 401109182;

Returns
Type	Description
ByteString	The bytes for identity.

getSni()

public abstract String getSni()

Server Name Indication - see RFC3546 section 3.1. If set, the load balancer sends this string as the SNI hostname in the TLS connection to the backend, and requires that this string match a Subject Alternative Name (SAN) in the backend's server certificate. With a Regional Internet NEG backend, if the SNI is specified here, the load balancer uses it regardless of whether the Regional Internet NEG is specified with FQDN or IP address and port. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[].

optional string sni = 114030;

Returns
Type	Description
String	The sni.

getSniBytes()

public abstract ByteString getSniBytes()

Server Name Indication - see RFC3546 section 3.1. If set, the load balancer sends this string as the SNI hostname in the TLS connection to the backend, and requires that this string match a Subject Alternative Name (SAN) in the backend's server certificate. With a Regional Internet NEG backend, if the SNI is specified here, the load balancer uses it regardless of whether the Regional Internet NEG is specified with FQDN or IP address and port. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[].

optional string sni = 114030;

Returns
Type	Description
ByteString	The bytes for sni.

getSubjectAltNames(int index)

public abstract BackendServiceTlsSettingsSubjectAltName getSubjectAltNames(int index)

A list of Subject Alternative Names (SANs) that the Load Balancer verifies during a TLS handshake with the backend. When the server presents its X.509 certificate to the Load Balancer, the Load Balancer inspects the certificate's SAN field, and requires that at least one SAN match one of the subjectAltNames in the list. This field is limited to 5 entries. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[].

repeated .google.cloud.compute.v1.BackendServiceTlsSettingsSubjectAltName subject_alt_names = 330029535;

Parameter
Name	Description
index	int

Returns
Type	Description
BackendServiceTlsSettingsSubjectAltName

getSubjectAltNamesCount()

public abstract int getSubjectAltNamesCount()

A list of Subject Alternative Names (SANs) that the Load Balancer verifies during a TLS handshake with the backend. When the server presents its X.509 certificate to the Load Balancer, the Load Balancer inspects the certificate's SAN field, and requires that at least one SAN match one of the subjectAltNames in the list. This field is limited to 5 entries. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[].

repeated .google.cloud.compute.v1.BackendServiceTlsSettingsSubjectAltName subject_alt_names = 330029535;

Returns
Type	Description
int

getSubjectAltNamesList()

public abstract List<BackendServiceTlsSettingsSubjectAltName> getSubjectAltNamesList()

A list of Subject Alternative Names (SANs) that the Load Balancer verifies during a TLS handshake with the backend. When the server presents its X.509 certificate to the Load Balancer, the Load Balancer inspects the certificate's SAN field, and requires that at least one SAN match one of the subjectAltNames in the list. This field is limited to 5 entries. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[].

repeated .google.cloud.compute.v1.BackendServiceTlsSettingsSubjectAltName subject_alt_names = 330029535;

Returns
Type	Description
List<BackendServiceTlsSettingsSubjectAltName>

getSubjectAltNamesOrBuilder(int index)

public abstract BackendServiceTlsSettingsSubjectAltNameOrBuilder getSubjectAltNamesOrBuilder(int index)

A list of Subject Alternative Names (SANs) that the Load Balancer verifies during a TLS handshake with the backend. When the server presents its X.509 certificate to the Load Balancer, the Load Balancer inspects the certificate's SAN field, and requires that at least one SAN match one of the subjectAltNames in the list. This field is limited to 5 entries. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[].

repeated .google.cloud.compute.v1.BackendServiceTlsSettingsSubjectAltName subject_alt_names = 330029535;

Parameter
Name	Description
index	int

Returns
Type	Description
BackendServiceTlsSettingsSubjectAltNameOrBuilder

getSubjectAltNamesOrBuilderList()

public abstract List<? extends BackendServiceTlsSettingsSubjectAltNameOrBuilder> getSubjectAltNamesOrBuilderList()

A list of Subject Alternative Names (SANs) that the Load Balancer verifies during a TLS handshake with the backend. When the server presents its X.509 certificate to the Load Balancer, the Load Balancer inspects the certificate's SAN field, and requires that at least one SAN match one of the subjectAltNames in the list. This field is limited to 5 entries. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[].

repeated .google.cloud.compute.v1.BackendServiceTlsSettingsSubjectAltName subject_alt_names = 330029535;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.BackendServiceTlsSettingsSubjectAltNameOrBuilder>

hasAuthenticationConfig()

public abstract boolean hasAuthenticationConfig()

Reference to the BackendAuthenticationConfig resource from the networksecurity.googleapis.com namespace. Can be used in authenticating TLS connections to the backend, as specified by the authenticationMode field. Can only be specified if authenticationMode is not NONE.

optional string authentication_config = 408053481;

Returns
Type	Description
boolean	Whether the authenticationConfig field is set.

hasIdentity()

public abstract boolean hasIdentity()

Assigns the Managed Identity for the BackendService Workload.

Use this property to configure the load balancer back-end to use certificates and roots of trust provisioned by the Managed Workload Identity system.

The identity property is the fully-specified SPIFFE ID to use in the SVID presented by the Load Balancer Workload.

The SPIFFE ID must be a resource starting with the trustDomain property value, followed by the path to the Managed Workload Identity.

Supported SPIFFE ID format:

• //<trust_domain>/ns/<namespace>/sa/<subject>

The Trust Domain within the Managed Identity must refer to a valid Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig will be inherited from the Workload Identity Pool.

Restrictions:

• If you set the identity property, you cannot manually set the following fields:
• tlsSettings.sni
• tlsSettings.subjectAltNames
• tlsSettings.authenticationConfig

When defining a identity for a RegionBackendServices, the corresponding Workload Identity Pool must have a ca_pool configured in the same region.

The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.

optional string identity = 401109182;

Returns
Type	Description
boolean	Whether the identity field is set.

hasSni()

public abstract boolean hasSni()

Server Name Indication - see RFC3546 section 3.1. If set, the load balancer sends this string as the SNI hostname in the TLS connection to the backend, and requires that this string match a Subject Alternative Name (SAN) in the backend's server certificate. With a Regional Internet NEG backend, if the SNI is specified here, the load balancer uses it regardless of whether the Regional Internet NEG is specified with FQDN or IP address and port. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[].

optional string sni = 114030;

Returns
Type	Description
boolean	Whether the sni field is set.