Get
|
|||||
|
|
||||
Get the template associated with a template
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
- View your Google Compute Engine resources
- View your email address
Input
This building block consumes 4 input parameters
| Name | Format | Description |
|---|---|---|
projectId Required |
STRING |
Required. The ID of the Cloud Platform project that the job belongs to |
view |
ENUMERATION |
The view to retrieve. Defaults to METADATA_ONLY |
gcsPath |
STRING |
Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://' |
location |
STRING |
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request |
= Parameter name
= Format
|
projectId STRING Required Required. The ID of the Cloud Platform project that the job belongs to |
|
view ENUMERATION The view to retrieve. Defaults to METADATA_ONLY |
|
gcsPath STRING Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://' |
|
location STRING The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request |
Output
This building block provides 14 output parameters
| Name | Format | Description |
|---|---|---|
metadata |
OBJECT |
Metadata describing a template |
metadata.name |
STRING |
Required. The name of the template |
metadata.parameters[] |
OBJECT |
Metadata for a specific parameter |
metadata.parameters[].name |
STRING |
Required. The name of the parameter |
metadata.parameters[].regexes[] |
STRING |
|
metadata.parameters[].label |
STRING |
Required. The label to display for the parameter |
metadata.parameters[].helpText |
STRING |
Required. The help text to display for the parameter |
metadata.parameters[].isOptional |
BOOLEAN |
Optional. Whether the parameter is optional. Defaults to false |
metadata.description |
STRING |
Optional. A description of the template |
status |
OBJECT |
The You can find out more about this error model and how to work with it in the API Design Guide |
status.details[] |
OBJECT |
|
status.details[].customKey.value |
ANY |
|
status.code |
INTEGER |
The status code, which should be an enum value of google.rpc.Code |
status.message |
STRING |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client |
= Parameter name
= Format
|
metadata OBJECT Metadata describing a template |
|
metadata.name STRING Required. The name of the template |
|
metadata.parameters[] OBJECT Metadata for a specific parameter |
|
metadata.parameters[].name STRING Required. The name of the parameter |
|
metadata.parameters[].regexes[] STRING |
|
metadata.parameters[].label STRING Required. The label to display for the parameter |
|
metadata.parameters[].helpText STRING Required. The help text to display for the parameter |
|
metadata.parameters[].isOptional BOOLEAN Optional. Whether the parameter is optional. Defaults to false |
|
metadata.description STRING Optional. A description of the template |
|
status OBJECT The You can find out more about this error model and how to work with it in the API Design Guide |
|
status.details[] OBJECT |
|
status.details[].customKey.value ANY |
|
status.code INTEGER The status code, which should be an enum value of google.rpc.Code |
|
status.message STRING A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client |