Data pipelines API (datapipelines:v1)

2022-11-16

3 new methods

Additions

    Methods
  • datapipelines.projects.locations.computeSchema

      Parameters:

        location

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Description: Required. The full location formatted as "projects/{your-project}/locations/{google-cloud-region}". If attempting to infer the schema from an existing Google Cloud resource, the default Data Pipelines service account for this project will be used in making requests for the resource. If the region given for "{google-cloud-region}" is different than the region where the resource is stored, then the data will be transferred to and processed in the region specified here, but it will not be persistently stored in this region.

          Required: Yes

          Type: string

          Location: path

      Description: Computes the schema for the transform. Computation from `raw_schema` will always occur if it is set. This requires that the transform supports that encoding. If no raw schema is provided and if the transform is for an IO, then this will attempt to connect to the resource using the details provided in `config` and infer the schema from that. If the transform is not an IO, is a sink that doesn't exist yet, or is a sink with no schema requirement, then this will fall back to basing the schema off the one provided in `input_schemas`. The computed schema will be validated.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

      Parameter Order: location

      Path: v1/{+location}:computeSchema

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}:computeSchema

  • datapipelines.projects.locations.transformDescriptions.batchGet

      HTTP Method: GET

      Path: v1/{+parent}/transformDescriptions:batchGet

      Description: Gets transform descriptions in a batch, associated with a list of provided uniform resource names.

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transformDescriptions:batchGet

      Parameters:

        parent

          Type: string

          Description: Required. The project and location shared by all transform descriptions being retrieved, formatted as "projects/{project}/locations/{location}".

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Required: Yes

          Location: path

        names

          Description: Optional. The names of the transform descriptions being retrieved, formatted as "projects/{project}/locations/{location}/transformdescriptions/{transform_description}". If no name is provided, all of the transform descriptions will be returned.

          Repeated: Yes

          Type: string

          Location: query

  • datapipelines.projects.locations.transformDescriptions.get

      Description: Gets the transform description associated with the provided uniform resource name.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: GET

      Path: v1/{+name}

      Parameters:

        name

          Required: Yes

          Location: path

          Type: string

          Description: Required. The full name formatted as "projects/{your-project}/locations/{google-cloud-region}/transformdescriptions/{uniform-resource-name}".

          Pattern: ^projects/[^/]+/locations/[^/]+/transformDescriptions/[^/]+$

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transformDescriptions/{transformDescriptionsId}