Interface CorpusOrBuilder (0.11.0) 

public interface CorpusOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDefaultTtl()

public abstract Duration 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.

.google.protobuf.Duration default_ttl = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The defaultTtl.

getDefaultTtlOrBuilder()

public abstract DurationOrBuilder getDefaultTtlOrBuilder()

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.

.google.protobuf.Duration default_ttl = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getDescription()

public abstract String getDescription()

Optional. Description of the corpus. Can be up to 25000 characters long.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Description of the corpus. Can be up to 25000 characters long.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The corpus name to shown in the UI. The name can be up to 32 characters long.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The corpus name to shown in the UI. The name can be up to 32 characters long.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public abstract String getName()

Resource name of the corpus. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Resource name of the corpus. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getSatisfiesPzi()

public abstract boolean 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.

optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public abstract boolean 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.

optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSearchCapabilitySetting()

public abstract SearchCapabilitySetting getSearchCapabilitySetting()

Default search capability setting on corpus level.

.google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;

Returns
Type Description
SearchCapabilitySetting

The searchCapabilitySetting.

getSearchCapabilitySettingOrBuilder()

public abstract SearchCapabilitySettingOrBuilder getSearchCapabilitySettingOrBuilder()

Default search capability setting on corpus level.

.google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;

Returns
Type Description
SearchCapabilitySettingOrBuilder

getType()

public abstract Corpus.Type getType()

Optional. Type of the asset inside corpus.

.google.cloud.visionai.v1.Corpus.Type type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Corpus.Type

The type.

getTypeValue()

public abstract int getTypeValue()

Optional. Type of the asset inside corpus.

.google.cloud.visionai.v1.Corpus.Type type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for type.

hasDefaultTtl()

public abstract boolean hasDefaultTtl()

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.

.google.protobuf.Duration default_ttl = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the defaultTtl field is set.

hasSatisfiesPzi()

public abstract boolean hasSatisfiesPzi()

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.

optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public abstract boolean hasSatisfiesPzs()

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.

optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasSearchCapabilitySetting()

public abstract boolean hasSearchCapabilitySetting()

Default search capability setting on corpus level.

.google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;

Returns
Type Description
boolean

Whether the searchCapabilitySetting field is set.