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

Creates a new catalog.

Args:
  parent: string, Required. The parent resource where this catalog will be created. Format: projects/{project_id_or_number}/locations/{location_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Catalog is the container of databases.
  "createTime": "A String", # Output only. The creation time of the catalog.
  "deleteTime": "A String", # Output only. The deletion time of the catalog. Only set after the catalog is deleted.
  "expireTime": "A String", # Output only. The time when this catalog is considered expired. Only set after the catalog is deleted.
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
  "updateTime": "A String", # Output only. The last modification time of the catalog.
}

  catalogId: string, Required. The ID to use for the catalog, which will become the final component of the catalog's resource name.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Catalog is the container of databases.
  "createTime": "A String", # Output only. The creation time of the catalog.
  "deleteTime": "A String", # Output only. The deletion time of the catalog. Only set after the catalog is deleted.
  "expireTime": "A String", # Output only. The time when this catalog is considered expired. Only set after the catalog is deleted.
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
  "updateTime": "A String", # Output only. The last modification time of the catalog.
}

delete(name, x__xgafv=None)

Deletes an existing catalog specified by the catalog ID.

Args:
  name: string, Required. The name of the catalog to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Catalog is the container of databases.
  "createTime": "A String", # Output only. The creation time of the catalog.
  "deleteTime": "A String", # Output only. The deletion time of the catalog. Only set after the catalog is deleted.
  "expireTime": "A String", # Output only. The time when this catalog is considered expired. Only set after the catalog is deleted.
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
  "updateTime": "A String", # Output only. The last modification time of the catalog.
}

get(name, x__xgafv=None)

Gets the catalog specified by the resource name.

Args:
  name: string, Required. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Catalog is the container of databases.
  "createTime": "A String", # Output only. The creation time of the catalog.
  "deleteTime": "A String", # Output only. The deletion time of the catalog. Only set after the catalog is deleted.
  "expireTime": "A String", # Output only. The time when this catalog is considered expired. Only set after the catalog is deleted.
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
  "updateTime": "A String", # Output only. The last modification time of the catalog.
}

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

List all catalogs in a specified project.

Args:
  parent: string, Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{location_id} (required)
  pageSize: integer, The maximum number of catalogs to return. The service may return fewer than this value. If unspecified, at most 50 catalogs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCatalogs` 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:

    { # Response message for the ListCatalogs method.
  "catalogs": [ # The catalogs from the specified project.
    { # Catalog is the container of databases.
      "createTime": "A String", # Output only. The creation time of the catalog.
      "deleteTime": "A String", # Output only. The deletion time of the catalog. Only set after the catalog is deleted.
      "expireTime": "A String", # Output only. The time when this catalog is considered expired. Only set after the catalog is deleted.
      "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
      "updateTime": "A String", # Output only. The last modification time of the catalog.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

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.

BigLake API . projects . locations . catalogs

Instance Methods

Method Details