# Vision AI V1 API - Class Google::Cloud::VisionAI::V1::Corpus (v1.5.0)

1.5.0 (latest) 1.4.1 1.3.1 1.2.0 1.1.1 1.0.1 0.4.0 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::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.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #default_ttl

    def default_ttl() -> ::Google::Protobuf::Duration

**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #default_ttl=

    def default_ttl=(value) -> ::Google::Protobuf::Duration

**Parameter**

- **value** ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.
**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #description

    def description() -> ::String

**Returns**

- (::String) --- Optional. Description of the corpus. Can be up to 25000 characters long.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Description of the corpus. Can be up to 25000 characters long.
**Returns**

- (::String) --- Optional. Description of the corpus. Can be up to 25000 characters long.

### #display_name

    def display_name() -> ::String

**Returns**

- (::String) --- Required. The corpus name to shown in the UI. The name can be up to 32 characters long.

### #display_name=

    def display_name=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The corpus name to shown in the UI. The name can be up to 32 characters long.
**Returns**

- (::String) --- Required. The corpus name to shown in the UI. The name can be up to 32 characters long.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Resource name of the corpus. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}`

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Resource name of the corpus. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}`
**Returns**

- (::String) --- Resource name of the corpus. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}`

### #satisfies_pzi

    def satisfies_pzi() -> ::Boolean

**Returns**

- (::Boolean) --- 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.

### #satisfies_pzs

    def satisfies_pzs() -> ::Boolean

**Returns**

- (::Boolean) --- 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.

### #search_capability_setting

    def search_capability_setting() -> ::Google::Cloud::VisionAI::V1::SearchCapabilitySetting

**Returns**

- ([::Google::Cloud::VisionAI::V1::SearchCapabilitySetting](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-SearchCapabilitySetting)) --- Default search capability setting on corpus level.

### #search_capability_setting=

    def search_capability_setting=(value) -> ::Google::Cloud::VisionAI::V1::SearchCapabilitySetting

**Parameter**

- **value** ([::Google::Cloud::VisionAI::V1::SearchCapabilitySetting](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-SearchCapabilitySetting)) --- Default search capability setting on corpus level.
**Returns**

- ([::Google::Cloud::VisionAI::V1::SearchCapabilitySetting](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-SearchCapabilitySetting)) --- Default search capability setting on corpus level.

### #type

    def type() -> ::Google::Cloud::VisionAI::V1::Corpus::Type

**Returns**

- ([::Google::Cloud::VisionAI::V1::Corpus::Type](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-Corpus-Type)) --- Optional. Type of the asset inside corpus.

### #type=

    def type=(value) -> ::Google::Cloud::VisionAI::V1::Corpus::Type

**Parameter**

- **value** ([::Google::Cloud::VisionAI::V1::Corpus::Type](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-Corpus-Type)) --- Optional. Type of the asset inside corpus.
**Returns**

- ([::Google::Cloud::VisionAI::V1::Corpus::Type](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-Corpus-Type)) --- Optional. Type of the asset inside corpus.