Interface GenerateAccessTokenRequestOrBuilder (2.45.0)

public interface GenerateAccessTokenRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDelegates(int index)

public abstract String getDelegates(int index)

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

repeated string delegates = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The delegates at the given index.

getDelegatesBytes(int index)

public abstract ByteString getDelegatesBytes(int index)

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

repeated string delegates = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the delegates at the given index.

getDelegatesCount()

public abstract int getDelegatesCount()

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

repeated string delegates = 2;

Returns
Type Description
int

The count of delegates.

getDelegatesList()

public abstract List<String> getDelegatesList()

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

repeated string delegates = 2;

Returns
Type Description
List<String>

A list containing the delegates.

getLifetime()

public abstract Duration getLifetime()

The desired lifetime duration of the access token in seconds. Must be set to a value less than or equal to 3600 (1 hour). If a value is not specified, the token's lifetime will be set to a default value of one hour.

.google.protobuf.Duration lifetime = 7;

Returns
Type Description
Duration

The lifetime.

getLifetimeOrBuilder()

public abstract DurationOrBuilder getLifetimeOrBuilder()

The desired lifetime duration of the access token in seconds. Must be set to a value less than or equal to 3600 (1 hour). If a value is not specified, the token's lifetime will be set to a default value of one hour.

.google.protobuf.Duration lifetime = 7;

Returns
Type Description
DurationOrBuilder

getName()

public abstract String getName()

Required. The resource name of the service account for which the credentials are requested, in the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The resource name of the service account for which the credentials are requested, in the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getScope(int index)

public abstract String getScope(int index)

Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The scope at the given index.

getScopeBytes(int index)

public abstract ByteString getScopeBytes(int index)

Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the scope at the given index.

getScopeCount()

public abstract int getScopeCount()

Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of scope.

getScopeList()

public abstract List<String> getScopeList()

Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<String>

A list containing the scope.

hasLifetime()

public abstract boolean hasLifetime()

The desired lifetime duration of the access token in seconds. Must be set to a value less than or equal to 3600 (1 hour). If a value is not specified, the token's lifetime will be set to a default value of one hour.

.google.protobuf.Duration lifetime = 7;

Returns
Type Description
boolean

Whether the lifetime field is set.