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
Modifier and Type | Class and Description |
---|---|
static class |
AttributeContext.Auth.Builder
This message defines request authentication attributes.
|
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
Modifier and Type | Field and Description |
---|---|
static int |
ACCESS_LEVELS_FIELD_NUMBER |
static int |
AUDIENCES_FIELD_NUMBER |
static int |
CLAIMS_FIELD_NUMBER |
static int |
PRESENTER_FIELD_NUMBER |
static int |
PRINCIPAL_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
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.
|
com.google.protobuf.ProtocolStringList |
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.
|
com.google.protobuf.ProtocolStringList |
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.
|
static AttributeContext.Auth |
getDefaultInstance() |
AttributeContext.Auth |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Parser<AttributeContext.Auth> |
getParserForType() |
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.
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasClaims()
Structured claims presented with the credential.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static AttributeContext.Auth.Builder |
newBuilder() |
static AttributeContext.Auth.Builder |
newBuilder(AttributeContext.Auth prototype) |
AttributeContext.Auth.Builder |
newBuilderForType() |
protected AttributeContext.Auth.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
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(ByteBuffer data) |
static AttributeContext.Auth |
parseFrom(ByteBuffer 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 com.google.protobuf.Parser<AttributeContext.Auth> |
parser() |
AttributeContext.Auth.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int PRINCIPAL_FIELD_NUMBER
public static final int AUDIENCES_FIELD_NUMBER
public static final int PRESENTER_FIELD_NUMBER
public static final int CLAIMS_FIELD_NUMBER
public static final int ACCESS_LEVELS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
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;
getPrincipal
in interface AttributeContext.AuthOrBuilder
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;
getPrincipalBytes
in interface AttributeContext.AuthOrBuilder
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;
getAudiencesList
in interface AttributeContext.AuthOrBuilder
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;
getAudiencesCount
in interface AttributeContext.AuthOrBuilder
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;
getAudiences
in interface AttributeContext.AuthOrBuilder
index
- The index of the element to return.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;
getAudiencesBytes
in interface AttributeContext.AuthOrBuilder
index
- The index of the value to return.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;
getPresenter
in interface AttributeContext.AuthOrBuilder
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;
getPresenterBytes
in interface AttributeContext.AuthOrBuilder
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;
hasClaims
in interface AttributeContext.AuthOrBuilder
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;
getClaims
in interface AttributeContext.AuthOrBuilder
public 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;
getClaimsOrBuilder
in interface AttributeContext.AuthOrBuilder
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;
getAccessLevelsList
in interface AttributeContext.AuthOrBuilder
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;
getAccessLevelsCount
in interface AttributeContext.AuthOrBuilder
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;
getAccessLevels
in interface AttributeContext.AuthOrBuilder
index
- The index of the element to return.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;
getAccessLevelsBytes
in interface AttributeContext.AuthOrBuilder
index
- The index of the value to return.public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static AttributeContext.Auth parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AttributeContext.Auth parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AttributeContext.Auth parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AttributeContext.Auth parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AttributeContext.Auth parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AttributeContext.Auth parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AttributeContext.Auth parseFrom(InputStream input) throws IOException
IOException
public static AttributeContext.Auth parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static AttributeContext.Auth parseDelimitedFrom(InputStream input) throws IOException
IOException
public static AttributeContext.Auth parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static AttributeContext.Auth parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static AttributeContext.Auth parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public AttributeContext.Auth.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static AttributeContext.Auth.Builder newBuilder()
public static AttributeContext.Auth.Builder newBuilder(AttributeContext.Auth prototype)
public AttributeContext.Auth.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected AttributeContext.Auth.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static AttributeContext.Auth getDefaultInstance()
public static com.google.protobuf.Parser<AttributeContext.Auth> parser()
public com.google.protobuf.Parser<AttributeContext.Auth> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public AttributeContext.Auth getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2021 Google LLC. All rights reserved.