Class SearchCatalogResult.Builder

public static final class SearchCatalogResult.Builder extends GeneratedMessageV3.Builder<SearchCatalogResult.Builder> implements SearchCatalogResultOrBuilder
Result in the response to a search request.
 Each result captures details of one entry that matches the search.

Protobuf type google.cloud.datacatalog.v1.SearchCatalogResult

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchCatalogResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides

build()

public SearchCatalogResult build()
Returns
TypeDescription
SearchCatalogResult

buildPartial()

public SearchCatalogResult buildPartial()
Returns
TypeDescription
SearchCatalogResult

clear()

public SearchCatalogResult.Builder clear()
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchCatalogResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides

clearFullyQualifiedName()

public SearchCatalogResult.Builder clearFullyQualifiedName()
Fully qualified name (FQN) of the resource.
 FQNs take two forms:
 * For non-regionalized resources:
   `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
 * For regionalized resources:
   `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
 Example for a DPMS table:
 `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`

string fully_qualified_name = 10;

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

clearIntegratedSystem()

public SearchCatalogResult.Builder clearIntegratedSystem()
Output only. The source system that Data Catalog automatically integrates  with, such
 as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

clearLinkedResource()

public SearchCatalogResult.Builder clearLinkedResource()
The full name of the Google Cloud resource the entry belongs to.
 For more information, see [Full Resource Name]
 (/apis/design/resource_names#full_resource_name).
 Example:
 `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`

string linked_resource = 4;

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

clearModifyTime()

public SearchCatalogResult.Builder clearModifyTime()
The last modification timestamp of the entry in the source system.

.google.protobuf.Timestamp modify_time = 7;

Returns
TypeDescription
SearchCatalogResult.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchCatalogResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides

clearRelativeResourceName()

public SearchCatalogResult.Builder clearRelativeResourceName()
The relative name of the resource in URL format.
 Examples:
  * `projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`
  * `projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}`

string relative_resource_name = 3;

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

clearSearchResultSubtype()

public SearchCatalogResult.Builder clearSearchResultSubtype()
Sub-type of the search result.
 A dot-delimited full type of the resource. The same type you
 specify in the `type` search predicate.
 Examples: `entry.table`, `entry.dataStream`, `tagTemplate`.

string search_result_subtype = 2;

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

clearSearchResultType()

public SearchCatalogResult.Builder clearSearchResultType()
Type of the search result.
 You can use this field to determine which get method to call to fetch the
 full resource.

.google.cloud.datacatalog.v1.SearchResultType search_result_type = 1;

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

clearSystem()

public SearchCatalogResult.Builder clearSystem()
Returns
TypeDescription
SearchCatalogResult.Builder

clearUserSpecifiedSystem()

public SearchCatalogResult.Builder clearUserSpecifiedSystem()
Custom source system that you can manually integrate Data Catalog with.

string user_specified_system = 9;

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

clone()

public SearchCatalogResult.Builder clone()
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides

getDefaultInstanceForType()

public SearchCatalogResult getDefaultInstanceForType()
Returns
TypeDescription
SearchCatalogResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFullyQualifiedName()

public String getFullyQualifiedName()
Fully qualified name (FQN) of the resource.
 FQNs take two forms:
 * For non-regionalized resources:
   `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
 * For regionalized resources:
   `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
 Example for a DPMS table:
 `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`

string fully_qualified_name = 10;

Returns
TypeDescription
String

The fullyQualifiedName.

getFullyQualifiedNameBytes()

public ByteString getFullyQualifiedNameBytes()
Fully qualified name (FQN) of the resource.
 FQNs take two forms:
 * For non-regionalized resources:
   `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
 * For regionalized resources:
   `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
 Example for a DPMS table:
 `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`

string fully_qualified_name = 10;

Returns
TypeDescription
ByteString

The bytes for fullyQualifiedName.

getIntegratedSystem()

public IntegratedSystem getIntegratedSystem()
Output only. The source system that Data Catalog automatically integrates  with, such
 as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
IntegratedSystem

The integratedSystem.

getIntegratedSystemValue()

public int getIntegratedSystemValue()
Output only. The source system that Data Catalog automatically integrates  with, such
 as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for integratedSystem.

getLinkedResource()

public String getLinkedResource()
The full name of the Google Cloud resource the entry belongs to.
 For more information, see [Full Resource Name]
 (/apis/design/resource_names#full_resource_name).
 Example:
 `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`

string linked_resource = 4;

Returns
TypeDescription
String

The linkedResource.

getLinkedResourceBytes()

public ByteString getLinkedResourceBytes()
The full name of the Google Cloud resource the entry belongs to.
 For more information, see [Full Resource Name]
 (/apis/design/resource_names#full_resource_name).
 Example:
 `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`

string linked_resource = 4;

Returns
TypeDescription
ByteString

The bytes for linkedResource.

getModifyTime()

public Timestamp getModifyTime()
The last modification timestamp of the entry in the source system.

.google.protobuf.Timestamp modify_time = 7;

Returns
TypeDescription
Timestamp

The modifyTime.

getModifyTimeBuilder()

public Timestamp.Builder getModifyTimeBuilder()
The last modification timestamp of the entry in the source system.

.google.protobuf.Timestamp modify_time = 7;

Returns
TypeDescription
Builder

getModifyTimeOrBuilder()

public TimestampOrBuilder getModifyTimeOrBuilder()
The last modification timestamp of the entry in the source system.

.google.protobuf.Timestamp modify_time = 7;

Returns
TypeDescription
TimestampOrBuilder

getRelativeResourceName()

public String getRelativeResourceName()
The relative name of the resource in URL format.
 Examples:
  * `projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`
  * `projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}`

string relative_resource_name = 3;

Returns
TypeDescription
String

The relativeResourceName.

getRelativeResourceNameBytes()

public ByteString getRelativeResourceNameBytes()
The relative name of the resource in URL format.
 Examples:
  * `projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`
  * `projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}`

string relative_resource_name = 3;

Returns
TypeDescription
ByteString

The bytes for relativeResourceName.

getSearchResultSubtype()

public String getSearchResultSubtype()
Sub-type of the search result.
 A dot-delimited full type of the resource. The same type you
 specify in the `type` search predicate.
 Examples: `entry.table`, `entry.dataStream`, `tagTemplate`.

string search_result_subtype = 2;

Returns
TypeDescription
String

The searchResultSubtype.

getSearchResultSubtypeBytes()

public ByteString getSearchResultSubtypeBytes()
Sub-type of the search result.
 A dot-delimited full type of the resource. The same type you
 specify in the `type` search predicate.
 Examples: `entry.table`, `entry.dataStream`, `tagTemplate`.

string search_result_subtype = 2;

Returns
TypeDescription
ByteString

The bytes for searchResultSubtype.

getSearchResultType()

public SearchResultType getSearchResultType()
Type of the search result.
 You can use this field to determine which get method to call to fetch the
 full resource.

.google.cloud.datacatalog.v1.SearchResultType search_result_type = 1;

Returns
TypeDescription
SearchResultType

The searchResultType.

getSearchResultTypeValue()

public int getSearchResultTypeValue()
Type of the search result.
 You can use this field to determine which get method to call to fetch the
 full resource.

.google.cloud.datacatalog.v1.SearchResultType search_result_type = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for searchResultType.

getSystemCase()

public SearchCatalogResult.SystemCase getSystemCase()
Returns
TypeDescription
SearchCatalogResult.SystemCase

getUserSpecifiedSystem()

public String getUserSpecifiedSystem()
Custom source system that you can manually integrate Data Catalog with.

string user_specified_system = 9;

Returns
TypeDescription
String

The userSpecifiedSystem.

getUserSpecifiedSystemBytes()

public ByteString getUserSpecifiedSystemBytes()
Custom source system that you can manually integrate Data Catalog with.

string user_specified_system = 9;

Returns
TypeDescription
ByteString

The bytes for userSpecifiedSystem.

hasIntegratedSystem()

public boolean hasIntegratedSystem()
Output only. The source system that Data Catalog automatically integrates  with, such
 as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the integratedSystem field is set.

hasModifyTime()

public boolean hasModifyTime()
The last modification timestamp of the entry in the source system.

.google.protobuf.Timestamp modify_time = 7;

Returns
TypeDescription
boolean

Whether the modifyTime field is set.

hasUserSpecifiedSystem()

public boolean hasUserSpecifiedSystem()
Custom source system that you can manually integrate Data Catalog with.

string user_specified_system = 9;

Returns
TypeDescription
boolean

Whether the userSpecifiedSystem field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchCatalogResult other)

public SearchCatalogResult.Builder mergeFrom(SearchCatalogResult other)
Parameter
NameDescription
otherSearchCatalogResult
Returns
TypeDescription
SearchCatalogResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchCatalogResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchCatalogResult.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides

mergeModifyTime(Timestamp value)

public SearchCatalogResult.Builder mergeModifyTime(Timestamp value)
The last modification timestamp of the entry in the source system.

.google.protobuf.Timestamp modify_time = 7;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
SearchCatalogResult.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchCatalogResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchCatalogResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides

setFullyQualifiedName(String value)

public SearchCatalogResult.Builder setFullyQualifiedName(String value)
Fully qualified name (FQN) of the resource.
 FQNs take two forms:
 * For non-regionalized resources:
   `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
 * For regionalized resources:
   `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
 Example for a DPMS table:
 `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`

string fully_qualified_name = 10;

Parameter
NameDescription
valueString

The fullyQualifiedName to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setFullyQualifiedNameBytes(ByteString value)

public SearchCatalogResult.Builder setFullyQualifiedNameBytes(ByteString value)
Fully qualified name (FQN) of the resource.
 FQNs take two forms:
 * For non-regionalized resources:
   `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
 * For regionalized resources:
   `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
 Example for a DPMS table:
 `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`

string fully_qualified_name = 10;

Parameter
NameDescription
valueByteString

The bytes for fullyQualifiedName to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setIntegratedSystem(IntegratedSystem value)

public SearchCatalogResult.Builder setIntegratedSystem(IntegratedSystem value)
Output only. The source system that Data Catalog automatically integrates  with, such
 as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueIntegratedSystem

The integratedSystem to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setIntegratedSystemValue(int value)

public SearchCatalogResult.Builder setIntegratedSystemValue(int value)
Output only. The source system that Data Catalog automatically integrates  with, such
 as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The enum numeric value on the wire for integratedSystem to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setLinkedResource(String value)

public SearchCatalogResult.Builder setLinkedResource(String value)
The full name of the Google Cloud resource the entry belongs to.
 For more information, see [Full Resource Name]
 (/apis/design/resource_names#full_resource_name).
 Example:
 `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`

string linked_resource = 4;

Parameter
NameDescription
valueString

The linkedResource to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setLinkedResourceBytes(ByteString value)

public SearchCatalogResult.Builder setLinkedResourceBytes(ByteString value)
The full name of the Google Cloud resource the entry belongs to.
 For more information, see [Full Resource Name]
 (/apis/design/resource_names#full_resource_name).
 Example:
 `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`

string linked_resource = 4;

Parameter
NameDescription
valueByteString

The bytes for linkedResource to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setModifyTime(Timestamp value)

public SearchCatalogResult.Builder setModifyTime(Timestamp value)
The last modification timestamp of the entry in the source system.

.google.protobuf.Timestamp modify_time = 7;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
SearchCatalogResult.Builder

setModifyTime(Timestamp.Builder builderForValue)

public SearchCatalogResult.Builder setModifyTime(Timestamp.Builder builderForValue)
The last modification timestamp of the entry in the source system.

.google.protobuf.Timestamp modify_time = 7;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
SearchCatalogResult.Builder

setRelativeResourceName(String value)

public SearchCatalogResult.Builder setRelativeResourceName(String value)
The relative name of the resource in URL format.
 Examples:
  * `projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`
  * `projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}`

string relative_resource_name = 3;

Parameter
NameDescription
valueString

The relativeResourceName to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setRelativeResourceNameBytes(ByteString value)

public SearchCatalogResult.Builder setRelativeResourceNameBytes(ByteString value)
The relative name of the resource in URL format.
 Examples:
  * `projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`
  * `projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}`

string relative_resource_name = 3;

Parameter
NameDescription
valueByteString

The bytes for relativeResourceName to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchCatalogResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides

setSearchResultSubtype(String value)

public SearchCatalogResult.Builder setSearchResultSubtype(String value)
Sub-type of the search result.
 A dot-delimited full type of the resource. The same type you
 specify in the `type` search predicate.
 Examples: `entry.table`, `entry.dataStream`, `tagTemplate`.

string search_result_subtype = 2;

Parameter
NameDescription
valueString

The searchResultSubtype to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setSearchResultSubtypeBytes(ByteString value)

public SearchCatalogResult.Builder setSearchResultSubtypeBytes(ByteString value)
Sub-type of the search result.
 A dot-delimited full type of the resource. The same type you
 specify in the `type` search predicate.
 Examples: `entry.table`, `entry.dataStream`, `tagTemplate`.

string search_result_subtype = 2;

Parameter
NameDescription
valueByteString

The bytes for searchResultSubtype to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setSearchResultType(SearchResultType value)

public SearchCatalogResult.Builder setSearchResultType(SearchResultType value)
Type of the search result.
 You can use this field to determine which get method to call to fetch the
 full resource.

.google.cloud.datacatalog.v1.SearchResultType search_result_type = 1;

Parameter
NameDescription
valueSearchResultType

The searchResultType to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setSearchResultTypeValue(int value)

public SearchCatalogResult.Builder setSearchResultTypeValue(int value)
Type of the search result.
 You can use this field to determine which get method to call to fetch the
 full resource.

.google.cloud.datacatalog.v1.SearchResultType search_result_type = 1;

Parameter
NameDescription
valueint

The enum numeric value on the wire for searchResultType to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchCatalogResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchCatalogResult.Builder
Overrides

setUserSpecifiedSystem(String value)

public SearchCatalogResult.Builder setUserSpecifiedSystem(String value)
Custom source system that you can manually integrate Data Catalog with.

string user_specified_system = 9;

Parameter
NameDescription
valueString

The userSpecifiedSystem to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setUserSpecifiedSystemBytes(ByteString value)

public SearchCatalogResult.Builder setUserSpecifiedSystemBytes(ByteString value)
Custom source system that you can manually integrate Data Catalog with.

string user_specified_system = 9;

Parameter
NameDescription
valueByteString

The bytes for userSpecifiedSystem to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.