Google Cloud Datalabeling V1beta1 Client - Class Instruction (0.6.3)

Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class Instruction.

Instruction of how to perform the labeling task for human operators.

Currently only PDF instruction is supported.

Generated from protobuf message google.cloud.datalabeling.v1beta1.Instruction

Namespace

Google \ Cloud \ DataLabeling \ V1beta1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

↳ display_name
string

Required. The display name of the instruction. Maximum of 64 characters.

↳ description
string

Optional. User-provided description of the instruction. The description can be up to 10000 characters long.

↳ create_time
Google\Protobuf\Timestamp

Output only. Creation time of instruction.

↳ update_time
Google\Protobuf\Timestamp

Output only. Last update time of instruction.

↳ data_type
int

Required. The data type of this instruction.

↳ csv_instruction
CsvInstruction

Deprecated: this instruction format is not supported any more. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format: * * The first column is labeled data, such as an image reference, text. * * The second column is comma separated labels associated with data.

↳ pdf_instruction
PdfInstruction

Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.

↳ blocking_resources
array

Output only. The names of any related resources that are blocking changes to the instruction.

getName

Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

Returns
Type
Description
string

setName

Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Required. The display name of the instruction. Maximum of 64 characters.

Returns
Type
Description
string

setDisplayName

Required. The display name of the instruction. Maximum of 64 characters.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

Optional. User-provided description of the instruction.

The description can be up to 10000 characters long.

Returns
Type
Description
string

setDescription

Optional. User-provided description of the instruction.

The description can be up to 10000 characters long.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. Creation time of instruction.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time of instruction.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. Last update time of instruction.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last update time of instruction.

Parameter
Name
Description
Returns
Type
Description
$this

getDataType

Required. The data type of this instruction.

Returns
Type
Description
int

setDataType

Required. The data type of this instruction.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getCsvInstruction

Deprecated: this instruction format is not supported any more.

Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format:

  • The first column is labeled data, such as an image reference, text.
  • The second column is comma separated labels associated with data.
Returns
Type
Description

hasCsvInstruction

clearCsvInstruction

setCsvInstruction

Deprecated: this instruction format is not supported any more.

Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format:

  • The first column is labeled data, such as an image reference, text.
  • The second column is comma separated labels associated with data.
Parameter
Name
Description
Returns
Type
Description
$this

getPdfInstruction

Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.

Returns
Type
Description

hasPdfInstruction

clearPdfInstruction

setPdfInstruction

Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.

Parameter
Name
Description
Returns
Type
Description
$this

getBlockingResources

Output only. The names of any related resources that are blocking changes to the instruction.

Returns
Type
Description

setBlockingResources

Output only. The names of any related resources that are blocking changes to the instruction.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: