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 | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Name of the resource that should receive the credentials, for example |
↳ 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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAccessToken
The OAuth access token that should be sent to the environment.
| Returns | |
|---|---|
| Type | Description |
string | |
setAccessToken
The OAuth access token that should be sent to the environment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIdToken
The OAuth ID token that should be sent to the environment.
| Returns | |
|---|---|
| Type | Description |
string | |
setIdToken
The OAuth ID token that should be sent to the environment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExpireTime
The time when the credentials expire. If not set, defaults to one hour from when the server received the request.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |