GetTemplateResponse

The response to a templates.get request.

JSON representation
{
  "status": {
    object(Status)
  },
  "metadata": {
    object(TemplateMetadata)
  }
}
Fields
status

object(Status)

The status of the get template request. Any problems with the request will be indicated in the error_details.

metadata

object(TemplateMetadata)

The template metadata describing the template name, available parameters, etc.

TemplateMetadata

Metadata describing a template.

JSON representation
{
  "name": string,
  "description": string,
  "parameters": [
    {
      object(ParameterMetadata)
    }
  ]
}
Fields
name

string

Required. The name of the template.

description

string

Optional. A description of the template.

parameters[]

object(ParameterMetadata)

The parameters for the template.

ParameterMetadata

Metadata for a specific parameter.

JSON representation
{
  "name": string,
  "label": string,
  "helpText": string,
  "isOptional": boolean,
  "regexes": [
    string
  ]
}
Fields
name

string

Required. The name of the parameter.

label

string

Required. The label to display for the parameter.

helpText

string

Required. The help text to display for the parameter.

isOptional

boolean

Optional. Whether the parameter is optional. Defaults to false.

regexes[]

string

Optional. Regexes that the parameter must match.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Dataflow
Need help? Visit our support page.