com.google.cloud.visionai.v1.CreateIndexRequestOrBuilder 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 CreateIndexRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.visionai.v1.CreateIndexRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. Value for the parent. The resource name of the Corpus under which
   * this index is created. Format:
   * `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}`
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   *    * Required. Value for the parent. The resource name of the Corpus under which
   * this index is created. Format:
   * `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}`
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   *    * Optional. The ID for the index. This will become the final resource name
   * for the index. If the user does not specify this value, it will be
   * generated by system.
   *
   * This value should be up to 63 characters, and valid characters
   * are /[a-z][0-9]-/. The first character must be a letter, the last could be
   * a letter or a number.
   * 
   *
   * string index_id = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The indexId.
   */
  java.lang.String getIndexId();
  /**
   *
   *
   *    * Optional. The ID for the index. This will become the final resource name
   * for the index. If the user does not specify this value, it will be
   * generated by system.
   *
   * This value should be up to 63 characters, and valid characters
   * are /[a-z][0-9]-/. The first character must be a letter, the last could be
   * a letter or a number.
   * 
   *
   * string index_id = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for indexId.
   */
  com.google.protobuf.ByteString getIndexIdBytes();

  /**
   *
   *
   *    * Required. The index being created.
   * 
   *
   * .google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the index field is set.
   */
  boolean hasIndex();
  /**
   *
   *
   *    * Required. The index being created.
   * 
   *
   * .google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The index.
   */
  com.google.cloud.visionai.v1.Index getIndex();
  /**
   *
   *
   *    * Required. The index being created.
   * 
   *
   * .google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.visionai.v1.IndexOrBuilder getIndexOrBuilder();
}