- 1.63.0 (latest)
- 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 static final class SecuritySettings.Builder extends GeneratedMessageV3.Builder<SecuritySettings.Builder> implements SecuritySettingsOrBuilderThe authentication and authorization settings for a BackendService.
Protobuf type google.cloud.compute.v1.SecuritySettings
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SecuritySettings.BuilderImplements
SecuritySettingsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllSubjectAltNames(Iterable<String> values)
public SecuritySettings.Builder addAllSubjectAltNames(Iterable<String> values)Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
repeated string subject_alt_names = 330029535;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The subjectAltNames to add. |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SecuritySettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
addSubjectAltNames(String value)
public SecuritySettings.Builder addSubjectAltNames(String value)Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
repeated string subject_alt_names = 330029535;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe subjectAltNames to add. |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
This builder for chaining. |
addSubjectAltNamesBytes(ByteString value)
public SecuritySettings.Builder addSubjectAltNamesBytes(ByteString value)Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
repeated string subject_alt_names = 330029535;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the subjectAltNames to add. |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
This builder for chaining. |
build()
public SecuritySettings build()| Returns | |
|---|---|
| Type | Description |
SecuritySettings |
|
buildPartial()
public SecuritySettings buildPartial()| Returns | |
|---|---|
| Type | Description |
SecuritySettings |
|
clear()
public SecuritySettings.Builder clear()| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
clearAwsV4Authentication()
public SecuritySettings.Builder clearAwsV4Authentication()The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
clearClientTlsPolicy()
public SecuritySettings.Builder clearClientTlsPolicy()Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
optional string client_tls_policy = 462325226;
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SecuritySettings.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public SecuritySettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
clearSubjectAltNames()
public SecuritySettings.Builder clearSubjectAltNames()Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
repeated string subject_alt_names = 330029535;
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
This builder for chaining. |
clone()
public SecuritySettings.Builder clone()| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
getAwsV4Authentication()
public AWSV4Signature getAwsV4Authentication()The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;
| Returns | |
|---|---|
| Type | Description |
AWSV4Signature |
The awsV4Authentication. |
getAwsV4AuthenticationBuilder()
public AWSV4Signature.Builder getAwsV4AuthenticationBuilder()The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;
| Returns | |
|---|---|
| Type | Description |
AWSV4Signature.Builder |
|
getAwsV4AuthenticationOrBuilder()
public AWSV4SignatureOrBuilder getAwsV4AuthenticationOrBuilder()The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;
| Returns | |
|---|---|
| Type | Description |
AWSV4SignatureOrBuilder |
|
getClientTlsPolicy()
public String getClientTlsPolicy()Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
optional string client_tls_policy = 462325226;
| Returns | |
|---|---|
| Type | Description |
String |
The clientTlsPolicy. |
getClientTlsPolicyBytes()
public ByteString getClientTlsPolicyBytes()Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
optional string client_tls_policy = 462325226;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for clientTlsPolicy. |
getDefaultInstanceForType()
public SecuritySettings getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SecuritySettings |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getSubjectAltNames(int index)
public String getSubjectAltNames(int index)Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
repeated string subject_alt_names = 330029535;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The subjectAltNames at the given index. |
getSubjectAltNamesBytes(int index)
public ByteString getSubjectAltNamesBytes(int index)Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
repeated string subject_alt_names = 330029535;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the subjectAltNames at the given index. |
getSubjectAltNamesCount()
public int getSubjectAltNamesCount()Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
repeated string subject_alt_names = 330029535;
| Returns | |
|---|---|
| Type | Description |
int |
The count of subjectAltNames. |
getSubjectAltNamesList()
public ProtocolStringList getSubjectAltNamesList()Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
repeated string subject_alt_names = 330029535;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the subjectAltNames. |
hasAwsV4Authentication()
public boolean hasAwsV4Authentication()The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the awsV4Authentication field is set. |
hasClientTlsPolicy()
public boolean hasClientTlsPolicy()Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
optional string client_tls_policy = 462325226;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the clientTlsPolicy field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAwsV4Authentication(AWSV4Signature value)
public SecuritySettings.Builder mergeAwsV4Authentication(AWSV4Signature value)The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;
| Parameter | |
|---|---|
| Name | Description |
value |
AWSV4Signature |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
mergeFrom(SecuritySettings other)
public SecuritySettings.Builder mergeFrom(SecuritySettings other)| Parameter | |
|---|---|
| Name | Description |
other |
SecuritySettings |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SecuritySettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SecuritySettings.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SecuritySettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
setAwsV4Authentication(AWSV4Signature value)
public SecuritySettings.Builder setAwsV4Authentication(AWSV4Signature value)The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;
| Parameter | |
|---|---|
| Name | Description |
value |
AWSV4Signature |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
setAwsV4Authentication(AWSV4Signature.Builder builderForValue)
public SecuritySettings.Builder setAwsV4Authentication(AWSV4Signature.Builder builderForValue)The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AWSV4Signature.Builder |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
setClientTlsPolicy(String value)
public SecuritySettings.Builder setClientTlsPolicy(String value)Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
optional string client_tls_policy = 462325226;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe clientTlsPolicy to set. |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
This builder for chaining. |
setClientTlsPolicyBytes(ByteString value)
public SecuritySettings.Builder setClientTlsPolicyBytes(ByteString value)Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
optional string client_tls_policy = 462325226;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for clientTlsPolicy to set. |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SecuritySettings.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SecuritySettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|
setSubjectAltNames(int index, String value)
public SecuritySettings.Builder setSubjectAltNames(int index, String value)Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
repeated string subject_alt_names = 330029535;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe subjectAltNames to set. |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SecuritySettings.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SecuritySettings.Builder |
|