Class AuthProvider (0.1.0)

public final class AuthProvider extends GeneratedMessage implements AuthProviderOrBuilder

Message describing AuthProvider object

Protobuf type google.cloud.agentidentity.v1beta.AuthProvider

Static Fields

ALLOWED_SCOPES_FIELD_NUMBER

public static final int ALLOWED_SCOPES_FIELD_NUMBER
Field Value
Type Description
int

AUTH_PROVIDER_TYPE_PARAMS_FIELD_NUMBER

public static final int AUTH_PROVIDER_TYPE_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

BLOCKED_SCOPES_FIELD_NUMBER

public static final int BLOCKED_SCOPES_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DELETED_FIELD_NUMBER

public static final int DELETED_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WORKLOAD_IDS_FIELD_NUMBER

public static final int WORKLOAD_IDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AuthProvider getDefaultInstance()
Returns
Type Description
AuthProvider

getDescriptor()

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

newBuilder()

public static AuthProvider.Builder newBuilder()
Returns
Type Description
AuthProvider.Builder

newBuilder(AuthProvider prototype)

public static AuthProvider.Builder newBuilder(AuthProvider prototype)
Parameter
Name Description
prototype AuthProvider
Returns
Type Description
AuthProvider.Builder

parseDelimitedFrom(InputStream input)

public static AuthProvider parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AuthProvider
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthProvider parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthProvider
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AuthProvider parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AuthProvider
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AuthProvider parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthProvider
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AuthProvider parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AuthProvider
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AuthProvider parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthProvider
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AuthProvider parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AuthProvider
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthProvider parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthProvider
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AuthProvider parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AuthProvider
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthProvider parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthProvider
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AuthProvider parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AuthProvider
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AuthProvider parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthProvider
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AuthProvider> parser()
Returns
Type Description
Parser<AuthProvider>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.v1beta.AuthProvider.AuthProviderTypeParams auth_provider_type_params = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AuthProvider.AuthProviderTypeParams

The authProviderTypeParams.

getAuthProviderTypeParamsOrBuilder()

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

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.

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.

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

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.

getParserForType()

public Parser<AuthProvider> getParserForType()
Returns
Type Description
Parser<AuthProvider>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AuthProvider.Builder newBuilderForType()
Returns
Type Description
AuthProvider.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AuthProvider.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AuthProvider.Builder
Overrides

toBuilder()

public AuthProvider.Builder toBuilder()
Returns
Type Description
AuthProvider.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException