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

Class GenerateAccessTokenRequest

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public 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) = { ... }
        Specified by:
        getName in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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) = { ... }
        Specified by:
        getNameBytes in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        The bytes for name.

      • getDelegatesList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getDelegatesList in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        A list containing the delegates.

      • getDelegatesCount

        public 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;
        Specified by:
        getDelegatesCount in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        The count of delegates.

      • getDelegates

        public 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;
        Specified by:
        getDelegates in interface GenerateAccessTokenRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The delegates at the given index.

      • getDelegatesBytes

        public 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;
        Specified by:
        getDelegatesBytes in interface GenerateAccessTokenRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the delegates at the given index.

      • getScopeList

        public com.google.protobuf.ProtocolStringList 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];
        Specified by:
        getScopeList in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        A list containing the scope.

      • getScopeCount

        public 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];
        Specified by:
        getScopeCount in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        The count of scope.

      • getScope

        public 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];
        Specified by:
        getScope in interface GenerateAccessTokenRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The scope at the given index.

      • getScopeBytes

        public 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];
        Specified by:
        getScopeBytes in interface GenerateAccessTokenRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the scope at the given index.

      • hasLifetime

        public 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;
        Specified by:
        hasLifetime in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        Whether the lifetime field is set.

      • getLifetime

        public 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;
        Specified by:
        getLifetime in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        The lifetime.

      • getLifetimeOrBuilder

        public 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;
        Specified by:
        getLifetimeOrBuilder in interface GenerateAccessTokenRequestOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static GenerateAccessTokenRequest parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GenerateAccessTokenRequest parseFrom​(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GenerateAccessTokenRequest parseFrom​(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GenerateAccessTokenRequest parseFrom​(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GenerateAccessTokenRequest parseFrom​(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GenerateAccessTokenRequest parseFrom​(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public GenerateAccessTokenRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public GenerateAccessTokenRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected GenerateAccessTokenRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<GenerateAccessTokenRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public GenerateAccessTokenRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder