Package com.google.cloud.iam.credentials.v1

Interface GenerateIdTokenRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateIdTokenRequest, GenerateIdTokenRequest.Builder
@Generated public interface GenerateIdTokenRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAudience()
    Required.
    com.google.protobuf.ByteString
    getAudienceBytes()
    Required.
    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.
    boolean
    getIncludeEmail()
    Include the service account email in the token.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

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

    • getAudience

      String getAudience()
       Required. The audience for the token, such as the API or account that this token
 grants access to.
      string audience = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The audience.

    • getAudienceBytes

      com.google.protobuf.ByteString getAudienceBytes()
       Required. The audience for the token, such as the API or account that this token
 grants access to.
      string audience = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for audience.

    • getIncludeEmail

      boolean getIncludeEmail()
       Include the service account email in the token. If set to `true`, the
 token will contain `email` and `email_verified` claims.
      bool include_email = 4;
      Returns:
      The includeEmail.