close()

Close httplib2 connections.

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

Initializes a MetadataStore, including allocation of resources.

Args:
parent: string, Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/` (required)
body: object, The request body.
The object takes the form of:

{ # Instance of a metadata store. Contains a set of metadata that can be queried.
"createTime": "A String", # Output only. Timestamp when this MetadataStore was created.
"dataplexConfig": { # Represents Dataplex integration settings. # Optional. Dataplex integration settings.
"enabledPipelinesLineage": True or False, # Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines.
},
"description": "A String", # Description of the MetadataStore.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"name": "A String", # Output only. The resource name of the MetadataStore instance.
"state": { # Represents state information for a MetadataStore. # Output only. State information of the MetadataStore.
"diskUtilizationBytes": "A String", # The disk utilization of the MetadataStore in bytes.
},
"updateTime": "A String", # Output only. Timestamp when this MetadataStore was last updated.
}

metadataStoreId: string, The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

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

Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).

Args:
name: string, Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required)
force: boolean, Deprecated: Field is no longer supported.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Retrieves a specific MetadataStore.

Args:
  name: string, Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Instance of a metadata store. Contains a set of metadata that can be queried.
  "createTime": "A String", # Output only. Timestamp when this MetadataStore was created.
  "dataplexConfig": { # Represents Dataplex integration settings. # Optional. Dataplex integration settings.
    "enabledPipelinesLineage": True or False, # Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines.
  },
  "description": "A String", # Description of the MetadataStore.
  "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.
    "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
  },
  "name": "A String", # Output only. The resource name of the MetadataStore instance.
  "state": { # Represents state information for a MetadataStore. # Output only. State information of the MetadataStore.
    "diskUtilizationBytes": "A String", # The disk utilization of the MetadataStore in bytes.
  },
  "updateTime": "A String", # Output only. Timestamp when this MetadataStore was last updated.
}

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

Lists MetadataStores for a Location.

Args:
  parent: string, Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}` (required)
  pageSize: integer, The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
  pageToken: string, A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)
  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 MetadataService.ListMetadataStores.
  "metadataStores": [ # The MetadataStores found for the Location.
    { # Instance of a metadata store. Contains a set of metadata that can be queried.
      "createTime": "A String", # Output only. Timestamp when this MetadataStore was created.
      "dataplexConfig": { # Represents Dataplex integration settings. # Optional. Dataplex integration settings.
        "enabledPipelinesLineage": True or False, # Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines.
      },
      "description": "A String", # Description of the MetadataStore.
      "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.
        "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
      },
      "name": "A String", # Output only. The resource name of the MetadataStore instance.
      "state": { # Represents state information for a MetadataStore. # Output only. State information of the MetadataStore.
        "diskUtilizationBytes": "A String", # The disk utilization of the MetadataStore in bytes.
      },
      "updateTime": "A String", # Output only. Timestamp when this MetadataStore was last updated.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as ListMetadataStoresRequest.page_token to retrieve the next page. If this field is not populated, 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.

Vertex AI API . projects . locations . metadataStores

Instance Methods

Method Details