Class DeployedIndexAuthConfig.AuthProvider.Builder (3.43.0)

public static final class DeployedIndexAuthConfig.AuthProvider.Builder extends GeneratedMessageV3.Builder<DeployedIndexAuthConfig.AuthProvider.Builder> implements DeployedIndexAuthConfig.AuthProviderOrBuilder

Configuration for an authentication provider, including support for JSON Web Token (JWT).

Protobuf type google.cloud.aiplatform.v1.DeployedIndexAuthConfig.AuthProvider

Static Methods

getDescriptor()

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

Methods

addAllAllowedIssuers(Iterable<String> values)

public DeployedIndexAuthConfig.AuthProvider.Builder addAllAllowedIssuers(Iterable<String> values)

A list of allowed JWT issuers. Each entry must be a valid Google service account, in the following format:

service-account-name@project-id.iam.gserviceaccount.com

repeated string allowed_issuers = 2;

Parameter
Name Description
values Iterable<String>

The allowedIssuers to add.

Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder

This builder for chaining.

addAllAudiences(Iterable<String> values)

public DeployedIndexAuthConfig.AuthProvider.Builder addAllAudiences(Iterable<String> values)

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted.

repeated string audiences = 1;

Parameter
Name Description
values Iterable<String>

The audiences to add.

Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder

This builder for chaining.

addAllowedIssuers(String value)

public DeployedIndexAuthConfig.AuthProvider.Builder addAllowedIssuers(String value)

A list of allowed JWT issuers. Each entry must be a valid Google service account, in the following format:

service-account-name@project-id.iam.gserviceaccount.com

repeated string allowed_issuers = 2;

Parameter
Name Description
value String

The allowedIssuers to add.

Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder

This builder for chaining.

addAllowedIssuersBytes(ByteString value)

public DeployedIndexAuthConfig.AuthProvider.Builder addAllowedIssuersBytes(ByteString value)

A list of allowed JWT issuers. Each entry must be a valid Google service account, in the following format:

service-account-name@project-id.iam.gserviceaccount.com

repeated string allowed_issuers = 2;

Parameter
Name Description
value ByteString

The bytes of the allowedIssuers to add.

Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder

This builder for chaining.

addAudiences(String value)

public DeployedIndexAuthConfig.AuthProvider.Builder addAudiences(String value)

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted.

repeated string audiences = 1;

Parameter
Name Description
value String

The audiences to add.

Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder

This builder for chaining.

addAudiencesBytes(ByteString value)

public DeployedIndexAuthConfig.AuthProvider.Builder addAudiencesBytes(ByteString value)

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted.

repeated string audiences = 1;

Parameter
Name Description
value ByteString

The bytes of the audiences to add.

Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeployedIndexAuthConfig.AuthProvider.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder
Overrides

build()

public DeployedIndexAuthConfig.AuthProvider build()
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider

buildPartial()

public DeployedIndexAuthConfig.AuthProvider buildPartial()
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider

clear()

public DeployedIndexAuthConfig.AuthProvider.Builder clear()
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder
Overrides

clearAllowedIssuers()

public DeployedIndexAuthConfig.AuthProvider.Builder clearAllowedIssuers()

A list of allowed JWT issuers. Each entry must be a valid Google service account, in the following format:

service-account-name@project-id.iam.gserviceaccount.com

repeated string allowed_issuers = 2;

Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder

This builder for chaining.

clearAudiences()

public DeployedIndexAuthConfig.AuthProvider.Builder clearAudiences()

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted.

repeated string audiences = 1;

Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DeployedIndexAuthConfig.AuthProvider.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public DeployedIndexAuthConfig.AuthProvider.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder
Overrides

clone()

public DeployedIndexAuthConfig.AuthProvider.Builder clone()
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder
Overrides

getAllowedIssuers(int index)

public String getAllowedIssuers(int index)

A list of allowed JWT issuers. Each entry must be a valid Google service account, in the following format:

service-account-name@project-id.iam.gserviceaccount.com

repeated string allowed_issuers = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The allowedIssuers at the given index.

getAllowedIssuersBytes(int index)

public ByteString getAllowedIssuersBytes(int index)

A list of allowed JWT issuers. Each entry must be a valid Google service account, in the following format:

service-account-name@project-id.iam.gserviceaccount.com

repeated string allowed_issuers = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the allowedIssuers at the given index.

getAllowedIssuersCount()

public int getAllowedIssuersCount()

A list of allowed JWT issuers. Each entry must be a valid Google service account, in the following format:

service-account-name@project-id.iam.gserviceaccount.com

repeated string allowed_issuers = 2;

Returns
Type Description
int

The count of allowedIssuers.

getAllowedIssuersList()

public ProtocolStringList getAllowedIssuersList()

A list of allowed JWT issuers. Each entry must be a valid Google service account, in the following format:

service-account-name@project-id.iam.gserviceaccount.com

repeated string allowed_issuers = 2;

Returns
Type Description
ProtocolStringList

A list containing the allowedIssuers.

getAudiences(int index)

public String getAudiences(int index)

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted.

repeated string audiences = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The audiences at the given index.

getAudiencesBytes(int index)

public ByteString getAudiencesBytes(int index)

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted.

repeated string audiences = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the audiences at the given index.

getAudiencesCount()

public int getAudiencesCount()

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted.

repeated string audiences = 1;

Returns
Type Description
int

The count of audiences.

getAudiencesList()

public ProtocolStringList getAudiencesList()

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted.

repeated string audiences = 1;

Returns
Type Description
ProtocolStringList

A list containing the audiences.

getDefaultInstanceForType()

public DeployedIndexAuthConfig.AuthProvider getDefaultInstanceForType()
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider

getDescriptorForType()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DeployedIndexAuthConfig.AuthProvider other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeployedIndexAuthConfig.AuthProvider.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder
Overrides

setAllowedIssuers(int index, String value)

public DeployedIndexAuthConfig.AuthProvider.Builder setAllowedIssuers(int index, String value)

A list of allowed JWT issuers. Each entry must be a valid Google service account, in the following format:

service-account-name@project-id.iam.gserviceaccount.com

repeated string allowed_issuers = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The allowedIssuers to set.

Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder

This builder for chaining.

setAudiences(int index, String value)

public DeployedIndexAuthConfig.AuthProvider.Builder setAudiences(int index, String value)

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted.

repeated string audiences = 1;

Parameters
Name Description
index int

The index to set the value at.

value String

The audiences to set.

Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DeployedIndexAuthConfig.AuthProvider.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DeployedIndexAuthConfig.AuthProvider.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DeployedIndexAuthConfig.AuthProvider.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DeployedIndexAuthConfig.AuthProvider.Builder
Overrides