com.google.cloud.iam.credentials.v1

Interface GenerateAccessTokenRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GenerateAccessTokenRequest, GenerateAccessTokenRequest.Builder

public interface GenerateAccessTokenRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDelegates(int index) The sequence of service accounts in a delegation chain.
com.google.protobuf.ByteString	getDelegatesBytes(int index) The sequence of service accounts in a delegation chain.
int	getDelegatesCount() The sequence of service accounts in a delegation chain.
List<String>	getDelegatesList() The sequence of service accounts in a delegation chain.
com.google.protobuf.Duration	getLifetime() The desired lifetime duration of the access token in seconds.
com.google.protobuf.DurationOrBuilder	getLifetimeOrBuilder() The desired lifetime duration of the access token in seconds.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getScope(int index) Required.
com.google.protobuf.ByteString	getScopeBytes(int index) Required.
int	getScopeCount() Required.
List<String>	getScopeList() Required.
boolean	hasLifetime() The desired lifetime duration of the access token in seconds.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getDelegatesList

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:

A list containing the delegates.

getDelegatesCount

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:

The count of delegates.

getDelegates

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;

Parameters:

index - The index of the element to return.

Returns:

The delegates at the given index.

getDelegatesBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the delegates at the given index.

getScopeList

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:

A list containing the scope.

getScopeCount

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:

The count of scope.

getScope

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];

Parameters:

index - The index of the element to return.

Returns:

The scope at the given index.

getScopeBytes

com.google.protobuf.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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the scope at the given index.

hasLifetime

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:

Whether the lifetime field is set.

getLifetime

com.google.protobuf.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:

The lifetime.

getLifetimeOrBuilder

com.google.protobuf.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;