Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class ExportDataRequest.
Request message for ExportData API.
Generated from protobuf message google.cloud.datalabeling.v1beta1.ExportDataRequest
Namespace
Google \ Cloud \ DataLabeling \ V1beta1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} |
↳ annotated_dataset |
string
Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id} |
↳ filter |
string
Optional. Filter is not supported at this moment. |
↳ output_config |
OutputConfig
Required. Specify the output destination. |
↳ user_email_address |
string
Email of the user who started the export task and should be notified by email. If empty no notification will be sent. |
getName
Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotatedDataset
Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setAnnotatedDataset
Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. Filter is not supported at this moment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Filter is not supported at this moment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOutputConfig
Required. Specify the output destination.
| Returns | |
|---|---|
| Type | Description |
OutputConfig|null |
|
hasOutputConfig
clearOutputConfig
setOutputConfig
Required. Specify the output destination.
| Parameter | |
|---|---|
| Name | Description |
var |
OutputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserEmailAddress
Email of the user who started the export task and should be notified by email. If empty no notification will be sent.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUserEmailAddress
Email of the user who started the export task and should be notified by email. If empty no notification will be sent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} Please see DataLabelingServiceClient::datasetName() for help formatting this field. |
annotatedDataset |
string
Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id} Please see DataLabelingServiceClient::annotatedDatasetName() for help formatting this field. |
filter |
string
Optional. Filter is not supported at this moment. |
outputConfig |
OutputConfig
Required. Specify the output destination. |
| Returns | |
|---|---|
| Type | Description |
ExportDataRequest |
|