Class ExportDataConfig (1.48.0)

ExportDataConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Describes what part of the Dataset is to be exported, the destination of the export and how to export.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
gcs_destination google.cloud.aiplatform_v1.types.GcsDestination
The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: export-data- where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations' schema title. Inside these sub directories, a schema.yaml will be created to describe the output format. This field is a member of oneof_ destination.
fraction_split google.cloud.aiplatform_v1.types.ExportFractionSplit
Split based on fractions defining the size of each set. This field is a member of oneof_ split.
filter_split google.cloud.aiplatform_v1.types.ExportFilterSplit
Split based on the provided filters for each set. This field is a member of oneof_ split.
annotations_filter str
An expression for filtering what part of the Dataset is to be exported. Only Annotations that match this filter will be exported. The filter syntax is the same as in ListAnnotations.
saved_query_id str
The ID of a SavedQuery (annotation set) under the Dataset specified by [dataset_id][] used for filtering Annotations for training. Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries. Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter. Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.
annotation_schema_uri str
The Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 `Schema Object
export_use google.cloud.aiplatform_v1.types.ExportDataConfig.ExportUse
Indicates the usage of the exported files.

Classes

ExportUse

ExportUse(value)

ExportUse indicates the usage of the exported files. It restricts file destination, format, annotations to be exported, whether to allow unannotated data to be exported and whether to clone files to temp Cloud Storage bucket.

Values: EXPORT_USE_UNSPECIFIED (0): Regular user export. CUSTOM_CODE_TRAINING (6): Export for custom code training.

Methods

ExportDataConfig

ExportDataConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Describes what part of the Dataset is to be exported, the destination of the export and how to export.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields