Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class Corpus.
Corpus is a set of media contents for management.
Within a corpus, media shares the same data schema. Search is also restricted within a single corpus.
Generated from protobuf message google.cloud.visionai.v1.Corpus
Namespace
Google \ Cloud \ VisionAI \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Resource name of the corpus. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}
↳ display_name
string
Required. The corpus name to shown in the UI. The name can be up to 32 characters long.
↳ description
string
Optional. Description of the corpus. Can be up to 25000 characters long.
↳ default_ttl
Google\Protobuf\Duration
Optional. The default TTL value for all assets under the corpus without a asset level user-defined TTL. For STREAM_VIDEO type corpora, this is required and the maximum allowed default_ttl is 10 years.
↳ type
int
Optional. Type of the asset inside corpus.
↳ search_capability_setting
↳ 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 corpus is a valid zone separated corpus 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 corpus is a valid zone isolated corpus and false if it isn't.
getName
Resource name of the corpus.
Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}
string
setName
Resource name of the corpus.
Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}
var
string
$this
getDisplayName
Required. The corpus name to shown in the UI. The name can be up to 32 characters long.
string
setDisplayName
Required. The corpus name to shown in the UI. The name can be up to 32 characters long.
var
string
$this
getDescription
Optional. Description of the corpus. Can be up to 25000 characters long.
string
setDescription
Optional. Description of the corpus. Can be up to 25000 characters long.
var
string
$this
getDefaultTtl
Optional. The default TTL value for all assets under the corpus without a asset level user-defined TTL. For STREAM_VIDEO type corpora, this is required and the maximum allowed default_ttl is 10 years.
hasDefaultTtl
clearDefaultTtl
setDefaultTtl
Optional. The default TTL value for all assets under the corpus without a asset level user-defined TTL. For STREAM_VIDEO type corpora, this is required and the maximum allowed default_ttl is 10 years.
$this
getType
Optional. Type of the asset inside corpus.
setType
Optional. Type of the asset inside corpus.
$this
getSearchCapabilitySetting
Default search capability setting on corpus level.
hasSearchCapabilitySetting
clearSearchCapabilitySetting
setSearchCapabilitySetting
Default search capability setting on corpus level.
$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 corpus is a valid zone separated corpus and false if it isn't.
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 corpus is a valid zone separated corpus and false if it isn't.
var
bool
$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 corpus is a valid zone isolated corpus and false if it isn't.
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 corpus is a valid zone isolated corpus and false if it isn't.
var
bool
$this
