Package com.google.cloud.visionai.v1

Interface CorpusOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Corpus, Corpus.Builder
@Generated public interface CorpusOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Resource name of the corpus.
 Format:
 `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}`
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Resource name of the corpus.
 Format:
 `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}`
      string name = 1;
      Returns:
      The bytes for name.

    • getDisplayName

      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:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.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:
      The bytes for displayName.

    • getDescription

      String getDescription()
       Optional. Description of the corpus. Can be up to 25000 characters long.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the corpus. Can be up to 25000 characters long.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • hasDefaultTtl

      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:
      Whether the defaultTtl field is set.

    • getDefaultTtl

      com.google.protobuf.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:
      The defaultTtl.

    • getDefaultTtlOrBuilder

      com.google.protobuf.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];

    • getTypeValue

      int getTypeValue()
       Optional. Type of the asset inside corpus.
      .google.cloud.visionai.v1.Corpus.Type type = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      Corpus.Type getType()
       Optional. Type of the asset inside corpus.
      .google.cloud.visionai.v1.Corpus.Type type = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The type.

    • hasSearchCapabilitySetting

      boolean hasSearchCapabilitySetting()
       Default search capability setting on corpus level.
      .google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
      Returns:
      Whether the searchCapabilitySetting field is set.

    • getSearchCapabilitySetting

      SearchCapabilitySetting getSearchCapabilitySetting()
       Default search capability setting on corpus level.
      .google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
      Returns:
      The searchCapabilitySetting.

    • getSearchCapabilitySettingOrBuilder

      SearchCapabilitySettingOrBuilder getSearchCapabilitySettingOrBuilder()
       Default search capability setting on corpus level.
      .google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;

    • hasSatisfiesPzs

      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:
      Whether the satisfiesPzs field is set.

    • getSatisfiesPzs

      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:
      The satisfiesPzs.

    • hasSatisfiesPzi

      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:
      Whether the satisfiesPzi field is set.

    • getSatisfiesPzi

      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:
      The satisfiesPzi.