com.google.cloud.visionai.v1.CorpusOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/visionai/v1/warehouse.proto

// Protobuf Java Version: 3.25.3
package com.google.cloud.visionai.v1;

public interface CorpusOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.visionai.v1.Corpus)
    com.google.protobuf.MessageOrBuilder {

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

  /**
   *
   *
   *    * 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];
   *
   * @return The displayName.
   */
  java.lang.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];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * Optional. Description of the corpus. Can be up to 25000 characters long.
   * 
   *
   * string description = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   *    * Optional. Description of the corpus. Can be up to 25000 characters long.
   * 
   *
   * string description = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   *    * 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];
   * 
   *
   * @return Whether the defaultTtl field is set.
   */
  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];
   * 
   *
   * @return The defaultTtl.
   */
  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];
   * 
   */
  com.google.protobuf.DurationOrBuilder getDefaultTtlOrBuilder();

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

  /**
   *
   *
   *    * Default search capability setting on corpus level.
   * 
   *
   * .google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
   *
   * @return Whether the searchCapabilitySetting field is set.
   */
  boolean hasSearchCapabilitySetting();
  /**
   *
   *
   *    * Default search capability setting on corpus level.
   * 
   *
   * .google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
   *
   * @return The searchCapabilitySetting.
   */
  com.google.cloud.visionai.v1.SearchCapabilitySetting getSearchCapabilitySetting();
  /**
   *
   *
   *    * Default search capability setting on corpus level.
   * 
   *
   * .google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
   */
  com.google.cloud.visionai.v1.SearchCapabilitySettingOrBuilder
      getSearchCapabilitySettingOrBuilder();
}