- 0.173.0 (latest)
- 0.172.0
- 0.171.0
- 0.169.0
- 0.168.0
- 0.167.0
- 0.166.0
- 0.165.0
- 0.164.0
- 0.163.0
- 0.162.0
- 0.161.0
- 0.160.0
- 0.159.0
- 0.157.0
- 0.156.0
- 0.155.0
- 0.154.0
- 0.153.0
- 0.152.0
- 0.151.0
- 0.150.0
- 0.149.0
- 0.148.0
- 0.147.0
- 0.144.0
- 0.143.0
- 0.142.0
- 0.141.0
- 0.140.0
- 0.139.0
- 0.138.0
- 0.137.0
- 0.136.0
- 0.135.0
- 0.134.0
- 0.133.0
- 0.132.0
- 0.131.0
- 0.129.0
- 0.128.0
- 0.127.0
- 0.126.0
- 0.125.0
- 0.124.0
- 0.123.7
- 0.122.11
public static final class Instruction.Builder extends GeneratedMessageV3.Builder<Instruction.Builder> implements InstructionOrBuilder
Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.
Protobuf type google.cloud.datalabeling.v1beta1.Instruction
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Instruction.BuilderImplements
InstructionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addAllBlockingResources(Iterable<String> values)
public Instruction.Builder addAllBlockingResources(Iterable<String> values)
Output only. The names of any related resources that are blocking changes to the instruction.
repeated string blocking_resources = 10;
Name | Description |
values | Iterable<String> The blockingResources to add. |
Type | Description |
Instruction.Builder | This builder for chaining. |
addBlockingResources(String value)
public Instruction.Builder addBlockingResources(String value)
Output only. The names of any related resources that are blocking changes to the instruction.
repeated string blocking_resources = 10;
Name | Description |
value | String The blockingResources to add. |
Type | Description |
Instruction.Builder | This builder for chaining. |
addBlockingResourcesBytes(ByteString value)
public Instruction.Builder addBlockingResourcesBytes(ByteString value)
Output only. The names of any related resources that are blocking changes to the instruction.
repeated string blocking_resources = 10;
Name | Description |
value | ByteString The bytes of the blockingResources to add. |
Type | Description |
Instruction.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Instruction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
Instruction.Builder |
build()
public Instruction build()
Type | Description |
Instruction |
buildPartial()
public Instruction buildPartial()
Type | Description |
Instruction |
clear()
public Instruction.Builder clear()
Type | Description |
Instruction.Builder |
clearBlockingResources()
public Instruction.Builder clearBlockingResources()
Output only. The names of any related resources that are blocking changes to the instruction.
repeated string blocking_resources = 10;
Type | Description |
Instruction.Builder | This builder for chaining. |
clearCreateTime()
public Instruction.Builder clearCreateTime()
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
Type | Description |
Instruction.Builder |
clearCsvInstruction()
public Instruction.Builder clearCsvInstruction()
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];
Type | Description |
Instruction.Builder |
clearDataType()
public Instruction.Builder clearDataType()
Required. The data type of this instruction.
.google.cloud.datalabeling.v1beta1.DataType data_type = 6;
Type | Description |
Instruction.Builder | This builder for chaining. |
clearDescription()
public Instruction.Builder clearDescription()
Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
string description = 3;
Type | Description |
Instruction.Builder | This builder for chaining. |
clearDisplayName()
public Instruction.Builder clearDisplayName()
Required. The display name of the instruction. Maximum of 64 characters.
string display_name = 2;
Type | Description |
Instruction.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Instruction.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
Instruction.Builder |
clearName()
public Instruction.Builder clearName()
Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
string name = 1;
Type | Description |
Instruction.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Instruction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
Instruction.Builder |
clearPdfInstruction()
public Instruction.Builder clearPdfInstruction()
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
Type | Description |
Instruction.Builder |
clearUpdateTime()
public Instruction.Builder clearUpdateTime()
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
Type | Description |
Instruction.Builder |
clone()
public Instruction.Builder clone()
Type | Description |
Instruction.Builder |
getBlockingResources(int index)
public String getBlockingResources(int index)
Output only. The names of any related resources that are blocking changes to the instruction.
repeated string blocking_resources = 10;
Name | Description |
index | int The index of the element to return. |
Type | Description |
String | The blockingResources at the given index. |
getBlockingResourcesBytes(int index)
public ByteString getBlockingResourcesBytes(int index)
Output only. The names of any related resources that are blocking changes to the instruction.
repeated string blocking_resources = 10;
Name | Description |
index | int The index of the value to return. |
Type | Description |
ByteString | The bytes of the blockingResources at the given index. |
getBlockingResourcesCount()
public int getBlockingResourcesCount()
Output only. The names of any related resources that are blocking changes to the instruction.
repeated string blocking_resources = 10;
Type | Description |
int | The count of blockingResources. |
getBlockingResourcesList()
public ProtocolStringList getBlockingResourcesList()
Output only. The names of any related resources that are blocking changes to the instruction.
repeated string blocking_resources = 10;
Type | Description |
ProtocolStringList | A list containing the blockingResources. |
getCreateTime()
public Timestamp getCreateTime()
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
Type | Description |
Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
Type | Description |
TimestampOrBuilder |
getCsvInstruction()
public CsvInstruction 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.
.google.cloud.datalabeling.v1beta1.CsvInstruction csv_instruction = 7 [deprecated = true];
Type | Description |
CsvInstruction | The csvInstruction. |
getCsvInstructionBuilder()
public CsvInstruction.Builder getCsvInstructionBuilder()
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];
Type | Description |
CsvInstruction.Builder |
getCsvInstructionOrBuilder()
public 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];
Type | Description |
CsvInstructionOrBuilder |
getDataType()
public DataType getDataType()
Required. The data type of this instruction.
.google.cloud.datalabeling.v1beta1.DataType data_type = 6;
Type | Description |
DataType | The dataType. |
getDataTypeValue()
public int getDataTypeValue()
Required. The data type of this instruction.
.google.cloud.datalabeling.v1beta1.DataType data_type = 6;
Type | Description |
int | The enum numeric value on the wire for dataType. |
getDefaultInstanceForType()
public Instruction getDefaultInstanceForType()
Type | Description |
Instruction |
getDescription()
public String getDescription()
Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
string description = 3;
Type | Description |
String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
string description = 3;
Type | Description |
ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getDisplayName()
public String getDisplayName()
Required. The display name of the instruction. Maximum of 64 characters.
string display_name = 2;
Type | Description |
String | The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The display name of the instruction. Maximum of 64 characters.
string display_name = 2;
Type | Description |
ByteString | The bytes for displayName. |
getName()
public String getName()
Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
string name = 1;
Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()
Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
string name = 1;
Type | Description |
ByteString | The bytes for name. |
getPdfInstruction()
public PdfInstruction getPdfInstruction()
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
Type | Description |
PdfInstruction | The pdfInstruction. |
getPdfInstructionBuilder()
public PdfInstruction.Builder getPdfInstructionBuilder()
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
Type | Description |
PdfInstruction.Builder |
getPdfInstructionOrBuilder()
public PdfInstructionOrBuilder getPdfInstructionOrBuilder()
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
Type | Description |
PdfInstructionOrBuilder |
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
Type | Description |
Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
Type | Description |
Builder |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
Type | Description |
TimestampOrBuilder |
hasCreateTime()
public boolean hasCreateTime()
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
Type | Description |
boolean | Whether the createTime field is set. |
hasCsvInstruction()
public boolean hasCsvInstruction()
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];
Type | Description |
boolean | Whether the csvInstruction field is set. |
hasPdfInstruction()
public boolean hasPdfInstruction()
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
Type | Description |
boolean | Whether the pdfInstruction field is set. |
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public Instruction.Builder mergeCreateTime(Timestamp value)
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
Name | Description |
value | Timestamp |
Type | Description |
Instruction.Builder |
mergeCsvInstruction(CsvInstruction value)
public Instruction.Builder mergeCsvInstruction(CsvInstruction value)
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];
Name | Description |
value | CsvInstruction |
Type | Description |
Instruction.Builder |
mergeFrom(Instruction other)
public Instruction.Builder mergeFrom(Instruction other)
Name | Description |
other | Instruction |
Type | Description |
Instruction.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Instruction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Instruction.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public Instruction.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
Instruction.Builder |
mergePdfInstruction(PdfInstruction value)
public Instruction.Builder mergePdfInstruction(PdfInstruction value)
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
Name | Description |
value | PdfInstruction |
Type | Description |
Instruction.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Instruction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
Instruction.Builder |
mergeUpdateTime(Timestamp value)
public Instruction.Builder mergeUpdateTime(Timestamp value)
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
Name | Description |
value | Timestamp |
Type | Description |
Instruction.Builder |
setBlockingResources(int index, String value)
public Instruction.Builder setBlockingResources(int index, String value)
Output only. The names of any related resources that are blocking changes to the instruction.
repeated string blocking_resources = 10;
Name | Description |
index | int The index to set the value at. |
value | String The blockingResources to set. |
Type | Description |
Instruction.Builder | This builder for chaining. |
setCreateTime(Timestamp value)
public Instruction.Builder setCreateTime(Timestamp value)
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
Name | Description |
value | Timestamp |
Type | Description |
Instruction.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Instruction.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
Name | Description |
builderForValue | Builder |
Type | Description |
Instruction.Builder |
setCsvInstruction(CsvInstruction value)
public Instruction.Builder setCsvInstruction(CsvInstruction value)
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];
Name | Description |
value | CsvInstruction |
Type | Description |
Instruction.Builder |
setCsvInstruction(CsvInstruction.Builder builderForValue)
public Instruction.Builder setCsvInstruction(CsvInstruction.Builder builderForValue)
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];
Name | Description |
builderForValue | CsvInstruction.Builder |
Type | Description |
Instruction.Builder |
setDataType(DataType value)
public Instruction.Builder setDataType(DataType value)
Required. The data type of this instruction.
.google.cloud.datalabeling.v1beta1.DataType data_type = 6;
Name | Description |
value | DataType The dataType to set. |
Type | Description |
Instruction.Builder | This builder for chaining. |
setDataTypeValue(int value)
public Instruction.Builder setDataTypeValue(int value)
Required. The data type of this instruction.
.google.cloud.datalabeling.v1beta1.DataType data_type = 6;
Name | Description |
value | int The enum numeric value on the wire for dataType to set. |
Type | Description |
Instruction.Builder | This builder for chaining. |
setDescription(String value)
public Instruction.Builder setDescription(String value)
Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
string description = 3;
Name | Description |
value | String The description to set. |
Type | Description |
Instruction.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public Instruction.Builder setDescriptionBytes(ByteString value)
Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
string description = 3;
Name | Description |
value | ByteString The bytes for description to set. |
Type | Description |
Instruction.Builder | This builder for chaining. |
setDisplayName(String value)
public Instruction.Builder setDisplayName(String value)
Required. The display name of the instruction. Maximum of 64 characters.
string display_name = 2;
Name | Description |
value | String The displayName to set. |
Type | Description |
Instruction.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Instruction.Builder setDisplayNameBytes(ByteString value)
Required. The display name of the instruction. Maximum of 64 characters.
string display_name = 2;
Name | Description |
value | ByteString The bytes for displayName to set. |
Type | Description |
Instruction.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Instruction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
Instruction.Builder |
setName(String value)
public Instruction.Builder setName(String value)
Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
string name = 1;
Name | Description |
value | String The name to set. |
Type | Description |
Instruction.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Instruction.Builder setNameBytes(ByteString value)
Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
string name = 1;
Name | Description |
value | ByteString The bytes for name to set. |
Type | Description |
Instruction.Builder | This builder for chaining. |
setPdfInstruction(PdfInstruction value)
public Instruction.Builder setPdfInstruction(PdfInstruction value)
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
Name | Description |
value | PdfInstruction |
Type | Description |
Instruction.Builder |
setPdfInstruction(PdfInstruction.Builder builderForValue)
public Instruction.Builder setPdfInstruction(PdfInstruction.Builder builderForValue)
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
Name | Description |
builderForValue | PdfInstruction.Builder |
Type | Description |
Instruction.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Instruction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
Instruction.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Instruction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
Instruction.Builder |
setUpdateTime(Timestamp value)
public Instruction.Builder setUpdateTime(Timestamp value)
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
Name | Description |
value | Timestamp |
Type | Description |
Instruction.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public Instruction.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
Name | Description |
builderForValue | Builder |
Type | Description |
Instruction.Builder |