Class AuthProvider.Builder (0.1.0)

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

Message describing AuthProvider object

Protobuf type google.cloud.agentidentity.v1.AuthProvider

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AuthProvider.Builder

Implements

AuthProviderOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllAllowedScopes(Iterable<String> values)

public AuthProvider.Builder addAllAllowedScopes(Iterable<String> values)

Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in blocked_scopes are disallowed even if they appear in allowed_scopes. The number of allowed scopes is limited to 200.

repeated string allowed_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<String> The allowedScopes to add.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

addAllBlockedScopes(Iterable<String> values)

public AuthProvider.Builder addAllBlockedScopes(Iterable<String> values)

Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in allowed_scopes. blocked_scopes takes precedence over allowed_scopes. The number of blocked scopes is limited to 200.

repeated string blocked_scopes = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<String> The blockedScopes to add.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

addAllWorkloadIds(Iterable<String> values)

public AuthProvider.Builder addAllWorkloadIds(Iterable<String> values)

Optional. Input only. Represents the workload identity in IAM principal:// format of the agent(s) that will use this AuthProvider. Example: principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}

repeated string workload_ids = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
values	Iterable<String> The workloadIds to add.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

addAllowedScopes(String value)

public AuthProvider.Builder addAllowedScopes(String value)

Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in blocked_scopes are disallowed even if they appear in allowed_scopes. The number of allowed scopes is limited to 200.

repeated string allowed_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The allowedScopes to add.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

addAllowedScopesBytes(ByteString value)

public AuthProvider.Builder addAllowedScopesBytes(ByteString value)

Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in blocked_scopes are disallowed even if they appear in allowed_scopes. The number of allowed scopes is limited to 200.

repeated string allowed_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes of the allowedScopes to add.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

addBlockedScopes(String value)

public AuthProvider.Builder addBlockedScopes(String value)

Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in allowed_scopes. blocked_scopes takes precedence over allowed_scopes. The number of blocked scopes is limited to 200.

repeated string blocked_scopes = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The blockedScopes to add.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

addBlockedScopesBytes(ByteString value)

public AuthProvider.Builder addBlockedScopesBytes(ByteString value)

Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in allowed_scopes. blocked_scopes takes precedence over allowed_scopes. The number of blocked scopes is limited to 200.

repeated string blocked_scopes = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes of the blockedScopes to add.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

addWorkloadIds(String value)

public AuthProvider.Builder addWorkloadIds(String value)

Optional. Input only. Represents the workload identity in IAM principal:// format of the agent(s) that will use this AuthProvider. Example: principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}

repeated string workload_ids = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
value	String The workloadIds to add.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

addWorkloadIdsBytes(ByteString value)

public AuthProvider.Builder addWorkloadIdsBytes(ByteString value)

Optional. Input only. Represents the workload identity in IAM principal:// format of the agent(s) that will use this AuthProvider. Example: principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}

repeated string workload_ids = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes of the workloadIds to add.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

build()

public AuthProvider build()

Returns
Type	Description
AuthProvider

buildPartial()

public AuthProvider buildPartial()

Returns
Type	Description
AuthProvider

clear()

public AuthProvider.Builder clear()

Returns
Type	Description
AuthProvider.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAllowedScopes()

public AuthProvider.Builder clearAllowedScopes()

Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in blocked_scopes are disallowed even if they appear in allowed_scopes. The number of allowed scopes is limited to 200.

repeated string allowed_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

clearAuthProviderTypeParams()

public AuthProvider.Builder clearAuthProviderTypeParams()

Required. AuthProvider type specific parameters.

.google.cloud.agentidentity.v1.AuthProvider.AuthProviderTypeParams auth_provider_type_params = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AuthProvider.Builder

clearBlockedScopes()

public AuthProvider.Builder clearBlockedScopes()

Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in allowed_scopes. blocked_scopes takes precedence over allowed_scopes. The number of blocked scopes is limited to 200.

repeated string blocked_scopes = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

clearCreateTime()

public AuthProvider.Builder clearCreateTime()

Output only. [Output only] Create time stamp

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

Returns
Type	Description
AuthProvider.Builder

clearDeleted()

public AuthProvider.Builder clearDeleted()

Output only. This is set to true if the auth_provider is deleted.

bool deleted = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

clearDescription()

public AuthProvider.Builder clearDescription()

Optional. Description of the resource. Must be less than 256 characters.

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

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

clearExpireTime()

public AuthProvider.Builder clearExpireTime()

Output only. The time when the auth_provider will expire.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
AuthProvider.Builder

clearLabels()

public AuthProvider.Builder clearLabels()

Returns
Type	Description
AuthProvider.Builder

clearName()

public AuthProvider.Builder clearName()

Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

clearState()

public AuthProvider.Builder clearState()

Output only. The state of the auth_provider.

.google.cloud.agentidentity.v1.AuthProvider.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

clearUpdateTime()

public AuthProvider.Builder clearUpdateTime()

Output only. [Output only] Update time stamp

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

Returns
Type	Description
AuthProvider.Builder

clearWorkloadIds()

public AuthProvider.Builder clearWorkloadIds()

Optional. Input only. Represents the workload identity in IAM principal:// format of the agent(s) that will use this AuthProvider. Example: principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}

repeated string workload_ids = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAllowedScopes(int index)

public String getAllowedScopes(int index)

Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in blocked_scopes are disallowed even if they appear in allowed_scopes. The number of allowed scopes is limited to 200.

repeated string allowed_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The allowedScopes at the given index.

getAllowedScopesBytes(int index)

public ByteString getAllowedScopesBytes(int index)

Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in blocked_scopes are disallowed even if they appear in allowed_scopes. The number of allowed scopes is limited to 200.

repeated string allowed_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the allowedScopes at the given index.

getAllowedScopesCount()

public int getAllowedScopesCount()

Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in blocked_scopes are disallowed even if they appear in allowed_scopes. The number of allowed scopes is limited to 200.

repeated string allowed_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of allowedScopes.

getAllowedScopesList()

public ProtocolStringList getAllowedScopesList()

Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in blocked_scopes are disallowed even if they appear in allowed_scopes. The number of allowed scopes is limited to 200.

repeated string allowed_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the allowedScopes.

getAuthProviderTypeParams()

public AuthProvider.AuthProviderTypeParams getAuthProviderTypeParams()

Required. AuthProvider type specific parameters.

.google.cloud.agentidentity.v1.AuthProvider.AuthProviderTypeParams auth_provider_type_params = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AuthProvider.AuthProviderTypeParams	The authProviderTypeParams.

getAuthProviderTypeParamsBuilder()

public AuthProvider.AuthProviderTypeParams.Builder getAuthProviderTypeParamsBuilder()

Required. AuthProvider type specific parameters.

.google.cloud.agentidentity.v1.AuthProvider.AuthProviderTypeParams auth_provider_type_params = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AuthProvider.AuthProviderTypeParams.Builder

getAuthProviderTypeParamsOrBuilder()

public AuthProvider.AuthProviderTypeParamsOrBuilder getAuthProviderTypeParamsOrBuilder()

Required. AuthProvider type specific parameters.

.google.cloud.agentidentity.v1.AuthProvider.AuthProviderTypeParams auth_provider_type_params = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AuthProvider.AuthProviderTypeParamsOrBuilder

getBlockedScopes(int index)

public String getBlockedScopes(int index)

Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in allowed_scopes. blocked_scopes takes precedence over allowed_scopes. The number of blocked scopes is limited to 200.

repeated string blocked_scopes = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The blockedScopes at the given index.

getBlockedScopesBytes(int index)

public ByteString getBlockedScopesBytes(int index)

Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in allowed_scopes. blocked_scopes takes precedence over allowed_scopes. The number of blocked scopes is limited to 200.

repeated string blocked_scopes = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the blockedScopes at the given index.

getBlockedScopesCount()

public int getBlockedScopesCount()

Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in allowed_scopes. blocked_scopes takes precedence over allowed_scopes. The number of blocked scopes is limited to 200.

repeated string blocked_scopes = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of blockedScopes.

getBlockedScopesList()

public ProtocolStringList getBlockedScopesList()

Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in allowed_scopes. blocked_scopes takes precedence over allowed_scopes. The number of blocked scopes is limited to 200.

repeated string blocked_scopes = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the blockedScopes.

getCreateTime()

public Timestamp getCreateTime()

