Cloud Dataplex API . projects . locations . lakes . zones . entities . partitions

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, validateOnly=None, x__xgafv=None)

Create a metadata partition.

delete(name, etag=None, x__xgafv=None)

Delete a metadata partition.

get(name, x__xgafv=None)

Get a metadata partition of an entity.

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

List metadata partitions of an entity.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, validateOnly=None, x__xgafv=None)
Create a metadata partition.

Args:
  parent: string, Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents partition metadata contained within entity instances.
  "etag": "A String", # Optional. The etag for this partition.
  "location": "A String", # Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects//datasets//tables/
  "name": "A String", # Output only. The values must be HTML URL encoded two times before constructing the path. For example, if you have a value of "US:CA", encoded it two times and you get "US%253ACA". Then if you have the 2nd value is "CA#Sunnyvale", encoded two times and you get "CA%2523Sunnyvale". The partition values path is "US%253ACA/CA%2523Sunnyvale". The final URL will be "https://.../partitions/US%253ACA/CA%2523Sunnyvale". The name field in the responses will always have the encoded format.
  "values": [ # Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.
    "A String",
  ],
}

  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents partition metadata contained within entity instances.
  "etag": "A String", # Optional. The etag for this partition.
  "location": "A String", # Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects//datasets//tables/
  "name": "A String", # Output only. The values must be HTML URL encoded two times before constructing the path. For example, if you have a value of "US:CA", encoded it two times and you get "US%253ACA". Then if you have the 2nd value is "CA#Sunnyvale", encoded two times and you get "CA%2523Sunnyvale". The partition values path is "US%253ACA/CA%2523Sunnyvale". The final URL will be "https://.../partitions/US%253ACA/CA%2523Sunnyvale". The name field in the responses will always have the encoded format.
  "values": [ # Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.
    "A String",
  ],
}
delete(name, etag=None, x__xgafv=None)
Delete a metadata partition.

Args:
  name: string, Required. The resource name of the partition. format: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_value_path}. The {partition_value_path} segment consists of an ordered sequence of partition values separated by "/". All values must be provided. (required)
  etag: string, Optional. The etag associated with the partition if it was previously retrieved.
  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 a metadata partition of an entity.

Args:
  name: string, Required. The resource name of the partition: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_value_path}. The {partition_value_path} segment consists of an ordered sequence of partition values separated by "/". All values must be provided. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents partition metadata contained within entity instances.
  "etag": "A String", # Optional. The etag for this partition.
  "location": "A String", # Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects//datasets//tables/
  "name": "A String", # Output only. The values must be HTML URL encoded two times before constructing the path. For example, if you have a value of "US:CA", encoded it two times and you get "US%253ACA". Then if you have the 2nd value is "CA#Sunnyvale", encoded two times and you get "CA%2523Sunnyvale". The partition values path is "US%253ACA/CA%2523Sunnyvale". The final URL will be "https://.../partitions/US%253ACA/CA%2523Sunnyvale". The name field in the responses will always have the encoded format.
  "values": [ # Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.
    "A String",
  ],
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List metadata partitions of an entity.

Args:
  parent: string, Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. (required)
  filter: string, Optional. Filter the partitions returned to the caller using a key vslue pair expression. The filter expression supports: logical operators: AND, OR comparison operators: <, >, >=, <= ,=, != LIKE operators: The right hand of a LIKE operator supports “.” and “*” for wildcard searches, for example "value1 LIKE ".*oo.*" parenthetical grouping: ( )Sample filter expression: `?filter="key1 < value1 OR key2 > value2"Notes: Keys to the left of operators are case insensitive. Partition results are sorted first by creation time, then by lexicographic order. Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.
  pageSize: integer, Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500.
  pageToken: string, Optional. Page token received from a previous ListPartitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitions must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # List metadata partitions response.
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no remaining results in the list.
  "partitions": [ # Partitions under the specified parent entity.
    { # Represents partition metadata contained within entity instances.
      "etag": "A String", # Optional. The etag for this partition.
      "location": "A String", # Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects//datasets//tables/
      "name": "A String", # Output only. The values must be HTML URL encoded two times before constructing the path. For example, if you have a value of "US:CA", encoded it two times and you get "US%253ACA". Then if you have the 2nd value is "CA#Sunnyvale", encoded two times and you get "CA%2523Sunnyvale". The partition values path is "US%253ACA/CA%2523Sunnyvale". The final URL will be "https://.../partitions/US%253ACA/CA%2523Sunnyvale". The name field in the responses will always have the encoded format.
      "values": [ # Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.
        "A String",
      ],
    },
  ],
}
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.