Package com.google.rpc.context

Class AttributeContext.Auth.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<AttributeContext.Auth,AttributeContext.Auth.Builder>
com.google.rpc.context.AttributeContext.Auth.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, AttributeContext.AuthOrBuilder, Cloneable
Enclosing class:
AttributeContext.Auth
public static final class AttributeContext.Auth.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<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

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

    • setPrincipal

      public AttributeContext.Auth.Builder setPrincipal(String value)
       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"];
      Parameters:
      value - The principal to set.
      Returns:
      This builder for chaining.

    • clearPrincipal

      public AttributeContext.Auth.Builder clearPrincipal()
       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"];
      Returns:
      This builder for chaining.

    • setPrincipalBytes

      public AttributeContext.Auth.Builder setPrincipalBytes(com.google.protobuf.ByteString value)
       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"];
      Parameters:
      value - The bytes for principal to set.
      Returns:
      This builder for chaining.

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

    • setAudiences

      public AttributeContext.Auth.Builder setAudiences(int index, String value)
       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"];
      Parameters:
      index - The index to set the value at.
      value - The audiences to set.
      Returns:
      This builder for chaining.

    • addAudiences

      public AttributeContext.Auth.Builder addAudiences(String value)
       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"];
      Parameters:
      value - The audiences to add.
      Returns:
      This builder for chaining.

    • addAllAudiences

      public AttributeContext.Auth.Builder addAllAudiences(Iterable<String> values)
       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"];
      Parameters:
      values - The audiences to add.
      Returns:
      This builder for chaining.

    • clearAudiences

      public AttributeContext.Auth.Builder clearAudiences()
       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"];
      Returns:
      This builder for chaining.

    • addAudiencesBytes

      public AttributeContext.Auth.Builder addAudiencesBytes(com.google.protobuf.ByteString value)
       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"];
      Parameters:
      value - The bytes of the audiences to add.
      Returns:
      This builder for chaining.

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

    • setPresenter

      public AttributeContext.Auth.Builder setPresenter(String value)
       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"];
      Parameters:
      value - The presenter to set.
      Returns:
      This builder for chaining.

    • clearPresenter

      public AttributeContext.Auth.Builder clearPresenter()
       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"];
      Returns:
      This builder for chaining.

    • setPresenterBytes

      public AttributeContext.Auth.Builder setPresenterBytes(com.google.protobuf.ByteString value)
       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"];
      Parameters:
      value - The bytes for presenter to set.
      Returns:
      This builder for chaining.

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

    • setClaims

      public AttributeContext.Auth.Builder setClaims(com.google.protobuf.Struct value)
       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"];

    • setClaims

      public AttributeContext.Auth.Builder setClaims(com.google.protobuf.Struct.Builder builderForValue)
       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"];

    • mergeClaims

      public AttributeContext.Auth.Builder mergeClaims(com.google.protobuf.Struct value)
       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"];

    • clearClaims

      public AttributeContext.Auth.Builder clearClaims()
       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"];

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

    • setAccessLevels

      public AttributeContext.Auth.Builder setAccessLevels(int index, String value)
       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"];
      Parameters:
      index - The index to set the value at.
      value - The accessLevels to set.
      Returns:
      This builder for chaining.

    • addAccessLevels

      public AttributeContext.Auth.Builder addAccessLevels(String value)
       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"];
      Parameters:
      value - The accessLevels to add.
      Returns:
      This builder for chaining.

    • addAllAccessLevels

      public AttributeContext.Auth.Builder addAllAccessLevels(Iterable<String> values)
       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"];
      Parameters:
      values - The accessLevels to add.
      Returns:
      This builder for chaining.

    • clearAccessLevels

      public AttributeContext.Auth.Builder clearAccessLevels()
       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"];
      Returns:
      This builder for chaining.

    • addAccessLevelsBytes

      public AttributeContext.Auth.Builder addAccessLevelsBytes(com.google.protobuf.ByteString value)
       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"];
      Parameters:
      value - The bytes of the accessLevels to add.
      Returns:
      This builder for chaining.