Output only. [Output only] Create time stamp

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. [Output only] Create time stamp

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

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. [Output only] Create time stamp

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

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public AuthProvider getDefaultInstanceForType()

Returns
Type	Description
AuthProvider

getDeleted()

public boolean getDeleted()

Output only. This is set to true if the auth_provider is deleted.

bool deleted = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The deleted.

getDescription()

public String getDescription()

Optional. Description of the resource. Must be less than 256 characters.

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

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the resource. Must be less than 256 characters.

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

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getExpireTime()

public Timestamp getExpireTime()

Output only. The time when the auth_provider will expire.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The expireTime.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

Output only. The time when the auth_provider will expire.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Builder

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

Output only. The time when the auth_provider will expire.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

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()

Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getState()

public AuthProvider.State getState()

Output only. The state of the auth_provider.

.google.cloud.agentidentity.v1.AuthProvider.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
AuthProvider.State	The state.

getStateValue()

public int getStateValue()

Output only. The state of the auth_provider.

.google.cloud.agentidentity.v1.AuthProvider.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. [Output only] Update time stamp

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

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. [Output only] Update time stamp

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

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. [Output only] Update time stamp

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

Returns
Type	Description
TimestampOrBuilder

getWorkloadIds(int index)

public String getWorkloadIds(int index)

Optional. Input only. Represents the workload identity in IAM principal:// format of the agent(s) that will use this AuthProvider. Example: principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}

repeated string workload_ids = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The workloadIds at the given index.

getWorkloadIdsBytes(int index)

public ByteString getWorkloadIdsBytes(int index)

Optional. Input only. Represents the workload identity in IAM principal:// format of the agent(s) that will use this AuthProvider. Example: principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}

repeated string workload_ids = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the workloadIds at the given index.

getWorkloadIdsCount()

public int getWorkloadIdsCount()

Optional. Input only. Represents the workload identity in IAM principal:// format of the agent(s) that will use this AuthProvider. Example: principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}

repeated string workload_ids = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
int	The count of workloadIds.

getWorkloadIdsList()

public ProtocolStringList getWorkloadIdsList()

Optional. Input only. Represents the workload identity in IAM principal:// format of the agent(s) that will use this AuthProvider. Example: principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}

repeated string workload_ids = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
ProtocolStringList	A list containing the workloadIds.

hasAuthProviderTypeParams()

public boolean hasAuthProviderTypeParams()

Required. AuthProvider type specific parameters.

.google.cloud.agentidentity.v1.AuthProvider.AuthProviderTypeParams auth_provider_type_params = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the authProviderTypeParams field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. [Output only] Create time stamp

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

Returns
Type	Description
boolean	Whether the createTime field is set.

hasExpireTime()

public boolean hasExpireTime()

Output only. The time when the auth_provider will expire.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the expireTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.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

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

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

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeAuthProviderTypeParams(AuthProvider.AuthProviderTypeParams value)

public AuthProvider.Builder mergeAuthProviderTypeParams(AuthProvider.AuthProviderTypeParams value)

Required. AuthProvider type specific parameters.

.google.cloud.agentidentity.v1.AuthProvider.AuthProviderTypeParams auth_provider_type_params = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	AuthProvider.AuthProviderTypeParams

Returns
Type	Description
AuthProvider.Builder

mergeCreateTime(Timestamp value)

public AuthProvider.Builder mergeCreateTime(Timestamp value)

Output only. [Output only] Create time stamp

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
AuthProvider.Builder

mergeExpireTime(Timestamp value)

public AuthProvider.Builder mergeExpireTime(Timestamp value)

Output only. The time when the auth_provider will expire.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
AuthProvider.Builder

mergeFrom(AuthProvider other)

public AuthProvider.Builder mergeFrom(AuthProvider other)

Parameter
Name	Description
other	AuthProvider

Returns
Type	Description
AuthProvider.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AuthProvider.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuthProvider.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public AuthProvider.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
AuthProvider.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUpdateTime(Timestamp value)

public AuthProvider.Builder mergeUpdateTime(Timestamp value)

Output only. [Output only] Update time stamp

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
AuthProvider.Builder

putAllLabels(Map<String,String> values)

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

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
AuthProvider.Builder

putLabels(String key, String value)

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

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
AuthProvider.Builder

