Constructor
new Instruction(propertiesopt)
Constructs a new Instruction.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.datalabeling.v1beta1.IInstruction |
<optional> |
Properties to set |
- Implements:
-
- IInstruction
Members
blockingResources
Instruction blockingResources.
createTime
Instruction createTime.
csvInstruction
Instruction csvInstruction.
dataType
Instruction dataType.
description
Instruction description.
displayName
Instruction displayName.
name
Instruction name.
pdfInstruction
Instruction pdfInstruction.
updateTime
Instruction updateTime.
Methods
toJSON() → {Object.<string, *>}
Converts this Instruction to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.datalabeling.v1beta1.Instruction}
Creates a new Instruction instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.datalabeling.v1beta1.IInstruction |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.datalabeling.v1beta1.Instruction |
Instruction instance |
(static) decode(reader, lengthopt) → {google.cloud.datalabeling.v1beta1.Instruction}
Decodes an Instruction message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.datalabeling.v1beta1.Instruction |
Instruction |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.datalabeling.v1beta1.Instruction}
Decodes an Instruction message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.datalabeling.v1beta1.Instruction |
Instruction |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Instruction message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.datalabeling.v1beta1.IInstruction |
Instruction message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Instruction message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.datalabeling.v1beta1.IInstruction |
Instruction message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.datalabeling.v1beta1.Instruction}
Creates an Instruction message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.datalabeling.v1beta1.Instruction |
Instruction |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Instruction
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from an Instruction message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.datalabeling.v1beta1.Instruction |
Instruction |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies an Instruction message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|