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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Resource name of the corpus. Format: |
↳ 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 |
SearchCapabilitySetting
Default search capability setting on corpus level. |
↳ 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}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Resource name of the corpus.
Format:
projects/{project_number}/locations/{location_id}/corpora/{corpus_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The corpus name to shown in the UI. The name can be up to 32 characters long.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. The corpus name to shown in the UI. The name can be up to 32 characters long.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the corpus. Can be up to 25000 characters long.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description of the corpus. Can be up to 25000 characters long.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Optional. Type of the asset inside corpus.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Type. |
setType
Optional. Type of the asset inside corpus.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Type. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSearchCapabilitySetting
Default search capability setting on corpus level.
| Returns | |
|---|---|
| Type | Description |
SearchCapabilitySetting|null |
|
hasSearchCapabilitySetting
clearSearchCapabilitySetting
setSearchCapabilitySetting
Default search capability setting on corpus level.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchCapabilitySetting
|
| 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 corpus is a valid zone separated corpus 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 corpus is a valid zone separated corpus 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 corpus is a valid zone isolated corpus 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 corpus is a valid zone isolated corpus and false if it isn't.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|