Google Cloud Datalabeling V1beta1 Client - Class ExportDataRequest (0.2.0)

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

Methods

build

Parameters
NameDescription
name string

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} Please see {@see \Google\Cloud\DataLabeling\V1beta1\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 {@see \Google\Cloud\DataLabeling\V1beta1\DataLabelingServiceClient::annotatedDatasetName()} for help formatting this field.

filter string

Optional. Filter is not supported at this moment.

outputConfig Google\Cloud\DataLabeling\V1beta1\OutputConfig

Required. Specify the output destination.

Returns
TypeDescription
Google\Cloud\DataLabeling\V1beta1\ExportDataRequest

__construct

Constructor.

Parameters
NameDescription
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 Google\Cloud\DataLabeling\V1beta1\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
TypeDescription
string

setName

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Optional. Filter is not supported at this moment.

Returns
TypeDescription
string

setFilter

Optional. Filter is not supported at this moment.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOutputConfig

Required. Specify the output destination.

Returns
TypeDescription
Google\Cloud\DataLabeling\V1beta1\OutputConfig|null

hasOutputConfig

clearOutputConfig

setOutputConfig

Required. Specify the output destination.

Parameter
NameDescription
var Google\Cloud\DataLabeling\V1beta1\OutputConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this