Data pipelines API . projects . locations . transformDescriptions

Instance Methods

batchGet(parent, names=None, x__xgafv=None)

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

close()

Close httplib2 connections.

get(name, x__xgafv=None)

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

Method Details

batchGet(parent, names=None, x__xgafv=None)
Gets transform descriptions in a batch, associated with a list of provided uniform resource names.

Args:
  parent: string, Required. The project and location shared by all transform descriptions being retrieved, formatted as "projects/{project}/locations/{location}". (required)
  names: string, 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)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for BatchGetTransformDescriptions
  "transformDescriptions": [ # List of requested transform descriptions.
    { # Description of a schema-aware transform, which provides info on how it can be configured.
      "name": "A String", # Output only. The full name of this resource formatted as: projects/{project}/locations/{location}/transformDescriptions/{transform_description} `transform_description` is the same as the `uniform_resource_name` field.
      "options": { # Represents a simplified Apache Beam schema. # Available options for configuring the transform.
        "fields": [ # Fields in the schema. Every field within a schema must have a unique name.
          { # Info for a single field in the schema.
            "name": "A String", # Name of the field.
            "type": { # Type info about a field. # Type info for the field.
              "collectionElementType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # If `type` is an array or iterable, this is the type contained in that array or iterable.
              "logicalType": { # Represents the input for creating a specified logical type. # If `type` is a logical type, this is the info for the specific logical type.
                "enumerationType": { # Represents the Beam EnumerationType logical type. # The enum represented by this logical type.
                  "values": [ # Names of the values. The numeric value is the same as the index.
                    "A String",
                  ],
                },
                "fixedBytes": { # Represents the Beam FixedBytes logical type. # The fixed-size byte collection represented by this logical type.
                  "sizeBytes": 42, # Number of bytes to allocate.
                },
              },
              "mapType": { # Represents a map in a schema. # If `type` is a map, this is the key and value types for that map.
                "mapKeyType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Key type of the map. Only atomic types are supported.
                "mapValueType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Value type of the map.
              },
              "nullable": True or False, # Whether or not this field is nullable.
              "rowSchema": # Object with schema name: GoogleCloudDatapipelinesV1Schema # If `type` is a row, this is the schema of that row.
              "type": "A String", # Specific type of the field. For non-atomic types, the corresponding type info for that non-atomic must be set.
            },
          },
        ],
        "referenceId": "A String", # An identifier of the schema for looking it up in a repository. This only needs to be set if the schema is stored in a repository.
      },
      "uniformResourceName": "A String", # Unique resource name of the transform.
    },
  ],
}
close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets the transform description associated with the provided uniform resource name.

Args:
  name: string, Required. The full name formatted as "projects/{your-project}/locations/{google-cloud-region}/transformdescriptions/{uniform-resource-name}". (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Description of a schema-aware transform, which provides info on how it can be configured.
  "name": "A String", # Output only. The full name of this resource formatted as: projects/{project}/locations/{location}/transformDescriptions/{transform_description} `transform_description` is the same as the `uniform_resource_name` field.
  "options": { # Represents a simplified Apache Beam schema. # Available options for configuring the transform.
    "fields": [ # Fields in the schema. Every field within a schema must have a unique name.
      { # Info for a single field in the schema.
        "name": "A String", # Name of the field.
        "type": { # Type info about a field. # Type info for the field.
          "collectionElementType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # If `type` is an array or iterable, this is the type contained in that array or iterable.
          "logicalType": { # Represents the input for creating a specified logical type. # If `type` is a logical type, this is the info for the specific logical type.
            "enumerationType": { # Represents the Beam EnumerationType logical type. # The enum represented by this logical type.
              "values": [ # Names of the values. The numeric value is the same as the index.
                "A String",
              ],
            },
            "fixedBytes": { # Represents the Beam FixedBytes logical type. # The fixed-size byte collection represented by this logical type.
              "sizeBytes": 42, # Number of bytes to allocate.
            },
          },
          "mapType": { # Represents a map in a schema. # If `type` is a map, this is the key and value types for that map.
            "mapKeyType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Key type of the map. Only atomic types are supported.
            "mapValueType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Value type of the map.
          },
          "nullable": True or False, # Whether or not this field is nullable.
          "rowSchema": # Object with schema name: GoogleCloudDatapipelinesV1Schema # If `type` is a row, this is the schema of that row.
          "type": "A String", # Specific type of the field. For non-atomic types, the corresponding type info for that non-atomic must be set.
        },
      },
    ],
    "referenceId": "A String", # An identifier of the schema for looking it up in a repository. This only needs to be set if the schema is stored in a repository.
  },
  "uniformResourceName": "A String", # Unique resource name of the transform.
}