Class: Google::Cloud::PubSub::Subscription::PushConfig::OidcToken

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/pubsub/subscription/push_config.rb

Overview

Contains information needed for generating an OpenID Connect token.

Instance Method Summary collapse

Instance Method Details

#audienceString

The 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 endpoint URL will be used.

Returns:

  • (String)


233
234
235
# File 'lib/google/cloud/pubsub/subscription/push_config.rb', line 233

def audience
  @grpc.audience
end

#audience=(new_audience) ⇒ Object

Sets the 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 endpoint URL will be used.

Parameters:

  • new_audience (String)

    New audience value.



244
245
246
# File 'lib/google/cloud/pubsub/subscription/push_config.rb', line 244

def audience= new_audience
  @grpc.audience = new_audience
end

#emailString

The service account email to be used for generating the OIDC token. The caller must have the iam.serviceAccounts.actAs permission for the service account.

Returns:

  • (String)


213
214
215
# File 'lib/google/cloud/pubsub/subscription/push_config.rb', line 213

def email
  @grpc.
end

#email=(new_email) ⇒ Object

Sets the service account email to be used for generating the OIDC token. The caller must have the iam.serviceAccounts.actAs permission for the service account.

Parameters:

  • new_email (String)

    New service account email value.



222
223
224
# File 'lib/google/cloud/pubsub/subscription/push_config.rb', line 222

def email= new_email
  @grpc. = new_email
end