Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. vision
  5. vision/v1
  6. getReferenceImage

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.vision/v1.getReferenceImage

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 information associated with a ReferenceImage. Possible errors: * Returns NOT_FOUND if the specified image does not exist.

    Using getReferenceImage

    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 getReferenceImage(args: GetReferenceImageArgs, opts?: InvokeOptions): Promise<GetReferenceImageResult>
function getReferenceImageOutput(args: GetReferenceImageOutputArgs, opts?: InvokeOptions): Output<GetReferenceImageResult>
    def get_reference_image(location: Optional[str] = None,
                        product_id: Optional[str] = None,
                        project: Optional[str] = None,
                        reference_image_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetReferenceImageResult
def get_reference_image_output(location: Optional[pulumi.Input[str]] = None,
                        product_id: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        reference_image_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetReferenceImageResult]
    func LookupReferenceImage(ctx *Context, args *LookupReferenceImageArgs, opts ...InvokeOption) (*LookupReferenceImageResult, error)
func LookupReferenceImageOutput(ctx *Context, args *LookupReferenceImageOutputArgs, opts ...InvokeOption) LookupReferenceImageResultOutput

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

    public static class GetReferenceImage 
{
    public static Task<GetReferenceImageResult> InvokeAsync(GetReferenceImageArgs args, InvokeOptions? opts = null)
    public static Output<GetReferenceImageResult> Invoke(GetReferenceImageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetReferenceImageResult> getReferenceImage(GetReferenceImageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:vision/v1:getReferenceImage
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    ProductId string
    ReferenceImageId string
    Project string
    Location string
    ProductId string
    ReferenceImageId string
    Project string
    location String
    productId String
    referenceImageId String
    project String
    location string
    productId string
    referenceImageId string
    project string
    location String
    productId String
    referenceImageId String
    project String

    getReferenceImage Result

    The following output properties are available:

    BoundingPolys List<Pulumi.GoogleNative.Vision.V1.Outputs.BoundingPolyResponse>
    Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).
    Name string
    The resource name of the reference image. Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID. This field is ignored when creating a reference image.
    Uri string
    The Google Cloud Storage URI of the reference image. The URI must start with gs://.
    BoundingPolys []BoundingPolyResponse
    Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).
    Name string
    The resource name of the reference image. Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID. This field is ignored when creating a reference image.
    Uri string
    The Google Cloud Storage URI of the reference image. The URI must start with gs://.
    boundingPolys List<BoundingPolyResponse>
    Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).
    name String
    The resource name of the reference image. Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID. This field is ignored when creating a reference image.
    uri String
    The Google Cloud Storage URI of the reference image. The URI must start with gs://.
    boundingPolys BoundingPolyResponse[]
    Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).
    name string
    The resource name of the reference image. Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID. This field is ignored when creating a reference image.
    uri string
    The Google Cloud Storage URI of the reference image. The URI must start with gs://.
    bounding_polys Sequence[BoundingPolyResponse]
    Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).
    name str
    The resource name of the reference image. Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID. This field is ignored when creating a reference image.
    uri str
    The Google Cloud Storage URI of the reference image. The URI must start with gs://.
    boundingPolys List<Property Map>
    Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).
    name String
    The resource name of the reference image. Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID. This field is ignored when creating a reference image.
    uri String
    The Google Cloud Storage URI of the reference image. The URI must start with gs://.

    Supporting Types

    BoundingPolyResponse

    NormalizedVertices []NormalizedVertexResponse
    The bounding polygon normalized vertices.
    Vertices []VertexResponse
    The bounding polygon vertices.
    normalizedVertices List<NormalizedVertexResponse>
    The bounding polygon normalized vertices.
    vertices List<VertexResponse>
    The bounding polygon vertices.
    normalizedVertices NormalizedVertexResponse[]
    The bounding polygon normalized vertices.
    vertices VertexResponse[]
    The bounding polygon vertices.
    normalized_vertices Sequence[NormalizedVertexResponse]
    The bounding polygon normalized vertices.
    vertices Sequence[VertexResponse]
    The bounding polygon vertices.
    normalizedVertices List<Property Map>
    The bounding polygon normalized vertices.
    vertices List<Property Map>
    The bounding polygon vertices.

    NormalizedVertexResponse

    X double
    X coordinate.
    Y double
    Y coordinate.
    X float64
    X coordinate.
    Y float64
    Y coordinate.
    x Double
    X coordinate.
    y Double
    Y coordinate.
    x number
    X coordinate.
    y number
    Y coordinate.
    x float
    X coordinate.
    y float
    Y coordinate.
    x Number
    X coordinate.
    y Number
    Y coordinate.

    VertexResponse

    X int
    X coordinate.
    Y int
    Y coordinate.
    X int
    X coordinate.
    Y int
    Y coordinate.
    x Integer
    X coordinate.
    y Integer
    Y coordinate.
    x number
    X coordinate.
    y number
    Y coordinate.
    x int
    X coordinate.
    y int
    Y coordinate.
    x Number
    X coordinate.
    y Number
    Y coordinate.

    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