Cloud Scheduler V1 Client - Class OAuthToken (2.0.0-RC1)

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

Contains information needed for generating an OAuth token.

This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

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

Namespace

Google \ Cloud \ Scheduler \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ service_account_email string

Service account email to be used for generating OAuth 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.

↳ scope string

OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

getServiceAccountEmail

Service account email to be used for generating OAuth 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.

Returns
Type Description
string

setServiceAccountEmail

Service account email to be used for generating OAuth 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.

Parameter
Name Description
var string
Returns
Type Description
$this

getScope

OAuth scope to be used for generating OAuth access token.

If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

Returns
Type Description
string

setScope

OAuth scope to be used for generating OAuth access token.

If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

Parameter
Name Description
var string
Returns
Type Description
$this