removeLabels(String key)

public AuthProvider.Builder removeLabels(String key)

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
AuthProvider.Builder

setAllowedScopes(int index, String value)

public AuthProvider.Builder setAllowedScopes(int index, String value)

Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in blocked_scopes are disallowed even if they appear in allowed_scopes. The number of allowed scopes is limited to 200.

repeated string allowed_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int The index to set the value at.
value	String The allowedScopes to set.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

setAuthProviderTypeParams(AuthProvider.AuthProviderTypeParams value)

public AuthProvider.Builder setAuthProviderTypeParams(AuthProvider.AuthProviderTypeParams value)

Required. AuthProvider type specific parameters.

.google.cloud.agentidentity.v1.AuthProvider.AuthProviderTypeParams auth_provider_type_params = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	AuthProvider.AuthProviderTypeParams

Returns
Type	Description
AuthProvider.Builder

setAuthProviderTypeParams(AuthProvider.AuthProviderTypeParams.Builder builderForValue)

public AuthProvider.Builder setAuthProviderTypeParams(AuthProvider.AuthProviderTypeParams.Builder builderForValue)

Required. AuthProvider type specific parameters.

.google.cloud.agentidentity.v1.AuthProvider.AuthProviderTypeParams auth_provider_type_params = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	AuthProvider.AuthProviderTypeParams.Builder

Returns
Type	Description
AuthProvider.Builder

setBlockedScopes(int index, String value)

public AuthProvider.Builder setBlockedScopes(int index, String value)

Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in allowed_scopes. blocked_scopes takes precedence over allowed_scopes. The number of blocked scopes is limited to 200.

repeated string blocked_scopes = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int The index to set the value at.
value	String The blockedScopes to set.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

setCreateTime(Timestamp value)

public AuthProvider.Builder setCreateTime(Timestamp value)

Output only. [Output only] Create time stamp

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
AuthProvider.Builder

setCreateTime(Timestamp.Builder builderForValue)

public AuthProvider.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. [Output only] Create time stamp

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
AuthProvider.Builder

setDeleted(boolean value)

public AuthProvider.Builder setDeleted(boolean value)

Output only. This is set to true if the auth_provider is deleted.

bool deleted = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	boolean The deleted to set.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

setDescription(String value)

public AuthProvider.Builder setDescription(String value)

Optional. Description of the resource. Must be less than 256 characters.

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

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public AuthProvider.Builder setDescriptionBytes(ByteString value)

Optional. Description of the resource. Must be less than 256 characters.

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

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

setExpireTime(Timestamp value)

public AuthProvider.Builder setExpireTime(Timestamp value)

Output only. The time when the auth_provider will expire.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
AuthProvider.Builder

setExpireTime(Timestamp.Builder builderForValue)

public AuthProvider.Builder setExpireTime(Timestamp.Builder builderForValue)

Output only. The time when the auth_provider will expire.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
AuthProvider.Builder

setName(String value)

public AuthProvider.Builder setName(String value)

Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

setNameBytes(ByteString value)

public AuthProvider.Builder setNameBytes(ByteString value)

Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

setState(AuthProvider.State value)

public AuthProvider.Builder setState(AuthProvider.State value)

Output only. The state of the auth_provider.

.google.cloud.agentidentity.v1.AuthProvider.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	AuthProvider.State The state to set.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

setStateValue(int value)

public AuthProvider.Builder setStateValue(int value)

Output only. The state of the auth_provider.

.google.cloud.agentidentity.v1.AuthProvider.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	int The enum numeric value on the wire for state to set.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.

setUpdateTime(Timestamp value)

public AuthProvider.Builder setUpdateTime(Timestamp value)

Output only. [Output only] Update time stamp

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
AuthProvider.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public AuthProvider.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. [Output only] Update time stamp

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
AuthProvider.Builder

setWorkloadIds(int index, String value)

public AuthProvider.Builder setWorkloadIds(int index, String value)

Optional. Input only. Represents the workload identity in IAM principal:// format of the agent(s) that will use this AuthProvider. Example: principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}

repeated string workload_ids = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameters
Name	Description
index	int The index to set the value at.
value	String The workloadIds to set.

Returns
Type	Description
AuthProvider.Builder	This builder for chaining.