Vertex AI API . projects . locations . metadataStores . metadataSchemas

close()

Close httplib2 connections.

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

Creates a MetadataSchema.

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

{ # Instance of a general MetadataSchema.
  "createTime": "A String", # Output only. Timestamp when this MetadataSchema was created.
  "description": "A String", # Description of the Metadata Schema
  "name": "A String", # Output only. The resource name of the MetadataSchema.
  "schema": "A String", # Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by `title` in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 [MetadataSchema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
  "schemaType": "A String", # The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
  "schemaVersion": "A String", # The version of the MetadataSchema. The version's format must match the following regular expression: `^[0-9]+.+.+$`, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
}

  metadataSchemaId: string, The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` 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 MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
  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 general MetadataSchema.
  "createTime": "A String", # Output only. Timestamp when this MetadataSchema was created.
  "description": "A String", # Description of the Metadata Schema
  "name": "A String", # Output only. The resource name of the MetadataSchema.
  "schema": "A String", # Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by `title` in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 [MetadataSchema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
  "schemaType": "A String", # The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
  "schemaVersion": "A String", # The version of the MetadataSchema. The version's format must match the following regular expression: `^[0-9]+.+.+$`, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
}

get(name, x__xgafv=None)

Retrieves a specific MetadataSchema.

Args:
  name: string, Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` (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 general MetadataSchema.
  "createTime": "A String", # Output only. Timestamp when this MetadataSchema was created.
  "description": "A String", # Description of the Metadata Schema
  "name": "A String", # Output only. The resource name of the MetadataSchema.
  "schema": "A String", # Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by `title` in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 [MetadataSchema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
  "schemaType": "A String", # The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
  "schemaVersion": "A String", # The version of the MetadataSchema. The version's format must match the following regular expression: `^[0-9]+.+.+$`, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
}

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

Lists MetadataSchemas.

Args:
  parent: string, Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required)
  filter: string, A query to filter available MetadataSchemas for matching results.
  pageSize: integer, The maximum number of MetadataSchemas 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.ListMetadataSchemas call. Provide this to retrieve the next 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.ListMetadataSchemas.
  "metadataSchemas": [ # The MetadataSchemas found for the MetadataStore.
    { # Instance of a general MetadataSchema.
      "createTime": "A String", # Output only. Timestamp when this MetadataSchema was created.
      "description": "A String", # Description of the Metadata Schema
      "name": "A String", # Output only. The resource name of the MetadataSchema.
      "schema": "A String", # Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by `title` in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 [MetadataSchema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
      "schemaType": "A String", # The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
      "schemaVersion": "A String", # The version of the MetadataSchema. The version's format must match the following regular expression: `^[0-9]+.+.+$`, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as ListMetadataSchemasRequest.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.