Cloud Scheduler V1 Client - Class OidcToken (1.6.8)

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

Contains information needed for generating an OpenID Connect token.

This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

Generated from protobuf message google.cloud.scheduler.v1.OidcToken

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ service_account_email string

Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.

↳ audience string

Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

getServiceAccountEmail

Service account email to be used for generating OIDC token.

The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.

Generated from protobuf field string service_account_email = 1;

Returns
TypeDescription
string

setServiceAccountEmail

Service account email to be used for generating OIDC token.

The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.

Generated from protobuf field string service_account_email = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAudience

Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

Generated from protobuf field string audience = 2;

Returns
TypeDescription
string

setAudience

Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

Generated from protobuf field string audience = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this