Dataflow API . projects . catalogTemplates

close()

Close httplib2 connections.

commit(name, body=None, x__xgafv=None)

Creates a new TemplateVersion (Important: not new Template) entry in the spanner table. Requires project_id and display_name (template).

Args:
  name: string, The location of the template, name includes project_id and display_name. Commit using project_id(pid1) and display_name(tid1). Format: projects/{pid1}/catalogTemplates/{tid1} (required)
  body: object, The request body.
    The object takes the form of:

{ # Commit will add a new TemplateVersion to an existing template.
  "templateVersion": { # ///////////////////////////////////////////////////////////////////////////// //// 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! # TemplateVersion obejct to create.
    "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.
      "containerSpec": { # Container Spec. # Container image path set for flex Template.
        "defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default runtime environment for the job.
          "additionalExperiments": [ # Additional experiment flags for the job.
            "A String",
          ],
          "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
            "a_key": "A String",
          },
          "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
          "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
          "ipConfiguration": "A String", # Configuration for VM IPs.
          "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
          "machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified.
          "maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
          "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
          "numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
          "serviceAccountEmail": "A String", # The email address of the service account to run the job as.
          "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.
          "tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
          "workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
          "workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
          "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
        },
        "image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image
        "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules.
          "description": "A String", # Optional. A description of the template.
          "name": "A String", # Required. The name of the template.
          "parameters": [ # The parameters for the template.
            { # Metadata for a specific parameter.
              "helpText": "A String", # Required. The help text to display for the parameter.
              "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
              "label": "A String", # Required. The label to display for the parameter.
              "name": "A String", # Required. The name of the parameter.
              "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
              "regexes": [ # Optional. Regexes that the parameter must match.
                "A String",
              ],
            },
          ],
        },
        "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template.
          "language": "A String", # Required. The SDK Language.
          "version": "A String", # Optional. The SDK version.
        },
      },
      "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template.
      "metadata": { # Metadata describing a template. # Metadata set for legacy Template.
        "description": "A String", # Optional. A description of the template.
        "name": "A String", # Required. The name of the template.
        "parameters": [ # The parameters for the template.
          { # Metadata for a specific parameter.
            "helpText": "A String", # Required. The help text to display for the parameter.
            "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
            "label": "A String", # Required. The label to display for the parameter.
            "name": "A String", # Required. The name of the parameter.
            "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
            "regexes": [ # Optional. Regexes that the parameter must match.
              "A String",
            ],
          },
        ],
      },
    },
    "createTime": "A String", # Creation time of this TemplateVersion.
    "description": "A String", # Template description from the user.
    "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template.
    "labels": { # Labels for the Template Version. Labels can be duplicate within Template.
      "a_key": "A String",
    },
    "projectId": "A String", # A unique project_id. Multiple Templates per Project.
    "tags": [ # Alias for version_id, helps locate a TemplateVersion.
      "A String",
    ],
    "type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact.
    "versionId": "A String", # An auto generated version_id for TemplateVersion.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ///////////////////////////////////////////////////////////////////////////// //// 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!
  "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.
    "containerSpec": { # Container Spec. # Container image path set for flex Template.
      "defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default runtime environment for the job.
        "additionalExperiments": [ # Additional experiment flags for the job.
          "A String",
        ],
        "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
          "a_key": "A String",
        },
        "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
        "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
        "ipConfiguration": "A String", # Configuration for VM IPs.
        "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
        "machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified.
        "maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
        "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
        "numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
        "serviceAccountEmail": "A String", # The email address of the service account to run the job as.
        "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.
        "tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
        "workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
        "workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
        "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
      },
      "image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image
      "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules.
        "description": "A String", # Optional. A description of the template.
        "name": "A String", # Required. The name of the template.
        "parameters": [ # The parameters for the template.
          { # Metadata for a specific parameter.
            "helpText": "A String", # Required. The help text to display for the parameter.
            "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
            "label": "A String", # Required. The label to display for the parameter.
            "name": "A String", # Required. The name of the parameter.
            "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
            "regexes": [ # Optional. Regexes that the parameter must match.
              "A String",
            ],
          },
        ],
      },
      "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template.
        "language": "A String", # Required. The SDK Language.
        "version": "A String", # Optional. The SDK version.
      },
    },
    "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template.
    "metadata": { # Metadata describing a template. # Metadata set for legacy Template.
      "description": "A String", # Optional. A description of the template.
      "name": "A String", # Required. The name of the template.
      "parameters": [ # The parameters for the template.
        { # Metadata for a specific parameter.
          "helpText": "A String", # Required. The help text to display for the parameter.
          "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
          "label": "A String", # Required. The label to display for the parameter.
          "name": "A String", # Required. The name of the parameter.
          "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
          "regexes": [ # Optional. Regexes that the parameter must match.
            "A String",
          ],
        },
      ],
    },
  },
  "createTime": "A String", # Creation time of this TemplateVersion.
  "description": "A String", # Template description from the user.
  "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template.
  "labels": { # Labels for the Template Version. Labels can be duplicate within Template.
    "a_key": "A String",
  },
  "projectId": "A String", # A unique project_id. Multiple Templates per Project.
  "tags": [ # Alias for version_id, helps locate a TemplateVersion.
    "A String",
  ],
  "type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact.
  "versionId": "A String", # An auto generated version_id for TemplateVersion.
}

