Package com.google.rpc.context
Interface AttributeContext.AuthOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
AttributeContext.Auth
,AttributeContext.Auth.Builder
- Enclosing class:
- AttributeContext
public static interface AttributeContext.AuthOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.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.java.util.List<java.lang.String>
getAccessLevelsList()
A list of access level resource names that allow resources to be accessed by authenticated requester.java.lang.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.java.util.List<java.lang.String>
getAudiencesList()
The intended audience(s) for this authentication information.com.google.protobuf.Struct
getClaims()
Structured claims presented with the credential.com.google.protobuf.StructOrBuilder
getClaimsOrBuilder()
Structured claims presented with the credential.java.lang.String
getPresenter()
The authorized presenter of the credential.com.google.protobuf.ByteString
getPresenterBytes()
The authorized presenter of the credential.java.lang.String
getPrincipal()
The authenticated principal.com.google.protobuf.ByteString
getPrincipalBytes()
The authenticated principal.boolean
hasClaims()
Structured claims presented with the credential.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getPrincipal
java.lang.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;
- Returns:
- The principal.
-
getPrincipalBytes
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;
- Returns:
- The bytes for principal.
-
getAudiencesList
java.util.List<java.lang.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;
- Returns:
- A list containing the audiences.
-
getAudiencesCount
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;
- Returns:
- The count of audiences.
-
getAudiences
java.lang.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;
- Parameters:
index
- The index of the element to return.- Returns:
- The audiences at the given index.
-
getAudiencesBytes
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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the audiences at the given index.
-
getPresenter
java.lang.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;
- Returns:
- The presenter.
-
getPresenterBytes
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;
- Returns:
- The bytes for presenter.
-
hasClaims
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;
- Returns:
- Whether the claims field is set.
-
getClaims
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;
- Returns:
- The claims.
-
getClaimsOrBuilder
com.google.protobuf.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;
-
getAccessLevelsList
java.util.List<java.lang.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;
- Returns:
- A list containing the accessLevels.
-
getAccessLevelsCount
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;
- Returns:
- The count of accessLevels.
-
getAccessLevels
java.lang.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;
- Parameters:
index
- The index of the element to return.- Returns:
- The accessLevels at the given index.
-
getAccessLevelsBytes
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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the accessLevels at the given index.
-
-