Package com.google.rpc.context

Class AttributeContext.Auth

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<AttributeContext.Auth,AttributeContext.Auth.Builder>
com.google.rpc.context.AttributeContext.Auth
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, AttributeContext.AuthOrBuilder
Enclosing class:
AttributeContext
public static final class AttributeContext.Auth extends com.google.protobuf.GeneratedMessageLite<AttributeContext.Auth,AttributeContext.Auth.Builder> implements AttributeContext.AuthOrBuilder
 This message defines request authentication attributes. Terminology is
 based on the JSON Web Token (JWT) standard, but the terms also
 correlate to concepts in other standards.
Protobuf type google.rpc.context.AttributeContext.Auth

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AttributeContext.Auth.Builder
    This message defines request authentication attributes.

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

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACCESS_LEVELS_FIELD_NUMBER
     
    static final int
    AUDIENCES_FIELD_NUMBER
     
    static final int
    CLAIMS_FIELD_NUMBER
     
    static final int
    PRESENTER_FIELD_NUMBER
     
    static final int
    PRINCIPAL_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    String
    getAccessLevels(int index)
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    com.google.protobuf.ByteString
    getAccessLevelsBytes(int index)
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    int
    getAccessLevelsCount()
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    List<String>
    getAccessLevelsList()
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    String
    getAudiences(int index)
    The intended audience(s) for this authentication information.
    com.google.protobuf.ByteString
    getAudiencesBytes(int index)
    The intended audience(s) for this authentication information.
    int
    getAudiencesCount()
    The intended audience(s) for this authentication information.
    List<String>
    getAudiencesList()
    The intended audience(s) for this authentication information.
    com.google.protobuf.Struct
    getClaims()
    Structured claims presented with the credential.
    static AttributeContext.Auth
    getDefaultInstance()
     
    String
    getPresenter()
    The authorized presenter of the credential.
    com.google.protobuf.ByteString
    getPresenterBytes()
    The authorized presenter of the credential.
    String
    getPrincipal()
    The authenticated principal.
    com.google.protobuf.ByteString
    getPrincipalBytes()
    The authenticated principal.
    boolean
    hasClaims()
    Structured claims presented with the credential.
    static AttributeContext.Auth.Builder
    newBuilder()
     
    static AttributeContext.Auth.Builder
    newBuilder(AttributeContext.Auth prototype)
     
    static AttributeContext.Auth
    parseDelimitedFrom(InputStream input)
     
    static AttributeContext.Auth
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AttributeContext.Auth
    parseFrom(byte[] data)
     
    static AttributeContext.Auth
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AttributeContext.Auth
    parseFrom(com.google.protobuf.ByteString data)
     
    static AttributeContext.Auth
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AttributeContext.Auth
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AttributeContext.Auth
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AttributeContext.Auth
    parseFrom(InputStream input)
     
    static AttributeContext.Auth
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AttributeContext.Auth
    parseFrom(ByteBuffer data)
     
    static AttributeContext.Auth
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AttributeContext.Auth>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

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

    getDefaultInstanceForType, isInitialized

  • Field Details

  • Method Details

    • getPrincipal

      public String getPrincipal()
       The authenticated principal. Reflects the issuer (`iss`) and subject
 (`sub`) claims within a JWT. The issuer and subject should be `/`
 delimited, with `/` percent-encoded within the subject fragment. For
 Google accounts, the principal format is:
 "https://accounts.google.com/{id}"
      string principal = 1 [json_name = "principal"];
      Specified by:
      getPrincipal in interface AttributeContext.AuthOrBuilder
      Returns:
      The principal.

    • getPrincipalBytes

      public com.google.protobuf.ByteString getPrincipalBytes()
       The authenticated principal. Reflects the issuer (`iss`) and subject
 (`sub`) claims within a JWT. The issuer and subject should be `/`
 delimited, with `/` percent-encoded within the subject fragment. For
 Google accounts, the principal format is:
 "https://accounts.google.com/{id}"
      string principal = 1 [json_name = "principal"];
      Specified by:
      getPrincipalBytes in interface AttributeContext.AuthOrBuilder
      Returns:
      The bytes for principal.

    • getAudiencesList

      public List<String> getAudiencesList()
       The intended audience(s) for this authentication information. Reflects
 the audience (`aud`) claim within a JWT. The audience
 value(s) depends on the `issuer`, but typically include one or more of
 the following pieces of information:

 *  The services intended to receive the credential. For example,
 ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
 *  A set of service-based scopes. For example,
 ["https://www.googleapis.com/auth/cloud-platform"].
 *  The client id of an app, such as the Firebase project id for JWTs
 from Firebase Auth.

 Consult the documentation for the credential issuer to determine the
 information provided.
      repeated string audiences = 2 [json_name = "audiences"];
      Specified by:
      getAudiencesList in interface AttributeContext.AuthOrBuilder
      Returns:
      A list containing the audiences.

    • getAudiencesCount

      public int getAudiencesCount()
       The intended audience(s) for this authentication information. Reflects
 the audience (`aud`) claim within a JWT. The audience
 value(s) depends on the `issuer`, but typically include one or more of
 the following pieces of information:

 *  The services intended to receive the credential. For example,
 ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
 *  A set of service-based scopes. For example,
 ["https://www.googleapis.com/auth/cloud-platform"].
 *  The client id of an app, such as the Firebase project id for JWTs
 from Firebase Auth.

 Consult the documentation for the credential issuer to determine the
 information provided.
      repeated string audiences = 2 [json_name = "audiences"];
      Specified by:
      getAudiencesCount in interface AttributeContext.AuthOrBuilder
      Returns:
      The count of audiences.

    • getAudiences

      public String getAudiences(int index)
       The intended audience(s) for this authentication information. Reflects
 the audience (`aud`) claim within a JWT. The audience
 value(s) depends on the `issuer`, but typically include one or more of
 the following pieces of information:

 *  The services intended to receive the credential. For example,
 ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
 *  A set of service-based scopes. For example,
 ["https://www.googleapis.com/auth/cloud-platform"].
 *  The client id of an app, such as the Firebase project id for JWTs
 from Firebase Auth.

 Consult the documentation for the credential issuer to determine the
 information provided.
      repeated string audiences = 2 [json_name = "audiences"];
      Specified by:
      getAudiences in interface AttributeContext.AuthOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The audiences at the given index.

    • getAudiencesBytes

      public com.google.protobuf.ByteString getAudiencesBytes(int index)
       The intended audience(s) for this authentication information. Reflects
 the audience (`aud`) claim within a JWT. The audience
 value(s) depends on the `issuer`, but typically include one or more of
 the following pieces of information:

 *  The services intended to receive the credential. For example,
 ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
 *  A set of service-based scopes. For example,
 ["https://www.googleapis.com/auth/cloud-platform"].
 *  The client id of an app, such as the Firebase project id for JWTs
 from Firebase Auth.

 Consult the documentation for the credential issuer to determine the
 information provided.
      repeated string audiences = 2 [json_name = "audiences"];
      Specified by:
      getAudiencesBytes in interface AttributeContext.AuthOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the audiences at the given index.

    • getPresenter

      public String getPresenter()
       The authorized presenter of the credential. Reflects the optional
 Authorized Presenter (`azp`) claim within a JWT or the
 OAuth client id. For example, a Google Cloud Platform client id looks
 as follows: "123456789012.apps.googleusercontent.com".
      string presenter = 3 [json_name = "presenter"];
      Specified by:
      getPresenter in interface AttributeContext.AuthOrBuilder
      Returns:
      The presenter.

    • getPresenterBytes

      public com.google.protobuf.ByteString getPresenterBytes()
       The authorized presenter of the credential. Reflects the optional
 Authorized Presenter (`azp`) claim within a JWT or the
 OAuth client id. For example, a Google Cloud Platform client id looks
 as follows: "123456789012.apps.googleusercontent.com".
      string presenter = 3 [json_name = "presenter"];
      Specified by:
      getPresenterBytes in interface AttributeContext.AuthOrBuilder
      Returns:
      The bytes for presenter.

    • hasClaims

      public boolean hasClaims()
       Structured claims presented with the credential. JWTs include
 `{key: value}` pairs for standard and private claims. The following
 is a subset of the standard required and optional claims that would
 typically be presented for a Google-based JWT:

 {'iss': 'accounts.google.com',
 'sub': '113289723416554971153',
 'aud': ['123456789012', 'pubsub.googleapis.com'],
 'azp': '123456789012.apps.googleusercontent.com',
 'email': 'jsmith@example.com',
 'iat': 1353601026,
 'exp': 1353604926}

 SAML assertions are similarly specified, but with an identity provider
 dependent structure.
      .google.protobuf.Struct claims = 4 [json_name = "claims"];
      Specified by:
      hasClaims in interface AttributeContext.AuthOrBuilder
      Returns:
      Whether the claims field is set.

    • getClaims

      public com.google.protobuf.Struct getClaims()
       Structured claims presented with the credential. JWTs include
 `{key: value}` pairs for standard and private claims. The following
 is a subset of the standard required and optional claims that would
 typically be presented for a Google-based JWT:

 {'iss': 'accounts.google.com',
 'sub': '113289723416554971153',
 'aud': ['123456789012', 'pubsub.googleapis.com'],
 'azp': '123456789012.apps.googleusercontent.com',
 'email': 'jsmith@example.com',
 'iat': 1353601026,
 'exp': 1353604926}

 SAML assertions are similarly specified, but with an identity provider
 dependent structure.
      .google.protobuf.Struct claims = 4 [json_name = "claims"];
      Specified by:
      getClaims in interface AttributeContext.AuthOrBuilder
      Returns:
      The claims.

    • getAccessLevelsList

      public List<String> getAccessLevelsList()
       A list of access level resource names that allow resources to be
 accessed by authenticated requester. It is part of Secure GCP processing
 for the incoming request. An access level string has the format:
 "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}"

 Example:
 "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
      repeated string access_levels = 5 [json_name = "accessLevels"];
      Specified by:
      getAccessLevelsList in interface AttributeContext.AuthOrBuilder
      Returns:
      A list containing the accessLevels.

    • getAccessLevelsCount

      public int getAccessLevelsCount()
       A list of access level resource names that allow resources to be
 accessed by authenticated requester. It is part of Secure GCP processing
 for the incoming request. An access level string has the format:
 "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}"

 Example:
 "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
      repeated string access_levels = 5 [json_name = "accessLevels"];
      Specified by:
      getAccessLevelsCount in interface AttributeContext.AuthOrBuilder
      Returns:
      The count of accessLevels.

    • getAccessLevels

      public String getAccessLevels(int index)
       A list of access level resource names that allow resources to be
 accessed by authenticated requester. It is part of Secure GCP processing
 for the incoming request. An access level string has the format:
 "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}"

 Example:
 "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
      repeated string access_levels = 5 [json_name = "accessLevels"];
      Specified by:
      getAccessLevels in interface AttributeContext.AuthOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The accessLevels at the given index.

    • getAccessLevelsBytes

      public com.google.protobuf.ByteString getAccessLevelsBytes(int index)
       A list of access level resource names that allow resources to be
 accessed by authenticated requester. It is part of Secure GCP processing
 for the incoming request. An access level string has the format:
 "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}"

 Example:
 "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
      repeated string access_levels = 5 [json_name = "accessLevels"];
      Specified by:
      getAccessLevelsBytes in interface AttributeContext.AuthOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the accessLevels at the given index.

    • parseFrom

      public static AttributeContext.Auth parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static AttributeContext.Auth parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AttributeContext.Auth parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AttributeContext.Auth parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AttributeContext.Auth parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AttributeContext.Auth parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AttributeContext.Auth parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AttributeContext.Auth parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static AttributeContext.Auth.Builder newBuilder()

    • newBuilder

      public static AttributeContext.Auth.Builder newBuilder(AttributeContext.Auth prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<AttributeContext.Auth,AttributeContext.Auth.Builder>

    • getDefaultInstance

      public static AttributeContext.Auth getDefaultInstance()

    • parser

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