Class AttributeContext.Auth

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.rpc.context.AttributeContext.Auth
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AttributeContext.AuthOrBuilder, Serializable
Enclosing class:
AttributeContext

public static final class AttributeContext.Auth extends com.google.protobuf.GeneratedMessageV3 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
See Also:
  • Nested Class Summary

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

    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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    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
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    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
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    getAccessLevels(int index)
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    com.google.protobuf.ByteString
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    int
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    com.google.protobuf.ProtocolStringList
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    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
    The intended audience(s) for this authentication information.
    com.google.protobuf.ProtocolStringList
    The intended audience(s) for this authentication information.
    Structured claims presented with the credential.
    Structured claims presented with the credential.
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.Parser<AttributeContext.Auth>
     
    The authorized presenter of the credential.
    com.google.protobuf.ByteString
    The authorized presenter of the credential.
    The authenticated principal.
    com.google.protobuf.ByteString
    The authenticated principal.
    int
     
    final com.google.protobuf.UnknownFieldSet
     
    boolean
    Structured claims presented with the credential.
    int
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AttributeContext.Auth>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • 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
    • 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;
      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;
      Specified by:
      getPrincipalBytes in interface AttributeContext.AuthOrBuilder
      Returns:
      The bytes for principal.
    • getAudiencesList

      public com.google.protobuf.ProtocolStringList 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;
      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;
      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;
      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;
      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;
      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;
      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;
      Specified by:
      hasClaims in interface AttributeContext.AuthOrBuilder
      Returns:
      Whether the claims field is set.
    • getClaims

      public 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;
      Specified by:
      getClaims in interface AttributeContext.AuthOrBuilder
      Returns:
      The claims.
    • getClaimsOrBuilder

      public StructOrBuilder getClaimsOrBuilder()
       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;
      Specified by:
      getClaimsOrBuilder in interface AttributeContext.AuthOrBuilder
    • getAccessLevelsList

      public com.google.protobuf.ProtocolStringList 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;
      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;
      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;
      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;
      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.
    • 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 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
    • newBuilderForType

      public AttributeContext.Auth.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

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

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

      public AttributeContext.Auth.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected AttributeContext.Auth.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static AttributeContext.Auth getDefaultInstance()
    • parser

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

      public com.google.protobuf.Parser<AttributeContext.Auth> 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 AttributeContext.Auth getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder