Cloud PubSub V1 Client - Class OidcToken (2.4.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class OidcToken.

Contains information needed for generating an OpenID Connect token.

Generated from protobuf message google.pubsub.v1.PushConfig.OidcToken

Namespace

Google \ Cloud \ PubSub \ V1 \ PushConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ service_account_email string

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

↳ audience string

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.

getServiceAccountEmail

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

Returns
Type Description
string

setServiceAccountEmail

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

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setAudience

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.

Parameter
Name Description
var string
Returns
Type Description
$this