Reference documentation and code samples for the Google Cloud Design Center V1 Client class PreviewApplicationRequest.
Message for previewing an application.
Generated from protobuf message google.cloud.designcenter.v1.PreviewApplicationRequest
Namespace
Google \ Cloud \ DesignCenter \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The application name in the following format: |
↳ worker_pool |
string
Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId} If this flag is omitted, the worker pool already defined on the application will be used. If no worker pool is defined on the application, the default Cloud Build worker pool is used. The worker pool must exist in the same region as the application. |
↳ service_account |
string
Optional. The email address of the service account to use for this preview operation. - If provided, this service account will be used to execute the preview process, taking precedence over any service_account specified on the Application resource. - The caller must have the 'iam.serviceAccounts.actAs' permission on this service account. - If this field is omitted, the system will use the 'service_account' defined within the Application resource. - We recommend that you provide a service account here or on the Application resource. If you don't provide a service account, the preview will fail. Format: projects/{PROJECT}/serviceAccounts/{EMAIL_ADDRESS} |
getName
Required. The application name in the following format:
projects/$project/locations/$location/spaces/$space/applications/$application
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The application name in the following format:
projects/$project/locations/$location/spaces/$space/applications/$application
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkerPool
Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId} If this flag is omitted, the worker pool already defined on the application will be used. If no worker pool is defined on the application, the default Cloud Build worker pool is used. The worker pool must exist in the same region as the application.
| Returns | |
|---|---|
| Type | Description |
string |
|
setWorkerPool
Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId} If this flag is omitted, the worker pool already defined on the application will be used. If no worker pool is defined on the application, the default Cloud Build worker pool is used. The worker pool must exist in the same region as the application.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceAccount
Optional. The email address of the service account to use for this preview operation.
- If provided, this service account will be used to execute the preview process, taking precedence over any service_account specified on the Application resource.
- The caller must have the 'iam.serviceAccounts.actAs' permission on this service account.
- If this field is omitted, the system will use the 'service_account' defined within the Application resource.
- We recommend that you provide a service account here or on the Application resource. If you don't provide a service account, the preview will fail. Format: projects/{PROJECT}/serviceAccounts/{EMAIL_ADDRESS}
| Returns | |
|---|---|
| Type | Description |
string |
|
setServiceAccount
Optional. The email address of the service account to use for this preview operation.
- If provided, this service account will be used to execute the preview process, taking precedence over any service_account specified on the Application resource.
- The caller must have the 'iam.serviceAccounts.actAs' permission on this service account.
- If this field is omitted, the system will use the 'service_account' defined within the Application resource.
- We recommend that you provide a service account here or on the Application resource. If you don't provide a service account, the preview will fail. Format: projects/{PROJECT}/serviceAccounts/{EMAIL_ADDRESS}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The application name in the following format:
|
| Returns | |
|---|---|
| Type | Description |
PreviewApplicationRequest |
|