Console
    Start free

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

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

    An Index is a resource in Corpus. It contains an indexed version of the assets and annotations. When deployed to an endpoint, it will allow users to search the Index.

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

    Namespace

    Google \ Cloud \ VisionAI \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ entire_corpus
    bool

    Include all assets under the corpus.

    ↳ name
    string

    Output only. Resource name of the Index resource. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}

    ↳ display_name
    string

    Optional. Optional user-specified display name of the index.

    ↳ description
    string

    Optional. Optional description of the index.

    ↳ state
    int

    Output only. State of the index.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. The create timestamp.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. The update timestamp.

    ↳ deployed_indexes
    array< DeployedIndexReference >

    Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

    ↳ satisfies_pzs
    bool

    Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the index is a valid zone separated index and false if it isn't.

    ↳ satisfies_pzi
    bool

    Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the index is a valid zone isolated index and false if it isn't.

    getEntireCorpus

    Include all assets under the corpus.

    Returns
    Type
    Description
    bool

    hasEntireCorpus

    setEntireCorpus

    Include all assets under the corpus.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getName

    Output only. Resource name of the Index resource.

    Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}

    Returns
    Type
    Description
    string

    setName

    Output only. Resource name of the Index resource.

    Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Optional. Optional user-specified display name of the index.

    Returns
    Type
    Description
    string

    setDisplayName

    Optional. Optional user-specified display name of the index.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Optional. Optional description of the index.

    Returns
    Type
    Description
    string

    setDescription

    Optional. Optional description of the index.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getState

    Output only. State of the index.

    Returns
    Type
    Description
    int
    Enum of type State .

    setState

    Output only. State of the index.

    Parameter
    Name
    Description
    var
    int

    Enum of type State .

    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. The create timestamp.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. The create timestamp.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. The update timestamp.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. The update timestamp.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getDeployedIndexes

    Output only. References to the deployed index instance.

    Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

    Returns
    Type
    Description
    Google\Protobuf\RepeatedField < DeployedIndexReference >

    setDeployedIndexes

    Output only. References to the deployed index instance.

    Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

    Parameter
    Name
    Description
    var
    array< DeployedIndexReference >
    Returns
    Type
    Description
    $this

    getSatisfiesPzs

    Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the index is a valid zone separated index and false if it isn't.

    Returns
    Type
    Description
    bool

    hasSatisfiesPzs

    clearSatisfiesPzs

    setSatisfiesPzs

    Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the index is a valid zone separated index and false if it isn't.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getSatisfiesPzi

    Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the index is a valid zone isolated index and false if it isn't.

    Returns
    Type
    Description
    bool

    hasSatisfiesPzi

    clearSatisfiesPzi

    setSatisfiesPzi

    Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the index is a valid zone isolated index and false if it isn't.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getAssetFilter

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