Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ExportDataConfig.
Describes what part of the Dataset is to be exported, the destination of the export and how to export.
Generated from protobuf message google.cloud.aiplatform.v1.ExportDataConfig
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ gcs_destination |
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: |
↳ fraction_split |
ExportFractionSplit
Split based on fractions defining the size of each set. |
↳ filter_split |
ExportFilterSplit
Split based on the provided filters for each set. |
↳ annotations_filter |
string
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 |
string
The ID of a SavedQuery (annotation set) under the Dataset specified by ExportDataRequest.name 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 |
string
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. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset specified by ExportDataRequest.name. Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri. |
↳ export_use |
int
Indicates the usage of the exported files. |
getGcsDestination
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-<dataset-display-name>-<timestamp-of-export-call> 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.
| Returns | |
|---|---|
| Type | Description |
GcsDestination|null |
|
hasGcsDestination
setGcsDestination
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-<dataset-display-name>-<timestamp-of-export-call> 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.
| Parameter | |
|---|---|
| Name | Description |
var |
GcsDestination
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFractionSplit
Split based on fractions defining the size of each set.
| Returns | |
|---|---|
| Type | Description |
ExportFractionSplit|null |
|
hasFractionSplit
setFractionSplit
Split based on fractions defining the size of each set.
| Parameter | |
|---|---|
| Name | Description |
var |
ExportFractionSplit
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilterSplit
Split based on the provided filters for each set.
| Returns | |
|---|---|
| Type | Description |
ExportFilterSplit|null |
|
hasFilterSplit
setFilterSplit
Split based on the provided filters for each set.
| Parameter | |
|---|---|
| Name | Description |
var |
ExportFilterSplit
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotationsFilter
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAnnotationsFilter
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSavedQueryId
The ID of a SavedQuery (annotation set) under the Dataset specified by ExportDataRequest.name 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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSavedQueryId
The ID of a SavedQuery (annotation set) under the Dataset specified by ExportDataRequest.name 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotationSchemaUri
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.
The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset specified by ExportDataRequest.name. Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAnnotationSchemaUri
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.
The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset specified by ExportDataRequest.name. Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExportUse
Indicates the usage of the exported files.
| Returns | |
|---|---|
| Type | Description |
int |
|
setExportUse
Indicates the usage of the exported files.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDestination
| Returns | |
|---|---|
| Type | Description |
string |
|
getSplit
| Returns | |
|---|---|
| Type | Description |
string |
|