Cloud Translation V3 Client - Class ListExamplesRequest (2.0.3)

Reference documentation and code samples for the Cloud Translation V3 Client class ListExamplesRequest.

Request message for ListExamples.

Generated from protobuf message google.cloud.translation.v3.ListExamplesRequest

Namespace

Google \ Cloud \ Translate \ V3

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. Name of the parent dataset. In form of projects/{project-number-or-id}/locations/{location-id}/datasets/{dataset-id}

↳ filter
string

Optional. An expression for filtering the examples that will be returned. Example filter: * * usage=TRAIN

↳ page_size
int

Optional. Requested page size. The server can return fewer results than requested.

↳ page_token
string

Optional. A token identifying a page of results for the server to return. Typically obtained from next_page_token field in the response of a ListExamples call.

getParent

Required. Name of the parent dataset. In form of projects/{project-number-or-id}/locations/{location-id}/datasets/{dataset-id}

Returns
Type
Description
string

setParent

Required. Name of the parent dataset. In form of projects/{project-number-or-id}/locations/{location-id}/datasets/{dataset-id}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFilter

Optional. An expression for filtering the examples that will be returned.

Example filter:

  • usage=TRAIN
Returns
Type
Description
string

setFilter

Optional. An expression for filtering the examples that will be returned.

Example filter:

  • usage=TRAIN
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

Optional. Requested page size. The server can return fewer results than requested.

Returns
Type
Description
int

setPageSize

Optional. Requested page size. The server can return fewer results than requested.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

Optional. A token identifying a page of results for the server to return.

Typically obtained from next_page_token field in the response of a ListExamples call.

Returns
Type
Description
string

setPageToken

Optional. A token identifying a page of results for the server to return.

Typically obtained from next_page_token field in the response of a ListExamples call.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameter
Name
Description
parent
string

Required. Name of the parent dataset. In form of projects/{project-number-or-id}/locations/{location-id}/datasets/{dataset-id} Please see TranslationServiceClient::datasetName() for help formatting this field.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: