Console
    Start free

    Google Cloud Vision Ai V1 Client - Class ListAnnotationsRequest (0.3.0)

    Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class ListAnnotationsRequest.

    Request message for GetAnnotation API.

    Generated from protobuf message google.cloud.visionai.v1.ListAnnotationsRequest

    Namespace

    Google \ Cloud \ VisionAI \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ parent
    string

    The parent, which owns this collection of annotations. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

    ↳ page_size
    int

    The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

    ↳ page_token
    string

    A page token, received from a previous ListAnnotations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAnnotations must match the call that provided the page token.

    ↳ filter
    string

    The filter applied to the returned list. We only support filtering for the following fields: For corpus of STREAM_VIDEO type: partition.temporal_partition.start_time , partition.temporal_partition.end_time , and key . For corpus of VIDEO_ON_DEMAND type, partition.relative_temporal_partition.start_offset , partition.relative_temporal_partition.end_offset , and key . For corpus of IMAGE type, only key is supported. Timestamps are specified in the RFC-3339 format, and only one restriction may be applied per field, joined by conjunctions. Format: "partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND key = "example_key""

    getParent

    The parent, which owns this collection of annotations.

    Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

    Returns
    Type
    Description
    string

    setParent

    The parent, which owns this collection of annotations.

    Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPageSize

    The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned.

    The maximum value is 1000; values above 1000 will be coerced to 1000.

    Returns
    Type
    Description
    int

    setPageSize

    The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned.

    The maximum value is 1000; values above 1000 will be coerced to 1000.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getPageToken

    A page token, received from a previous ListAnnotations call.

    Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAnnotations must match the call that provided the page token.

    Returns
    Type
    Description
    string

    setPageToken

    A page token, received from a previous ListAnnotations call.

    Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAnnotations must match the call that provided the page token.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFilter

    The filter applied to the returned list.

    We only support filtering for the following fields: For corpus of STREAM_VIDEO type: partition.temporal_partition.start_time , partition.temporal_partition.end_time , and key . For corpus of VIDEO_ON_DEMAND type, partition.relative_temporal_partition.start_offset , partition.relative_temporal_partition.end_offset , and key . For corpus of IMAGE type, only key is supported. Timestamps are specified in the RFC-3339 format, and only one restriction may be applied per field, joined by conjunctions. Format: "partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND key = "example_key""

    Returns
    Type
    Description
    string

    setFilter

    The filter applied to the returned list.

    We only support filtering for the following fields: For corpus of STREAM_VIDEO type: partition.temporal_partition.start_time , partition.temporal_partition.end_time , and key . For corpus of VIDEO_ON_DEMAND type, partition.relative_temporal_partition.start_offset , partition.relative_temporal_partition.end_offset , and key . For corpus of IMAGE type, only key is supported. Timestamps are specified in the RFC-3339 format, and only one restriction may be applied per field, joined by conjunctions. Format: "partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND key = "example_key""

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    static::build

    Parameter
    Name
    Description
    parent
    string

    The parent, which owns this collection of annotations. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

    Returns
    Type
    Description
    ListAnnotationsRequest
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: