Interface InstructionOrBuilder (0.174.0)

public interface InstructionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBlockingResources(int index)

public abstract String getBlockingResources(int index)

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

repeated string blocking_resources = 10;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The blockingResources at the given index.

getBlockingResourcesBytes(int index)

public abstract ByteString getBlockingResourcesBytes(int index)

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

repeated string blocking_resources = 10;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the blockingResources at the given index.

getBlockingResourcesCount()

public abstract int getBlockingResourcesCount()

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

repeated string blocking_resources = 10;

Returns
Type Description
int

The count of blockingResources.

getBlockingResourcesList()

public abstract List<String> getBlockingResourcesList()

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

repeated string blocking_resources = 10;

Returns
Type Description
List<String>

A list containing the blockingResources.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Creation time of instruction.

.google.protobuf.Timestamp create_time = 4;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time of instruction.

.google.protobuf.Timestamp create_time = 4;

Returns
Type Description
TimestampOrBuilder

getCsvInstruction() (deprecated)

public abstract CsvInstruction getCsvInstruction()

Deprecated. google.cloud.datalabeling.v1beta1.Instruction.csv_instruction is deprecated. See google/cloud/datalabeling/v1beta1/instruction.proto;l=64

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.

.google.cloud.datalabeling.v1beta1.CsvInstruction csv_instruction = 7 [deprecated = true];

Returns
Type Description
CsvInstruction

The csvInstruction.

getCsvInstructionOrBuilder() (deprecated)

public abstract CsvInstructionOrBuilder getCsvInstructionOrBuilder()

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.

.google.cloud.datalabeling.v1beta1.CsvInstruction csv_instruction = 7 [deprecated = true];

Returns
Type Description
CsvInstructionOrBuilder

getDataType()

public abstract DataType getDataType()

Required. The data type of this instruction.

.google.cloud.datalabeling.v1beta1.DataType data_type = 6;

Returns
Type Description
DataType

The dataType.

getDataTypeValue()

public abstract int getDataTypeValue()

Required. The data type of this instruction.

.google.cloud.datalabeling.v1beta1.DataType data_type = 6;

Returns
Type Description
int

The enum numeric value on the wire for dataType.

getDescription()

public abstract String getDescription()

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

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

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

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public abstract String getName()

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getPdfInstruction()

public abstract PdfInstruction getPdfInstruction()

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

.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;

Returns
Type Description
PdfInstruction

The pdfInstruction.

getPdfInstructionOrBuilder()

public abstract PdfInstructionOrBuilder getPdfInstructionOrBuilder()

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

.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;

Returns
Type Description
PdfInstructionOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Last update time of instruction.

.google.protobuf.Timestamp update_time = 5;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Last update time of instruction.

.google.protobuf.Timestamp update_time = 5;

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Creation time of instruction.

.google.protobuf.Timestamp create_time = 4;

Returns
Type Description
boolean

Whether the createTime field is set.

hasCsvInstruction() (deprecated)

public abstract boolean hasCsvInstruction()

Deprecated. google.cloud.datalabeling.v1beta1.Instruction.csv_instruction is deprecated. See google/cloud/datalabeling/v1beta1/instruction.proto;l=64

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.

.google.cloud.datalabeling.v1beta1.CsvInstruction csv_instruction = 7 [deprecated = true];

Returns
Type Description
boolean

Whether the csvInstruction field is set.

hasPdfInstruction()

public abstract boolean hasPdfInstruction()

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

.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;

Returns
Type Description
boolean

Whether the pdfInstruction field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Last update time of instruction.

.google.protobuf.Timestamp update_time = 5;

Returns
Type Description
boolean

Whether the updateTime field is set.