Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datalabeling
  5. datalabeling/v1beta1
  6. getInstruction

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.getInstruction

Explore with Pulumi AI

google-native logo

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

    Gets an instruction by resource name.

    Using getInstruction

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstruction(args: GetInstructionArgs, opts?: InvokeOptions): Promise<GetInstructionResult>
function getInstructionOutput(args: GetInstructionOutputArgs, opts?: InvokeOptions): Output<GetInstructionResult>
    def get_instruction(instruction_id: Optional[str] = None,
                    project: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetInstructionResult
def get_instruction_output(instruction_id: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetInstructionResult]
    func LookupInstruction(ctx *Context, args *LookupInstructionArgs, opts ...InvokeOption) (*LookupInstructionResult, error)
func LookupInstructionOutput(ctx *Context, args *LookupInstructionOutputArgs, opts ...InvokeOption) LookupInstructionResultOutput

    > Note: This function is named LookupInstruction in the Go SDK.

    public static class GetInstruction 
{
    public static Task<GetInstructionResult> InvokeAsync(GetInstructionArgs args, InvokeOptions? opts = null)
    public static Output<GetInstructionResult> Invoke(GetInstructionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstructionResult> getInstruction(GetInstructionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:datalabeling/v1beta1:getInstruction
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstructionId string
    Project string
    InstructionId string
    Project string
    instructionId String
    project String
    instructionId string
    project string
    instructionId String
    project String

    getInstruction Result

    The following output properties are available:

    BlockingResources List<string>
    The names of any related resources that are blocking changes to the instruction.
    CreateTime string
    Creation time of instruction.
    CsvInstruction Pulumi.GoogleNative.DataLabeling.V1Beta1.Outputs.GoogleCloudDatalabelingV1beta1CsvInstructionResponse
    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.

    DataType string
    The data type of this instruction.
    Description string
    Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
    DisplayName string
    The display name of the instruction. Maximum of 64 characters.
    Name string
    Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
    PdfInstruction Pulumi.GoogleNative.DataLabeling.V1Beta1.Outputs.GoogleCloudDatalabelingV1beta1PdfInstructionResponse
    Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
    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.
    CsvInstruction GoogleCloudDatalabelingV1beta1CsvInstructionResponse
    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.

    DataType string
    The data type of this instruction.
    Description string
    Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
    DisplayName string
    The display name of the instruction. Maximum of 64 characters.
    Name string
    Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
    PdfInstruction GoogleCloudDatalabelingV1beta1PdfInstructionResponse
    Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
    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.
    csvInstruction GoogleCloudDatalabelingV1beta1CsvInstructionResponse
    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.

    dataType String
    The data type of this instruction.
    description String
    Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
    displayName String
    The display name of the instruction. Maximum of 64 characters.
    name String
    Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
    pdfInstruction GoogleCloudDatalabelingV1beta1PdfInstructionResponse
    Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
    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.
    csvInstruction GoogleCloudDatalabelingV1beta1CsvInstructionResponse
    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.

    dataType string
    The data type of this instruction.
    description string
    Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
    displayName string
    The display name of the instruction. Maximum of 64 characters.
    name string
    Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
    pdfInstruction GoogleCloudDatalabelingV1beta1PdfInstructionResponse
    Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
    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.
    csv_instruction GoogleCloudDatalabelingV1beta1CsvInstructionResponse
    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.

    data_type str
    The data type of this instruction.
    description str
    Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
    display_name str
    The display name of the instruction. Maximum of 64 characters.
    name str
    Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
    pdf_instruction GoogleCloudDatalabelingV1beta1PdfInstructionResponse
    Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
    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.
    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.

    dataType String
    The data type of this instruction.
    description String
    Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
    displayName String
    The display name of the instruction. Maximum of 64 characters.
    name String
    Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
    pdfInstruction Property Map
    Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
    updateTime String
    Last update time of instruction.

    Supporting Types

    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.

    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.

    Package Details

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

    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