Class PushConfig.OidcToken.Builder (1.129.6)

public static final class PushConfig.OidcToken.Builder extends GeneratedMessageV3.Builder<PushConfig.OidcToken.Builder> implements PushConfig.OidcTokenOrBuilder

Contains information needed for generating an OpenID Connect token.

Protobuf type google.pubsub.v1.PushConfig.OidcToken

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PushConfig.OidcToken.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides

build()

public PushConfig.OidcToken build()
Returns
Type Description
PushConfig.OidcToken

buildPartial()

public PushConfig.OidcToken buildPartial()
Returns
Type Description
PushConfig.OidcToken

clear()

public PushConfig.OidcToken.Builder clear()
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides

clearAudience()

public PushConfig.OidcToken.Builder clearAudience()

Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.

string audience = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PushConfig.OidcToken.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PushConfig.OidcToken.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PushConfig.OidcToken.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides

clearServiceAccountEmail()

public PushConfig.OidcToken.Builder clearServiceAccountEmail()

Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.

string service_account_email = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PushConfig.OidcToken.Builder

This builder for chaining.

clone()

public PushConfig.OidcToken.Builder clone()
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides

getAudience()

public String getAudience()

Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.

string audience = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The audience.

getAudienceBytes()

public ByteString getAudienceBytes()

Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.

string audience = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for audience.

getDefaultInstanceForType()

public PushConfig.OidcToken getDefaultInstanceForType()
Returns
Type Description
PushConfig.OidcToken

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getServiceAccountEmail()

public String getServiceAccountEmail()

Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.

string service_account_email = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.

string service_account_email = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for serviceAccountEmail.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PushConfig.OidcToken.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PushConfig.OidcToken.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides

mergeFrom(PushConfig.OidcToken other)

public PushConfig.OidcToken.Builder mergeFrom(PushConfig.OidcToken other)
Parameter
Name Description
other PushConfig.OidcToken
Returns
Type Description
PushConfig.OidcToken.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PushConfig.OidcToken.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides

setAudience(String value)

public PushConfig.OidcToken.Builder setAudience(String value)

Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.

string audience = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The audience to set.

Returns
Type Description
PushConfig.OidcToken.Builder

This builder for chaining.

setAudienceBytes(ByteString value)

public PushConfig.OidcToken.Builder setAudienceBytes(ByteString value)

Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.

string audience = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for audience to set.

Returns
Type Description
PushConfig.OidcToken.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PushConfig.OidcToken.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PushConfig.OidcToken.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides

setServiceAccountEmail(String value)

public PushConfig.OidcToken.Builder setServiceAccountEmail(String value)

Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.

string service_account_email = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The serviceAccountEmail to set.

Returns
Type Description
PushConfig.OidcToken.Builder

This builder for chaining.

setServiceAccountEmailBytes(ByteString value)

public PushConfig.OidcToken.Builder setServiceAccountEmailBytes(ByteString value)

Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.

string service_account_email = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for serviceAccountEmail to set.

Returns
Type Description
PushConfig.OidcToken.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PushConfig.OidcToken.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PushConfig.OidcToken.Builder
Overrides