Cloud Dataplex API . projects . locations . lakes . contentitems

Instance Methods

close()

Close httplib2 connections.

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

Create a content.

delete(name, x__xgafv=None)

Delete a content.

get(name, view=None, x__xgafv=None)

Get a content resource.

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

List content.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)

Update a content. Only supports full resource update.

Method Details

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

Args:
  parent: string, Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Content represents a user-visible notebook or a sql script
  "createTime": "A String", # Output only. Content creation time.
  "dataText": "A String", # Required. Content data in string format.
  "description": "A String", # Optional. Description of the content.
  "labels": { # Optional. User defined labels for the content.
    "a_key": "A String",
  },
  "name": "A String", # Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
  "notebook": { # Configuration for Notebook content. # Notebook related configurations.
    "kernelType": "A String", # Required. Kernel Type of the notebook.
  },
  "path": "A String", # Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.
  "sqlScript": { # Configuration for the Sql Script content. # Sql Script related configurations.
    "engine": "A String", # Required. Query Engine to be used for the Sql Query.
  },
  "uid": "A String", # Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.
  "updateTime": "A String", # Output only. The time when the content was last updated.
}

  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:

    { # Content represents a user-visible notebook or a sql script
  "createTime": "A String", # Output only. Content creation time.
  "dataText": "A String", # Required. Content data in string format.
  "description": "A String", # Optional. Description of the content.
  "labels": { # Optional. User defined labels for the content.
    "a_key": "A String",
  },
  "name": "A String", # Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
  "notebook": { # Configuration for Notebook content. # Notebook related configurations.
    "kernelType": "A String", # Required. Kernel Type of the notebook.
  },
  "path": "A String", # Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.
  "sqlScript": { # Configuration for the Sql Script content. # Sql Script related configurations.
    "engine": "A String", # Required. Query Engine to be used for the Sql Query.
  },
  "uid": "A String", # Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.
  "updateTime": "A String", # Output only. The time when the content was last updated.
}
delete(name, x__xgafv=None)
Delete a content.

Args:
  name: string, Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} (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); }
}
get(name, view=None, x__xgafv=None)
Get a content resource.

Args:
  name: string, Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} (required)
  view: string, Optional. Specify content view to make a partial request.
    Allowed values
      CONTENT_VIEW_UNSPECIFIED - Content view not specified. Defaults to BASIC. The API will default to the BASIC view.
      BASIC - Will not return the data_text field.
      FULL - Returns the complete proto.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Content represents a user-visible notebook or a sql script
  "createTime": "A String", # Output only. Content creation time.
  "dataText": "A String", # Required. Content data in string format.
  "description": "A String", # Optional. Description of the content.
  "labels": { # Optional. User defined labels for the content.
    "a_key": "A String",
  },
  "name": "A String", # Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
  "notebook": { # Configuration for Notebook content. # Notebook related configurations.
    "kernelType": "A String", # Required. Kernel Type of the notebook.
  },
  "path": "A String", # Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.
  "sqlScript": { # Configuration for the Sql Script content. # Sql Script related configurations.
    "engine": "A String", # Required. Query Engine to be used for the Sql Query.
  },
  "uid": "A String", # Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.
  "updateTime": "A String", # Output only. The time when the content was last updated.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List content.

Args:
  parent: string, Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} (required)
  filter: string, Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 type = "NOTEBOOK" type = "SQL_SCRIPT"These restrictions can be coinjoined with AND, OR and NOT conjunctions.
  pageSize: integer, Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. Page token received from a previous ListContent call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListContent 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 content response.
  "content": [ # Content under the given parent lake.
    { # Content represents a user-visible notebook or a sql script
      "createTime": "A String", # Output only. Content creation time.
      "dataText": "A String", # Required. Content data in string format.
      "description": "A String", # Optional. Description of the content.
      "labels": { # Optional. User defined labels for the content.
        "a_key": "A String",
      },
      "name": "A String", # Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
      "notebook": { # Configuration for Notebook content. # Notebook related configurations.
        "kernelType": "A String", # Required. Kernel Type of the notebook.
      },
      "path": "A String", # Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.
      "sqlScript": { # Configuration for the Sql Script content. # Sql Script related configurations.
        "engine": "A String", # Required. Query Engine to be used for the Sql Query.
      },
      "uid": "A String", # Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.
      "updateTime": "A String", # Output only. The time when the content was last updated.
    },
  ],
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}
list_next()
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.
        
patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)
Update a content. Only supports full resource update.

Args:
  name: string, Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Content represents a user-visible notebook or a sql script
  "createTime": "A String", # Output only. Content creation time.
  "dataText": "A String", # Required. Content data in string format.
  "description": "A String", # Optional. Description of the content.
  "labels": { # Optional. User defined labels for the content.
    "a_key": "A String",
  },
  "name": "A String", # Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
  "notebook": { # Configuration for Notebook content. # Notebook related configurations.
    "kernelType": "A String", # Required. Kernel Type of the notebook.
  },
  "path": "A String", # Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.
  "sqlScript": { # Configuration for the Sql Script content. # Sql Script related configurations.
    "engine": "A String", # Required. Query Engine to be used for the Sql Query.
  },
  "uid": "A String", # Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.
  "updateTime": "A String", # Output only. The time when the content was last updated.
}

  updateMask: string, Required. Mask of fields to update.
  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:

    { # Content represents a user-visible notebook or a sql script
  "createTime": "A String", # Output only. Content creation time.
  "dataText": "A String", # Required. Content data in string format.
  "description": "A String", # Optional. Description of the content.
  "labels": { # Optional. User defined labels for the content.
    "a_key": "A String",
  },
  "name": "A String", # Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
  "notebook": { # Configuration for Notebook content. # Notebook related configurations.
    "kernelType": "A String", # Required. Kernel Type of the notebook.
  },
  "path": "A String", # Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.
  "sqlScript": { # Configuration for the Sql Script content. # Sql Script related configurations.
    "engine": "A String", # Required. Query Engine to be used for the Sql Query.
  },
  "uid": "A String", # Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.
  "updateTime": "A String", # Output only. The time when the content was last updated.
}