/*
* 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/data_taxonomy.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.dataplex.v1;
public interface DataAttributeBindingOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataplex.v1.DataAttributeBinding)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The relative resource name of the Data Attribute Binding, of
* the form:
* projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
*
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The relative resource name of the Data Attribute Binding, of
* the form:
* projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. System generated globally unique ID for the
* DataAttributeBinding. This ID will be different if the DataAttributeBinding
* is deleted and re-created with the same name.
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The uid.
*/
java.lang.String getUid();
/**
*
*
*
* Output only. System generated globally unique ID for the
* DataAttributeBinding. This ID will be different if the DataAttributeBinding
* is deleted and re-created with the same name.
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Output only. The time when the DataAttributeBinding was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time when the DataAttributeBinding was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time when the DataAttributeBinding was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The time when the DataAttributeBinding was last updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The time when the DataAttributeBinding was last updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. The time when the DataAttributeBinding was last updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Optional. Description of the DataAttributeBinding.
*
*
* string description = 5 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Optional. Description of the DataAttributeBinding.
*
*
* string description = 5 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Optional. User friendly display name.
*
*
* string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Optional. User friendly display name.
*
*
* string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Optional. User-defined labels for the DataAttributeBinding.
*
*
* map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. User-defined labels for the DataAttributeBinding.
*
*
* map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Optional. User-defined labels for the DataAttributeBinding.
*
*
* map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. User-defined labels for the DataAttributeBinding.
*
*
* map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. User-defined labels for the DataAttributeBinding.
*
*
* map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* This checksum is computed by the server based on the value of other
* fields, and may be sent on update and delete requests to ensure the
* client has an up-to-date value before proceeding.
* Etags must be used when calling the DeleteDataAttributeBinding and the
* UpdateDataAttributeBinding method.
*
*
* string etag = 8;
*
* @return The etag.
*/
java.lang.String getEtag();
/**
*
*
*
* This checksum is computed by the server based on the value of other
* fields, and may be sent on update and delete requests to ensure the
* client has an up-to-date value before proceeding.
* Etags must be used when calling the DeleteDataAttributeBinding and the
* UpdateDataAttributeBinding method.
*
*
* string etag = 8;
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* Optional. Immutable. The resource name of the resource that is associated
* to attributes. Presently, only entity resource is supported in the form:
* projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id}
* Must belong in the same project and region as the attribute binding, and
* there can only exist one active binding for a resource.
*
*
*
* string resource = 100 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
*
*
* @return Whether the resource field is set.
*/
boolean hasResource();
/**
*
*
*
* Optional. Immutable. The resource name of the resource that is associated
* to attributes. Presently, only entity resource is supported in the form:
* projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id}
* Must belong in the same project and region as the attribute binding, and
* there can only exist one active binding for a resource.
*
*
*
* string resource = 100 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The resource.
*/
java.lang.String getResource();
/**
*
*
*
* Optional. Immutable. The resource name of the resource that is associated
* to attributes. Presently, only entity resource is supported in the form:
* projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id}
* Must belong in the same project and region as the attribute binding, and
* there can only exist one active binding for a resource.
*
*
*
* string resource = 100 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The bytes for resource.
*/
com.google.protobuf.ByteString getResourceBytes();
/**
*
*
*
* Optional. List of attributes to be associated with the resource, provided
* in the form:
* projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
*
*
*
* repeated string attributes = 110 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @return A list containing the attributes.
*/
java.util.List getAttributesList();
/**
*
*
*
* Optional. List of attributes to be associated with the resource, provided
* in the form:
* projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
*
*
*
* repeated string attributes = 110 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @return The count of attributes.
*/
int getAttributesCount();
/**
*
*
*
* Optional. List of attributes to be associated with the resource, provided
* in the form:
* projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
*
*
*
* repeated string attributes = 110 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @param index The index of the element to return.
* @return The attributes at the given index.
*/
java.lang.String getAttributes(int index);
/**
*
*
*
* Optional. List of attributes to be associated with the resource, provided
* in the form:
* projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
*
*
*
* repeated string attributes = 110 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @param index The index of the value to return.
* @return The bytes of the attributes at the given index.
*/
com.google.protobuf.ByteString getAttributesBytes(int index);
/**
*
*
*
* Optional. The list of paths for items within the associated resource (eg.
* columns and partitions within a table) along with attribute bindings.
*
*
*
* repeated .google.cloud.dataplex.v1.DataAttributeBinding.Path paths = 120 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List getPathsList();
/**
*
*
*
* Optional. The list of paths for items within the associated resource (eg.
* columns and partitions within a table) along with attribute bindings.
*
*
*
* repeated .google.cloud.dataplex.v1.DataAttributeBinding.Path paths = 120 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataplex.v1.DataAttributeBinding.Path getPaths(int index);
/**
*
*
*
* Optional. The list of paths for items within the associated resource (eg.
* columns and partitions within a table) along with attribute bindings.
*
*
*
* repeated .google.cloud.dataplex.v1.DataAttributeBinding.Path paths = 120 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getPathsCount();
/**
*
*
*
* Optional. The list of paths for items within the associated resource (eg.
* columns and partitions within a table) along with attribute bindings.
*
*
*
* repeated .google.cloud.dataplex.v1.DataAttributeBinding.Path paths = 120 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List
getPathsOrBuilderList();
/**
*
*
*
* Optional. The list of paths for items within the associated resource (eg.
* columns and partitions within a table) along with attribute bindings.
*
*
*
* repeated .google.cloud.dataplex.v1.DataAttributeBinding.Path paths = 120 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataplex.v1.DataAttributeBinding.PathOrBuilder getPathsOrBuilder(int index);
com.google.cloud.dataplex.v1.DataAttributeBinding.ResourceReferenceCase
getResourceReferenceCase();
}
