public static final class AttributeContext.Auth.Builder extends GeneratedMessageV3.Builder<AttributeContext.Auth.Builder> implements AttributeContext.AuthOrBuilderThis 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AttributeContext.Auth.BuilderImplements
AttributeContext.AuthOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAccessLevels(String value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe accessLevels to add. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
addAccessLevelsBytes(ByteString value)
public AttributeContext.Auth.Builder addAccessLevelsBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the accessLevels to add. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
addAllAccessLevels(Iterable<String> values)
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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The accessLevels to add. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
addAllAudiences(Iterable<String> values)
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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The audiences to add. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
addAudiences(String value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe audiences to add. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
addAudiencesBytes(ByteString value)
public AttributeContext.Auth.Builder addAudiencesBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the audiences to add. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AttributeContext.Auth.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
build()
public AttributeContext.Auth build()| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth |
|
buildPartial()
public AttributeContext.Auth buildPartial()| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth |
|
clear()
public AttributeContext.Auth.Builder clear()| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
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;
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
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;
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public AttributeContext.Auth.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public AttributeContext.Auth.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
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;
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
clone()
public AttributeContext.Auth.Builder clone()| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
getAccessLevels(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The accessLevels at the given index. |
getAccessLevelsBytes(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the accessLevels at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of accessLevels. |
getAccessLevelsList()
public 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the accessLevels. |
getAudiences(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The audiences at the given index. |
getAudiencesBytes(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the audiences at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of audiences. |
getAudiencesList()
public 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the audiences. |
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;
| Returns | |
|---|---|
| Type | Description |
Struct |
The claims. |
getClaimsBuilder()
public Struct.Builder getClaimsBuilder() 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 | |
|---|---|
| Type | Description |
Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
getDefaultInstanceForType()
public AttributeContext.Auth getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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;
| Returns | |
|---|---|
| Type | Description |
String |
The presenter. |
getPresenterBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for presenter. |
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;
| Returns | |
|---|---|
| Type | Description |
String |
The principal. |
getPrincipalBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for principal. |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the claims field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeClaims(Struct value)
public AttributeContext.Auth.Builder mergeClaims(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;
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AttributeContext.Auth.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AttributeContext.Auth.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
mergeFrom(AttributeContext.Auth other)
public AttributeContext.Auth.Builder mergeFrom(AttributeContext.Auth other)| Parameter | |
|---|---|
| Name | Description |
other |
AttributeContext.Auth |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AttributeContext.Auth.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
setAccessLevels(int index, String value)
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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe accessLevels to set. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
setAudiences(int index, String value)
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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe audiences to set. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
setClaims(Struct value)
public AttributeContext.Auth.Builder setClaims(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;
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
setClaims(Struct.Builder builderForValue)
public AttributeContext.Auth.Builder setClaims(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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public AttributeContext.Auth.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
setPresenter(String value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe presenter to set. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
setPresenterBytes(ByteString value)
public AttributeContext.Auth.Builder setPresenterBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for presenter to set. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
setPrincipal(String value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe principal to set. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
setPrincipalBytes(ByteString value)
public AttributeContext.Auth.Builder setPrincipalBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for principal to set. |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AttributeContext.Auth.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final AttributeContext.Auth.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AttributeContext.Auth.Builder |
|