delete(name, x__xgafv=None)

Deletes an existing Template. Do nothing if Template does not exist.

Args:
  name: string, name includes project_id and display_name. Delete by project_id(pid1) and display_name(tid1). Format: projects/{pid1}/catalogTemplates/{tid1} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}

get(name, x__xgafv=None)

Get TemplateVersion using project_id and display_name with an optional version_id field. Get latest (has tag "latest") TemplateVersion if version_id not set.

Args:
  name: string, Resource name includes project_id and display_name. version_id is optional. Get the latest TemplateVersion if version_id not set. Get by project_id(pid1) and display_name(tid1): Format: projects/{pid1}/catalogTemplates/{tid1} Get by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/{pid1}/catalogTemplates/{tid1@vid} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ///////////////////////////////////////////////////////////////////////////// //// 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!
  "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.
    "containerSpec": { # Container Spec. # Container image path set for flex Template.
      "defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default runtime environment for the job.
        "additionalExperiments": [ # Additional experiment flags for the job.
          "A String",
        ],
        "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
          "a_key": "A String",
        },
        "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
        "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
        "ipConfiguration": "A String", # Configuration for VM IPs.
        "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
        "machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified.
        "maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
        "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
        "numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
        "serviceAccountEmail": "A String", # The email address of the service account to run the job as.
        "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.
        "tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
        "workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
        "workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
        "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
      },
      "image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image
      "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules.
        "description": "A String", # Optional. A description of the template.
        "name": "A String", # Required. The name of the template.
        "parameters": [ # The parameters for the template.
          { # Metadata for a specific parameter.
            "helpText": "A String", # Required. The help text to display for the parameter.
            "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
            "label": "A String", # Required. The label to display for the parameter.
            "name": "A String", # Required. The name of the parameter.
            "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
            "regexes": [ # Optional. Regexes that the parameter must match.
              "A String",
            ],
          },
        ],
      },
      "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template.
        "language": "A String", # Required. The SDK Language.
        "version": "A String", # Optional. The SDK version.
      },
    },
    "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template.
    "metadata": { # Metadata describing a template. # Metadata set for legacy Template.
      "description": "A String", # Optional. A description of the template.
      "name": "A String", # Required. The name of the template.
      "parameters": [ # The parameters for the template.
        { # Metadata for a specific parameter.
          "helpText": "A String", # Required. The help text to display for the parameter.
          "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
          "label": "A String", # Required. The label to display for the parameter.
          "name": "A String", # Required. The name of the parameter.
          "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
          "regexes": [ # Optional. Regexes that the parameter must match.
            "A String",
          ],
        },
      ],
    },
  },
  "createTime": "A String", # Creation time of this TemplateVersion.
  "description": "A String", # Template description from the user.
  "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template.
  "labels": { # Labels for the Template Version. Labels can be duplicate within Template.
    "a_key": "A String",
  },
  "projectId": "A String", # A unique project_id. Multiple Templates per Project.
  "tags": [ # Alias for version_id, helps locate a TemplateVersion.
    "A String",
  ],
  "type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact.
  "versionId": "A String", # An auto generated version_id for TemplateVersion.
}

label(name, body=None, x__xgafv=None)

Updates the label of the TemplateVersion. Label can be duplicated in Template, so either add or remove the label in the TemplateVersion.

Args:
  name: string, Resource name includes project_id, display_name, and version_id. Updates by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/{pid1}/catalogTemplates/{tid1@vid} (required)
  body: object, The request body.
    The object takes the form of:

{ # Either add the label to TemplateVersion or remove it from the TemplateVersion.
  "key": "A String", # The label key for update.
  "op": "A String", # Requests for add label to TemplateVersion or remove label from TemplateVersion.
  "value": "A String", # The label value for update.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Respond the labels in the TemplateVersion.
  "labels": { # All the label in the TemplateVersion.
    "a_key": "A String",
  },
}

tag(name, body=None, x__xgafv=None)

Updates the tag of the TemplateVersion, and tag is unique in Template. If tag exists in another TemplateVersion in the Template, updates the tag to this TemplateVersion will remove it from the old TemplateVersion and add it to this TemplateVersion. If request is remove_only (remove_only = true), remove the tag from this TemplateVersion.

Args:
  name: string, Resource name includes project_id, display_name, and version_id. Updates by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/{pid1}/catalogTemplates/{tid1@vid} (required)
  body: object, The request body.
    The object takes the form of:

{ # Add a tag to the current TemplateVersion. If tag exist in another TemplateVersion in the Template, remove the tag before add it to the current TemplateVersion. If remove_only set, remove the tag from the current TemplateVersion.
  "removeOnly": True or False, # The flag that indicates if the request is only for remove tag from TemplateVersion.
  "tag": "A String", # The tag for update.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Respond the current tags in the TemplateVersion.
  "tags": [ # All the tags in the TemplateVersion.
    "A String",
  ],
}