GenerateIdentityBindingAccessTokenRequest (proto-google-cloud-iamcredentials-v1 0.4.0-alpha API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.iam.credentials.v1.GenerateIdentityBindingAccessTokenRequest

All Implemented Interfaces:

GenerateIdentityBindingAccessTokenRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class GenerateIdentityBindingAccessTokenRequest
extends com.google.protobuf.GeneratedMessageV3
implements GenerateIdentityBindingAccessTokenRequestOrBuilder
```
Protobuf type google.iam.credentials.v1.GenerateIdentityBindingAccessTokenRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GenerateIdentityBindingAccessTokenRequest.Builder` Protobuf type `google.iam.credentials.v1.GenerateIdentityBindingAccessTokenRequest`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields
Modifier and Type Field and Description

static int JWT_FIELD_NUMBER

static int NAME_FIELD_NUMBER

static int SCOPE_FIELD_NUMBER
- Fields inherited from class com.google.protobuf.GeneratedMessageV3
  alwaysUseFieldBuilders, unknownFields
- Fields inherited from class com.google.protobuf.AbstractMessage
  memoizedSize
- Fields inherited from class com.google.protobuf.AbstractMessageLite
  memoizedHashCode

Fields
Modifier and Type	Field and Description
`static int`	`JWT_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`SCOPE_FIELD_NUMBER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static GenerateIdentityBindingAccessTokenRequest`	`getDefaultInstance()`
`GenerateIdentityBindingAccessTokenRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getJwt()` Required.
`com.google.protobuf.ByteString`	`getJwtBytes()` Required.
`String`	`getName()` The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`.
`com.google.protobuf.ByteString`	`getNameBytes()` The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`.
`com.google.protobuf.Parser<GenerateIdentityBindingAccessTokenRequest>`	`getParserForType()`
`String`	`getScope(int index)` Code to identify the scopes to be included in the OAuth 2.0 access token.
`com.google.protobuf.ByteString`	`getScopeBytes(int index)` Code to identify the scopes to be included in the OAuth 2.0 access token.
`int`	`getScopeCount()` Code to identify the scopes to be included in the OAuth 2.0 access token.
`com.google.protobuf.ProtocolStringList`	`getScopeList()` Code to identify the scopes to be included in the OAuth 2.0 access token.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static GenerateIdentityBindingAccessTokenRequest.Builder`	`newBuilder()`
`static GenerateIdentityBindingAccessTokenRequest.Builder`	`newBuilder(GenerateIdentityBindingAccessTokenRequest prototype)`
`GenerateIdentityBindingAccessTokenRequest.Builder`	`newBuilderForType()`
`protected GenerateIdentityBindingAccessTokenRequest.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseDelimitedFrom(InputStream input)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseFrom(byte[] data)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseFrom(ByteBuffer data)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseFrom(com.google.protobuf.ByteString data)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseFrom(InputStream input)`
`static GenerateIdentityBindingAccessTokenRequest`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<GenerateIdentityBindingAccessTokenRequest>`	`parser()`
`GenerateIdentityBindingAccessTokenRequest.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SCOPE_FIELD_NUMBER
```
public static final int SCOPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- JWT_FIELD_NUMBER
```
public static final int JWT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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()

 The resource name of the service account for which the credentials
 are requested, in the following format:
 `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`.

string name = 1;

Specified by:: getName in interface GenerateIdentityBindingAccessTokenRequestOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The resource name of the service account for which the credentials
 are requested, in the following format:
 `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`.

string name = 1;

Specified by:: getNameBytes in interface GenerateIdentityBindingAccessTokenRequestOrBuilder

getScopeList

public com.google.protobuf.ProtocolStringList getScopeList()

 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 = 2;

Specified by:: getScopeList in interface GenerateIdentityBindingAccessTokenRequestOrBuilder

getScopeCount

public int getScopeCount()

 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 = 2;

Specified by:: getScopeCount in interface GenerateIdentityBindingAccessTokenRequestOrBuilder

getScope

public String getScope(int index)

 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 = 2;

Specified by:: getScope in interface GenerateIdentityBindingAccessTokenRequestOrBuilder

getScopeBytes

public com.google.protobuf.ByteString getScopeBytes(int index)

 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 = 2;

Specified by:: getScopeBytes in interface GenerateIdentityBindingAccessTokenRequestOrBuilder

getJwt

public String getJwt()

 Required. Input token.
 Must be in JWT format according to
 RFC7523 (https://tools.ietf.org/html/rfc7523)
 and must have 'kid' field in the header.
 Supported signing algorithms: RS256 (RS512, ES256, ES512 coming soon).
 Mandatory payload fields (along the lines of RFC 7523, section 3):
 - iss: issuer of the token. Must provide a discovery document at
        $iss/.well-known/openid-configuration . The document needs to be
        formatted according to section 4.2 of the OpenID Connect Discovery
        1.0 specification.
 - iat: Issue time in seconds since epoch. Must be in the past.
 - exp: Expiration time in seconds since epoch. Must be less than 48 hours
        after iat. We recommend to create tokens that last shorter than 6
        hours to improve security unless business reasons mandate longer
        expiration times. Shorter token lifetimes are generally more secure
        since tokens that have been exfiltrated by attackers can be used for
        a shorter time. you can configure the maximum lifetime of the
        incoming token in the configuration of the mapper.
        The resulting Google token will expire within an hour or at "exp",
        whichever is earlier.
 - sub: JWT subject, identity asserted in the JWT.
 - aud: Configured in the mapper policy. By default the service account
        email.
 Claims from the incoming token can be transferred into the output token
 accoding to the mapper configuration. The outgoing claim size is limited.
 Outgoing claims size must be less than 4kB serialized as JSON without
 whitespace.
 Example header:
 {
   "alg": "RS256",
   "kid": "92a4265e14ab04d4d228a48d10d4ca31610936f8"
 }
 Example payload:
 {
   "iss": "https://accounts.google.com",
   "iat": 1517963104,
   "exp": 1517966704,
   "aud": "https://iamcredentials.googleapis.com/",
   "sub": "113475438248934895348",
   "my_claims": {
     "additional_claim": "value"
   }
 }

string jwt = 3;

Specified by:: getJwt in interface GenerateIdentityBindingAccessTokenRequestOrBuilder

getJwtBytes

public com.google.protobuf.ByteString getJwtBytes()

 Required. Input token.
 Must be in JWT format according to
 RFC7523 (https://tools.ietf.org/html/rfc7523)
 and must have 'kid' field in the header.
 Supported signing algorithms: RS256 (RS512, ES256, ES512 coming soon).
 Mandatory payload fields (along the lines of RFC 7523, section 3):
 - iss: issuer of the token. Must provide a discovery document at
        $iss/.well-known/openid-configuration . The document needs to be
        formatted according to section 4.2 of the OpenID Connect Discovery
        1.0 specification.
 - iat: Issue time in seconds since epoch. Must be in the past.
 - exp: Expiration time in seconds since epoch. Must be less than 48 hours
        after iat. We recommend to create tokens that last shorter than 6
        hours to improve security unless business reasons mandate longer
        expiration times. Shorter token lifetimes are generally more secure
        since tokens that have been exfiltrated by attackers can be used for
        a shorter time. you can configure the maximum lifetime of the
        incoming token in the configuration of the mapper.
        The resulting Google token will expire within an hour or at "exp",
        whichever is earlier.
 - sub: JWT subject, identity asserted in the JWT.
 - aud: Configured in the mapper policy. By default the service account
        email.
 Claims from the incoming token can be transferred into the output token
 accoding to the mapper configuration. The outgoing claim size is limited.
 Outgoing claims size must be less than 4kB serialized as JSON without
 whitespace.
 Example header:
 {
   "alg": "RS256",
   "kid": "92a4265e14ab04d4d228a48d10d4ca31610936f8"
 }
 Example payload:
 {
   "iss": "https://accounts.google.com",
   "iat": 1517963104,
   "exp": 1517966704,
   "aud": "https://iamcredentials.googleapis.com/",
   "sub": "113475438248934895348",
   "my_claims": {
     "additional_claim": "value"
   }
 }

string jwt = 3;

Specified by:: getJwtBytes in interface GenerateIdentityBindingAccessTokenRequestOrBuilder

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 GenerateIdentityBindingAccessTokenRequest parseFrom(ByteBuffer data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateIdentityBindingAccessTokenRequest parseFrom(ByteBuffer data,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateIdentityBindingAccessTokenRequest parseFrom(com.google.protobuf.ByteString data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateIdentityBindingAccessTokenRequest parseFrom(com.google.protobuf.ByteString data,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateIdentityBindingAccessTokenRequest parseFrom(byte[] data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateIdentityBindingAccessTokenRequest parseFrom(byte[] data,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateIdentityBindingAccessTokenRequest parseFrom(InputStream input)
                                                           throws IOException

Throws:: IOException

parseFrom

public static GenerateIdentityBindingAccessTokenRequest parseFrom(InputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:: IOException

parseDelimitedFrom

public static GenerateIdentityBindingAccessTokenRequest parseDelimitedFrom(InputStream input)
                                                                    throws IOException

Throws:: IOException

parseDelimitedFrom

public static GenerateIdentityBindingAccessTokenRequest parseDelimitedFrom(InputStream input,
                                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                    throws IOException

Throws:: IOException

parseFrom

public static GenerateIdentityBindingAccessTokenRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                           throws IOException

Throws:: IOException

parseFrom

public static GenerateIdentityBindingAccessTokenRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:: IOException

newBuilderForType
```
public GenerateIdentityBindingAccessTokenRequest.Builder newBuilderForType()
```
Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerateIdentityBindingAccessTokenRequest.Builder newBuilder()

newBuilder

public static GenerateIdentityBindingAccessTokenRequest.Builder newBuilder(GenerateIdentityBindingAccessTokenRequest prototype)

toBuilder
```
public GenerateIdentityBindingAccessTokenRequest.Builder toBuilder()
```
Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GenerateIdentityBindingAccessTokenRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:: newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GenerateIdentityBindingAccessTokenRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<GenerateIdentityBindingAccessTokenRequest> parser()

getParserForType
```
public com.google.protobuf.Parser<GenerateIdentityBindingAccessTokenRequest> 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 GenerateIdentityBindingAccessTokenRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class GenerateIdentityBindingAccessTokenRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

NAME_FIELD_NUMBER

SCOPE_FIELD_NUMBER

JWT_FIELD_NUMBER

Method Detail

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getName

getNameBytes

getScopeList

getScopeCount

getScope

getScopeBytes

getJwt

getJwtBytes

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType