Google Cloud Shell V1 Client - Class AuthorizeEnvironmentRequest (1.0.4)

Reference documentation and code samples for the Google Cloud Shell V1 Client class AuthorizeEnvironmentRequest.

Request message for AuthorizeEnvironment.

Generated from protobuf message google.cloud.shell.v1.AuthorizeEnvironmentRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Name of the resource that should receive the credentials, for example users/me/environments/default or users/someone@example.com/environments/default.

↳ access_token string

The OAuth access token that should be sent to the environment.

↳ id_token string

The OAuth ID token that should be sent to the environment.

↳ expire_time Google\Protobuf\Timestamp

The time when the credentials expire. If not set, defaults to one hour from when the server received the request.

getName

Name of the resource that should receive the credentials, for example users/me/environments/default or users/someone@example.com/environments/default.

Returns
TypeDescription
string

setName

Name of the resource that should receive the credentials, for example users/me/environments/default or users/someone@example.com/environments/default.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAccessToken

The OAuth access token that should be sent to the environment.

Returns
TypeDescription
string

setAccessToken

The OAuth access token that should be sent to the environment.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIdToken

The OAuth ID token that should be sent to the environment.

Returns
TypeDescription
string

setIdToken

The OAuth ID token that should be sent to the environment.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getExpireTime

The time when the credentials expire. If not set, defaults to one hour from when the server received the request.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasExpireTime

clearExpireTime

setExpireTime

The time when the credentials expire. If not set, defaults to one hour from when the server received the request.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this