Dataflow API . projects . templateVersions

Instance Methods

list(parent=None, Format=None, Format, pageToken=None, pageSize=None, x__xgafv=None)

List TemplateVersions using project_id and an optional display_name field.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(parent=None, Format=None, Format, pageToken=None, pageSize=None, x__xgafv=None)
List TemplateVersions using project_id and an optional display_name field.
List all the TemplateVersions in the Template if display set.
List all the TemplateVersions in the Project if display_name not set.

Args:
  parent: string, parent includes project_id, and display_name is optional.

List by project_id(pid1) and display_name(tid1).
  Format: projects/{pid1}/catalogTemplates/{tid1}

List by project_id(pid1).
  Format: projects/{pid1} (required)
  pageToken: string, The page token, received from a previous ListTemplateVersions call.
Provide this to retrieve the subsequent page.
  pageSize: integer, The maximum number of TemplateVersions to return per page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Respond a list of TemplateVersions.
    "templateVersions": [ # A list of TemplateVersions.
      { # /////////////////////////////////////////////////////////////////////////////
          # //// Template Catalog is used to organize user TemplateVersions.
          # //// TemplateVersions that have the same project_id and display_name are
          # //// belong to the same Template.
          # //// Templates with the same project_id belong to the same Project.
          # //// TemplateVersion may have labels and multiple labels are allowed.
          # //// Duplicated labels in the same `TemplateVersion` are not allowed.
          # //// TemplateVersion may have tags and multiple tags are allowed. Duplicated
          # //// tags in the same `Template` are not allowed!
        "tags": [ # Alias for version_id, helps locate a TemplateVersion.
          "A String",
        ],
        "description": "A String", # Template description from the user.
        "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template.
        "createTime": "A String", # Creation time of this TemplateVersion.
        "labels": { # Labels for the Template Version. Labels can be duplicate within Template.
          "a_key": "A String",
        },
        "artifact": { # Job information for templates. # Job graph and metadata if it is a legacy Template.
            # Container image path and metadata if it is flex Template.
          "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template.
          "metadata": { # Metadata describing a template. # Metadata set for legacy Template.
            "parameters": [ # The parameters for the template.
              { # Metadata for a specific parameter.
                "label": "A String", # Required. The label to display for the parameter.
                "paramType": "A String", # Optional. The type of the parameter.
                    # Used for selecting input picker.
                "helpText": "A String", # Required. The help text to display for the parameter.
                "name": "A String", # Required. The name of the parameter.
                "regexes": [ # Optional. Regexes that the parameter must match.
                  "A String",
                ],
                "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
              },
            ],
            "name": "A String", # Required. The name of the template.
            "description": "A String", # Optional. A description of the template.
          },
          "containerSpec": { # Container Spec. # Container image path set for flex Template.
            "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules.
              "parameters": [ # The parameters for the template.
                { # Metadata for a specific parameter.
                  "label": "A String", # Required. The label to display for the parameter.
                  "paramType": "A String", # Optional. The type of the parameter.
                      # Used for selecting input picker.
                  "helpText": "A String", # Required. The help text to display for the parameter.
                  "name": "A String", # Required. The name of the parameter.
                  "regexes": [ # Optional. Regexes that the parameter must match.
                    "A String",
                  ],
                  "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
                },
              ],
              "name": "A String", # Required. The name of the template.
              "description": "A String", # Optional. A description of the template.
            },
            "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template.
              "language": "A String", # Required. The SDK Language.
              "version": "A String", # Optional. The SDK version.
            },
            "image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image
          },
        },
        "versionId": "A String", # An auto generated version_id for TemplateVersion.
        "type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact.
        "projectId": "A String", # A unique project_id. Multiple Templates per Project.
      },
    ],
    "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page.
        # If this field is omitted, there are no subsequent pages.
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.