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

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

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

  /**
   *
   *
   *    * Output only. Partition values used in the HTTP URL must be
   * double encoded. For example, `url_encode(url_encode(value))` can be used
   * to encode "US:CA/CA#Sunnyvale so that the request URL ends
   * with "/partitions/US%253ACA/CA%2523Sunnyvale".
   * The name field in the response retains the encoded format.
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Output only. Partition values used in the HTTP URL must be
   * double encoded. For example, `url_encode(url_encode(value))` can be used
   * to encode "US:CA/CA#Sunnyvale so that the request URL ends
   * with "/partitions/US%253ACA/CA%2523Sunnyvale".
   * The name field in the response retains the encoded format.
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Required. Immutable. The set of values representing the partition, which
   * correspond to the partition schema defined in the parent entity.
   * 
   *
   * 
   * repeated string values = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return A list containing the values.
   */
  java.util.List getValuesList();
  /**
   *
   *
   *    * Required. Immutable. The set of values representing the partition, which
   * correspond to the partition schema defined in the parent entity.
   * 
   *
   * 
   * repeated string values = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return The count of values.
   */
  int getValuesCount();
  /**
   *
   *
   *    * Required. Immutable. The set of values representing the partition, which
   * correspond to the partition schema defined in the parent entity.
   * 
   *
   * 
   * repeated string values = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @param index The index of the element to return.
   * @return The values at the given index.
   */
  java.lang.String getValues(int index);
  /**
   *
   *
   *    * Required. Immutable. The set of values representing the partition, which
   * correspond to the partition schema defined in the parent entity.
   * 
   *
   * 
   * repeated string values = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @param index The index of the value to return.
   * @return The bytes of the values at the given index.
   */
  com.google.protobuf.ByteString getValuesBytes(int index);

  /**
   *
   *
   *    * Required. Immutable. The location of the entity data within the partition,
   * for example, `gs://bucket/path/to/entity/key1=value1/key2=value2`. Or
   * `projects/<project_id>/datasets/<dataset_id>/tables/<table_id>`
   * 
   *
   * 
   * string location = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return The location.
   */
  java.lang.String getLocation();
  /**
   *
   *
   *    * Required. Immutable. The location of the entity data within the partition,
   * for example, `gs://bucket/path/to/entity/key1=value1/key2=value2`. Or
   * `projects/<project_id>/datasets/<dataset_id>/tables/<table_id>`
   * 
   *
   * 
   * string location = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return The bytes for location.
   */
  com.google.protobuf.ByteString getLocationBytes();

  /**
   *
   *
   *    * Optional. The etag for this partition.
   * 
   *
   * string etag = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
   *
   * @deprecated google.cloud.dataplex.v1.Partition.etag is deprecated. See
   *     google/cloud/dataplex/v1/metadata.proto;l=513
   * @return The etag.
   */
  @java.lang.Deprecated
  java.lang.String getEtag();
  /**
   *
   *
   *    * Optional. The etag for this partition.
   * 
   *
   * string etag = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
   *
   * @deprecated google.cloud.dataplex.v1.Partition.etag is deprecated. See
   *     google/cloud/dataplex/v1/metadata.proto;l=513
   * @return The bytes for etag.
   */
  @java.lang.Deprecated
  com.google.protobuf.ByteString getEtagBytes();
}