Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datalabeling
  5. datalabeling/v1beta1
  6. Instruction

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.datalabeling/v1beta1.Instruction

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

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

Create Instruction Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Instruction(name: string, args: InstructionArgs, opts?: CustomResourceOptions);
@overload
def Instruction(resource_name: str,
                args: InstructionArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Instruction(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                data_type: Optional[InstructionDataType] = None,
                display_name: Optional[str] = None,
                csv_instruction: Optional[GoogleCloudDatalabelingV1beta1CsvInstructionArgs] = None,
                description: Optional[str] = None,
                pdf_instruction: Optional[GoogleCloudDatalabelingV1beta1PdfInstructionArgs] = None,
                project: Optional[str] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InstructionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. InstructionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InstructionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InstructionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var instructionResource = new GoogleNative.DataLabeling.V1Beta1.Instruction("instructionResource", new()
{
    DataType = GoogleNative.DataLabeling.V1Beta1.InstructionDataType.DataTypeUnspecified,
    DisplayName = "string",
    Description = "string",
    PdfInstruction = new GoogleNative.DataLabeling.V1Beta1.Inputs.GoogleCloudDatalabelingV1beta1PdfInstructionArgs
    {
        GcsFileUri = "string",
    },
    Project = "string",
});
Copy
example, err := datalabeling.NewInstruction(ctx, "instructionResource", &datalabeling.InstructionArgs{
	DataType:    datalabeling.InstructionDataTypeDataTypeUnspecified,
	DisplayName: pulumi.String("string"),
	Description: pulumi.String("string"),
	PdfInstruction: &datalabeling.GoogleCloudDatalabelingV1beta1PdfInstructionArgs{
		GcsFileUri: pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})
Copy
var instructionResource = new Instruction("instructionResource", InstructionArgs.builder()
    .dataType("DATA_TYPE_UNSPECIFIED")
    .displayName("string")
    .description("string")
    .pdfInstruction(GoogleCloudDatalabelingV1beta1PdfInstructionArgs.builder()
        .gcsFileUri("string")
        .build())
    .project("string")
    .build());
Copy
instruction_resource = google_native.datalabeling.v1beta1.Instruction("instructionResource",
    data_type=google_native.datalabeling.v1beta1.InstructionDataType.DATA_TYPE_UNSPECIFIED,
    display_name="string",
    description="string",
    pdf_instruction={
        "gcs_file_uri": "string",
    },
    project="string")
Copy
const instructionResource = new google_native.datalabeling.v1beta1.Instruction("instructionResource", {
    dataType: google_native.datalabeling.v1beta1.InstructionDataType.DataTypeUnspecified,
    displayName: "string",
    description: "string",
    pdfInstruction: {
        gcsFileUri: "string",
    },
    project: "string",
});
Copy
type: google-native:datalabeling/v1beta1:Instruction
properties:
    dataType: DATA_TYPE_UNSPECIFIED
    description: string
    displayName: string
    pdfInstruction:
        gcsFileUri: string
    project: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Instruction resource accepts the following input properties:

DataType This property is required. Pulumi.GoogleNative.DataLabeling.V1Beta1.InstructionDataType
The data type of this instruction.
DisplayName This property is required. string
The display name of the instruction. Maximum of 64 characters.
CsvInstruction Pulumi.GoogleNative.DataLabeling.V1Beta1.Inputs.GoogleCloudDatalabelingV1beta1CsvInstruction
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.GoogleCloudDatalabelingV1beta1PdfInstruction
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
Project Changes to this property will trigger replacement. string
DataType This property is required. InstructionDataType
The data type of this instruction.
DisplayName This property is required. 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 Changes to this property will trigger replacement. string
dataType This property is required. InstructionDataType
The data type of this instruction.
displayName This property is required. String
The display name of the instruction. Maximum of 64 characters.
csvInstruction GoogleCloudDatalabelingV1beta1CsvInstruction
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 GoogleCloudDatalabelingV1beta1PdfInstruction
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
project Changes to this property will trigger replacement. String
dataType This property is required. InstructionDataType
The data type of this instruction.
displayName This property is required. string
The display name of the instruction. Maximum of 64 characters.
csvInstruction GoogleCloudDatalabelingV1beta1CsvInstruction
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 GoogleCloudDatalabelingV1beta1PdfInstruction
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
project Changes to this property will trigger replacement. string
data_type This property is required. InstructionDataType
The data type of this instruction.
display_name This property is required. 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 Changes to this property will trigger replacement. str
dataType This property is required. "DATA_TYPE_UNSPECIFIED" | "IMAGE" | "VIDEO" | "TEXT" | "GENERAL_DATA"
The data type of this instruction.
displayName This property is required. 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 Changes to this property will trigger replacement. 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
, GoogleCloudDatalabelingV1beta1CsvInstructionArgs

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
, GoogleCloudDatalabelingV1beta1CsvInstructionResponseArgs

GcsFileUri This property is required. string
CSV file for the instruction. Only gcs path is allowed.
GcsFileUri This property is required. string
CSV file for the instruction. Only gcs path is allowed.
gcsFileUri This property is required. String
CSV file for the instruction. Only gcs path is allowed.
gcsFileUri This property is required. string
CSV file for the instruction. Only gcs path is allowed.
gcs_file_uri This property is required. str
CSV file for the instruction. Only gcs path is allowed.
gcsFileUri This property is required. String
CSV file for the instruction. Only gcs path is allowed.

GoogleCloudDatalabelingV1beta1PdfInstruction
, GoogleCloudDatalabelingV1beta1PdfInstructionArgs

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
, GoogleCloudDatalabelingV1beta1PdfInstructionResponseArgs

GcsFileUri This property is required. string
PDF file for the instruction. Only gcs path is allowed.
GcsFileUri This property is required. string
PDF file for the instruction. Only gcs path is allowed.
gcsFileUri This property is required. String
PDF file for the instruction. Only gcs path is allowed.
gcsFileUri This property is required. string
PDF file for the instruction. Only gcs path is allowed.
gcs_file_uri This property is required. str
PDF file for the instruction. Only gcs path is allowed.
gcsFileUri This property is required. String
PDF file for the instruction. Only gcs path is allowed.

InstructionDataType
, InstructionDataTypeArgs

DataTypeUnspecified
DATA_TYPE_UNSPECIFIEDData type is unspecified.
Image
IMAGEAllowed for continuous evaluation.
Video
VIDEOVideo data type.
Text
TEXTAllowed for continuous evaluation.
GeneralData
GENERAL_DATAAllowed for continuous evaluation.
InstructionDataTypeDataTypeUnspecified
DATA_TYPE_UNSPECIFIEDData type is unspecified.
InstructionDataTypeImage
IMAGEAllowed for continuous evaluation.
InstructionDataTypeVideo
VIDEOVideo data type.
InstructionDataTypeText
TEXTAllowed for continuous evaluation.
InstructionDataTypeGeneralData
GENERAL_DATAAllowed for continuous evaluation.
DataTypeUnspecified
DATA_TYPE_UNSPECIFIEDData type is unspecified.
Image
IMAGEAllowed for continuous evaluation.
Video
VIDEOVideo data type.
Text
TEXTAllowed for continuous evaluation.
GeneralData
GENERAL_DATAAllowed for continuous evaluation.
DataTypeUnspecified
DATA_TYPE_UNSPECIFIEDData type is unspecified.
Image
IMAGEAllowed for continuous evaluation.
Video
VIDEOVideo data type.
Text
TEXTAllowed for continuous evaluation.
GeneralData
GENERAL_DATAAllowed for continuous evaluation.
DATA_TYPE_UNSPECIFIED
DATA_TYPE_UNSPECIFIEDData type is unspecified.
IMAGE
IMAGEAllowed for continuous evaluation.
VIDEO
VIDEOVideo data type.
TEXT
TEXTAllowed for continuous evaluation.
GENERAL_DATA
GENERAL_DATAAllowed for continuous evaluation.
"DATA_TYPE_UNSPECIFIED"
DATA_TYPE_UNSPECIFIEDData type is unspecified.
"IMAGE"
IMAGEAllowed for continuous evaluation.
"VIDEO"
VIDEOVideo data type.
"TEXT"
TEXTAllowed for continuous evaluation.
"GENERAL_DATA"
GENERAL_DATAAllowed for continuous evaluation.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native