com.google.cloud.dataplex.v1.LookupEntryRequestOrBuilder 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/dataplex/v1/catalog.proto

// Protobuf Java Version: 3.25.4
package com.google.cloud.dataplex.v1;

public interface LookupEntryRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dataplex.v1.LookupEntryRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The project to which the request should be attributed in the
   * following form: `projects/{project}/locations/{location}`.
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Required. The project to which the request should be attributed in the
   * following form: `projects/{project}/locations/{location}`.
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Optional. View for controlling which parts of an entry are to be returned.
   * 
   *
   * .google.cloud.dataplex.v1.EntryView view = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The enum numeric value on the wire for view.
   */
  int getViewValue();
  /**
   *
   *
   *    * Optional. View for controlling which parts of an entry are to be returned.
   * 
   *
   * .google.cloud.dataplex.v1.EntryView view = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The view.
   */
  com.google.cloud.dataplex.v1.EntryView getView();

  /**
   *
   *
   *    * Optional. Limits the aspects returned to the provided aspect types.
   * Only works if the CUSTOM view is selected.
   * 
   *
   * repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return A list containing the aspectTypes.
   */
  java.util.List getAspectTypesList();
  /**
   *
   *
   *    * Optional. Limits the aspects returned to the provided aspect types.
   * Only works if the CUSTOM view is selected.
   * 
   *
   * repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The count of aspectTypes.
   */
  int getAspectTypesCount();
  /**
   *
   *
   *    * Optional. Limits the aspects returned to the provided aspect types.
   * Only works if the CUSTOM view is selected.
   * 
   *
   * repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @param index The index of the element to return.
   * @return The aspectTypes at the given index.
   */
  java.lang.String getAspectTypes(int index);
  /**
   *
   *
   *    * Optional. Limits the aspects returned to the provided aspect types.
   * Only works if the CUSTOM view is selected.
   * 
   *
   * repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @param index The index of the value to return.
   * @return The bytes of the aspectTypes at the given index.
   */
  com.google.protobuf.ByteString getAspectTypesBytes(int index);

  /**
   *
   *
   *    * Optional. Limits the aspects returned to those associated with the provided
   * paths within the Entry. Only works if the CUSTOM view is selected.
   * 
   *
   * repeated string paths = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return A list containing the paths.
   */
  java.util.List getPathsList();
  /**
   *
   *
   *    * Optional. Limits the aspects returned to those associated with the provided
   * paths within the Entry. Only works if the CUSTOM view is selected.
   * 
   *
   * repeated string paths = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The count of paths.
   */
  int getPathsCount();
  /**
   *
   *
   *    * Optional. Limits the aspects returned to those associated with the provided
   * paths within the Entry. Only works if the CUSTOM view is selected.
   * 
   *
   * repeated string paths = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @param index The index of the element to return.
   * @return The paths at the given index.
   */
  java.lang.String getPaths(int index);
  /**
   *
   *
   *    * Optional. Limits the aspects returned to those associated with the provided
   * paths within the Entry. Only works if the CUSTOM view is selected.
   * 
   *
   * repeated string paths = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @param index The index of the value to return.
   * @return The bytes of the paths at the given index.
   */
  com.google.protobuf.ByteString getPathsBytes(int index);

  /**
   *
   *
   *    * Required. The resource name of the Entry:
   * `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
   * 
   *
   * 
   * string entry = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The entry.
   */
  java.lang.String getEntry();
  /**
   *
   *
   *    * Required. The resource name of the Entry:
   * `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
   * 
   *
   * 
   * string entry = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for entry.
   */
  com.google.protobuf.ByteString getEntryBytes();
}