Class PushConfig.OidcToken.Builder (1.117.0)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PushConfig.OidcToken.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PushConfig.OidcToken.Builder
Overrides

build()

public PushConfig.OidcToken build()
Returns
TypeDescription
PushConfig.OidcToken

buildPartial()

public PushConfig.OidcToken buildPartial()
Returns
TypeDescription
PushConfig.OidcToken

clear()

public PushConfig.OidcToken.Builder clear()
Returns
TypeDescription
PushConfig.OidcToken.Builder
Overrides

clearAudience()

public PushConfig.OidcToken.Builder clearAudience()

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;

Returns
TypeDescription
PushConfig.OidcToken.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PushConfig.OidcToken.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PushConfig.OidcToken.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PushConfig.OidcToken.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PushConfig.OidcToken.Builder
Overrides

clearServiceAccountEmail()

public PushConfig.OidcToken.Builder clearServiceAccountEmail()

Service account email to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Returns
TypeDescription
PushConfig.OidcToken.Builder

This builder for chaining.

clone()

public PushConfig.OidcToken.Builder clone()
Returns
TypeDescription
PushConfig.OidcToken.Builder
Overrides

getAudience()

public String getAudience()

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;

Returns
TypeDescription
String

The audience.

getAudienceBytes()

public ByteString getAudienceBytes()

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;

Returns
TypeDescription
ByteString

The bytes for audience.

getDefaultInstanceForType()

public PushConfig.OidcToken getDefaultInstanceForType()
Returns
TypeDescription
PushConfig.OidcToken

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getServiceAccountEmail()

public String getServiceAccountEmail()

Service account email to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Returns
TypeDescription
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

Service account email to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Returns
TypeDescription
ByteString

The bytes for serviceAccountEmail.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PushConfig.OidcToken.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PushConfig.OidcToken.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PushConfig.OidcToken.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PushConfig.OidcToken.Builder
Overrides

mergeFrom(PushConfig.OidcToken other)

public PushConfig.OidcToken.Builder mergeFrom(PushConfig.OidcToken other)
Parameter
NameDescription
otherPushConfig.OidcToken
Returns
TypeDescription
PushConfig.OidcToken.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PushConfig.OidcToken.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PushConfig.OidcToken.Builder
Overrides

setAudience(String value)

public PushConfig.OidcToken.Builder setAudience(String value)

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;

Parameter
NameDescription
valueString

The audience to set.

Returns
TypeDescription
PushConfig.OidcToken.Builder

This builder for chaining.

setAudienceBytes(ByteString value)

public PushConfig.OidcToken.Builder setAudienceBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for audience to set.

Returns
TypeDescription
PushConfig.OidcToken.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PushConfig.OidcToken.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PushConfig.OidcToken.Builder
Overrides

setServiceAccountEmail(String value)

public PushConfig.OidcToken.Builder setServiceAccountEmail(String value)

Service account email to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Parameter
NameDescription
valueString

The serviceAccountEmail to set.

Returns
TypeDescription
PushConfig.OidcToken.Builder

This builder for chaining.

setServiceAccountEmailBytes(ByteString value)

public PushConfig.OidcToken.Builder setServiceAccountEmailBytes(ByteString value)

Service account email to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Parameter
NameDescription
valueByteString

The bytes for serviceAccountEmail to set.

Returns
TypeDescription
PushConfig.OidcToken.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PushConfig.OidcToken.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PushConfig.OidcToken.Builder
Overrides