Interface AuthProviderOrBuilder (0.1.0)

public interface AuthProviderOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the allowedScopes.

getAuthProviderTypeParams()

public abstract AuthProvider.AuthProviderTypeParams getAuthProviderTypeParams()

Required. AuthProvider type specific parameters.

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

Returns
Type	Description
AuthProvider.AuthProviderTypeParams	The authProviderTypeParams.

getAuthProviderTypeParamsOrBuilder()

public abstract AuthProvider.AuthProviderTypeParamsOrBuilder getAuthProviderTypeParamsOrBuilder()

Required. AuthProvider type specific parameters.

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

Returns
Type	Description
AuthProvider.AuthProviderTypeParamsOrBuilder

getBlockedScopes(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the blockedScopes.

getCreateTime()

public abstract 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.

getCreateTimeOrBuilder()

public abstract 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

getDeleted()

public abstract 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 abstract 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 abstract 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.

getExpireTime()

public abstract 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.

getExpireTimeOrBuilder()

public abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Labels as key value pairs

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

Returns
Type	Description
int

getLabelsMap()

public abstract 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 abstract 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 abstract 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

getName()

public abstract 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 abstract 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 abstract AuthProvider.State getState()

Output only. The state of the auth_provider.

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

Returns
Type	Description
AuthProvider.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The state of the auth_provider.

.google.cloud.agentidentity.v1beta.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 abstract 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.

getUpdateTimeOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the workloadIds.

hasAuthProviderTypeParams()

public abstract boolean hasAuthProviderTypeParams()

Required. AuthProvider type specific parameters.

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

Returns
Type	Description
boolean	Whether the authProviderTypeParams field is set.

hasCreateTime()

public abstract 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 abstract 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 abstract 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.