Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

Instruction

Creates an instruction for how data should be labeled. Auto-naming is currently not supported for this resource.

Create a Instruction Resource

new Instruction(name: string, args: InstructionArgs, opts?: CustomResourceOptions);
@overload
def Instruction(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                csv_instruction: Optional[GoogleCloudDatalabelingV1beta1CsvInstructionArgs] = None,
                data_type: Optional[InstructionDataType] = None,
                description: Optional[str] = None,
                display_name: Optional[str] = None,
                pdf_instruction: Optional[GoogleCloudDatalabelingV1beta1PdfInstructionArgs] = None,
                project: Optional[str] = None)
@overload
def Instruction(resource_name: str,
                args: InstructionArgs,
                opts: Optional[ResourceOptions] = None)
func NewInstruction(ctx *Context, name string, args InstructionArgs, opts ...ResourceOption) (*Instruction, error)
public Instruction(string name, InstructionArgs args, CustomResourceOptions? opts = null)
public Instruction(String name, InstructionArgs args)
public Instruction(String name, InstructionArgs args, CustomResourceOptions options)
type: google-native:datalabeling/v1beta1:Instruction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args InstructionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args InstructionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args InstructionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args InstructionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args InstructionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Instruction Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Instruction resource accepts the following input properties:

DataType Pulumi.GoogleNative.DataLabeling.V1Beta1.InstructionDataType

The data type of this instruction.

DisplayName string

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

CsvInstruction Pulumi.GoogleNative.DataLabeling.V1Beta1.Inputs.GoogleCloudDatalabelingV1beta1CsvInstructionArgs

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.

Deprecated:

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.

Description string

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

PdfInstruction Pulumi.GoogleNative.DataLabeling.V1Beta1.Inputs.GoogleCloudDatalabelingV1beta1PdfInstructionArgs

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

Project string
DataType InstructionDataType

The data type of this instruction.

DisplayName string

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

CsvInstruction GoogleCloudDatalabelingV1beta1CsvInstructionArgs

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.

Deprecated:

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.

Description string

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

PdfInstruction GoogleCloudDatalabelingV1beta1PdfInstructionArgs

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

Project string
dataType InstructionDataType

The data type of this instruction.

displayName String

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

csvInstruction GoogleCloudDatalabelingV1beta1CsvInstructionArgs

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.

Deprecated:

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.

description String

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

pdfInstruction GoogleCloudDatalabelingV1beta1PdfInstructionArgs

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

project String
dataType InstructionDataType

The data type of this instruction.

displayName string

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

csvInstruction GoogleCloudDatalabelingV1beta1CsvInstructionArgs

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.

Deprecated:

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.

description string

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

pdfInstruction GoogleCloudDatalabelingV1beta1PdfInstructionArgs

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

project string
data_type InstructionDataType

The data type of this instruction.

display_name str

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

csv_instruction GoogleCloudDatalabelingV1beta1CsvInstructionArgs

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.

Deprecated:

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.

description str

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

pdf_instruction GoogleCloudDatalabelingV1beta1PdfInstructionArgs

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

project str
dataType "DATA_TYPE_UNSPECIFIED" | "IMAGE" | "VIDEO" | "TEXT" | "GENERAL_DATA"

The data type of this instruction.

displayName String

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

csvInstruction Property Map

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.

Deprecated:

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.

description String

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

pdfInstruction Property Map

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

project String

Outputs

All input properties are implicitly available as output properties. Additionally, the Instruction resource produces the following output properties:

BlockingResources List<string>

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

CreateTime string

Creation time of instruction.

Id string

The provider-assigned unique ID for this managed resource.

Name string

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

UpdateTime string

Last update time of instruction.

BlockingResources []string

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

CreateTime string

Creation time of instruction.

Id string

The provider-assigned unique ID for this managed resource.

Name string

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

UpdateTime string

Last update time of instruction.

blockingResources List<String>

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

createTime String

Creation time of instruction.

id String

The provider-assigned unique ID for this managed resource.

name String

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

updateTime String

Last update time of instruction.

blockingResources string[]

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

createTime string

Creation time of instruction.

id string

The provider-assigned unique ID for this managed resource.

name string

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

updateTime string

Last update time of instruction.

blocking_resources Sequence[str]

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

create_time str

Creation time of instruction.

id str

The provider-assigned unique ID for this managed resource.

name str

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

update_time str

Last update time of instruction.

blockingResources List<String>

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

createTime String

Creation time of instruction.

id String

The provider-assigned unique ID for this managed resource.

name String

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

updateTime String

Last update time of instruction.

Supporting Types

GoogleCloudDatalabelingV1beta1CsvInstruction

GcsFileUri string

CSV file for the instruction. Only gcs path is allowed.

GcsFileUri string

CSV file for the instruction. Only gcs path is allowed.

gcsFileUri String

CSV file for the instruction. Only gcs path is allowed.

gcsFileUri string

CSV file for the instruction. Only gcs path is allowed.

gcs_file_uri str

CSV file for the instruction. Only gcs path is allowed.

gcsFileUri String

CSV file for the instruction. Only gcs path is allowed.

GoogleCloudDatalabelingV1beta1CsvInstructionResponse

GcsFileUri string

CSV file for the instruction. Only gcs path is allowed.

GcsFileUri string

CSV file for the instruction. Only gcs path is allowed.

gcsFileUri String

CSV file for the instruction. Only gcs path is allowed.

gcsFileUri string

CSV file for the instruction. Only gcs path is allowed.

gcs_file_uri str

CSV file for the instruction. Only gcs path is allowed.

gcsFileUri String

CSV file for the instruction. Only gcs path is allowed.

GoogleCloudDatalabelingV1beta1PdfInstruction

GcsFileUri string

PDF file for the instruction. Only gcs path is allowed.

GcsFileUri string

PDF file for the instruction. Only gcs path is allowed.

gcsFileUri String

PDF file for the instruction. Only gcs path is allowed.

gcsFileUri string

PDF file for the instruction. Only gcs path is allowed.

gcs_file_uri str

PDF file for the instruction. Only gcs path is allowed.

gcsFileUri String

PDF file for the instruction. Only gcs path is allowed.

GoogleCloudDatalabelingV1beta1PdfInstructionResponse

GcsFileUri string

PDF file for the instruction. Only gcs path is allowed.

GcsFileUri string

PDF file for the instruction. Only gcs path is allowed.

gcsFileUri String

PDF file for the instruction. Only gcs path is allowed.

gcsFileUri string

PDF file for the instruction. Only gcs path is allowed.

gcs_file_uri str

PDF file for the instruction. Only gcs path is allowed.

gcsFileUri String

PDF file for the instruction. Only gcs path is allowed.

InstructionDataType

DataTypeUnspecified
DATA_TYPE_UNSPECIFIED

Data type is unspecified.

Image
IMAGE

Allowed for continuous evaluation.

Video
VIDEO

Video data type.

Text
TEXT

Allowed for continuous evaluation.

GeneralData
GENERAL_DATA

Allowed for continuous evaluation.

InstructionDataTypeDataTypeUnspecified
DATA_TYPE_UNSPECIFIED

Data type is unspecified.

InstructionDataTypeImage
IMAGE

Allowed for continuous evaluation.

InstructionDataTypeVideo
VIDEO

Video data type.

InstructionDataTypeText
TEXT

Allowed for continuous evaluation.

InstructionDataTypeGeneralData
GENERAL_DATA

Allowed for continuous evaluation.

DataTypeUnspecified
DATA_TYPE_UNSPECIFIED

Data type is unspecified.

Image
IMAGE

Allowed for continuous evaluation.

Video
VIDEO

Video data type.

Text
TEXT

Allowed for continuous evaluation.

GeneralData
GENERAL_DATA

Allowed for continuous evaluation.

DataTypeUnspecified
DATA_TYPE_UNSPECIFIED

Data type is unspecified.

Image
IMAGE

Allowed for continuous evaluation.

Video
VIDEO

Video data type.

Text
TEXT

Allowed for continuous evaluation.

GeneralData
GENERAL_DATA

Allowed for continuous evaluation.

DATA_TYPE_UNSPECIFIED
DATA_TYPE_UNSPECIFIED

Data type is unspecified.

IMAGE
IMAGE

Allowed for continuous evaluation.

VIDEO
VIDEO

Video data type.

TEXT
TEXT

Allowed for continuous evaluation.

GENERAL_DATA
GENERAL_DATA

Allowed for continuous evaluation.

"DATA_TYPE_UNSPECIFIED"
DATA_TYPE_UNSPECIFIED

Data type is unspecified.

"IMAGE"
IMAGE

Allowed for continuous evaluation.

"VIDEO"
VIDEO

Video data type.

"TEXT"
TEXT

Allowed for continuous evaluation.

"GENERAL_DATA"
GENERAL_DATA

Allowed for continuous evaluation.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0