Class SearchCatalogResult.Builder (1.20.0)

public static final class SearchCatalogResult.Builder extends GeneratedMessageV3.Builder<SearchCatalogResult.Builder> implements SearchCatalogResultOrBuilder

A result that appears in the response of a search request. Each result captures details of one entry that matches the search.

Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogResult

Static Methods

getDescriptor()

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

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

clearLinkedResource()

public SearchCatalogResult.Builder clearLinkedResource()

The full name of the cloud resource the entry belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Example:

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId

string linked_resource = 4;

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

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 resource 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. This is a dot-delimited description of the resource's full type, and is the same as the value callers would provide in the "type" search facet. 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. This field can be used to determine which Get method to call to fetch the full resource.

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLinkedResource()

public String getLinkedResource()

The full name of the cloud resource the entry belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Example:

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId

string linked_resource = 4;

Returns
TypeDescription
String

The linkedResource.

getLinkedResourceBytes()

public ByteString getLinkedResourceBytes()

The full name of the cloud resource the entry belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Example:

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId

string linked_resource = 4;

Returns
TypeDescription
ByteString

The bytes for linkedResource.

getRelativeResourceName()

public String getRelativeResourceName()

The relative resource 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 resource 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. This is a dot-delimited description of the resource's full type, and is the same as the value callers would provide in the "type" search facet. 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. This is a dot-delimited description of the resource's full type, and is the same as the value callers would provide in the "type" search facet. 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. This field can be used to determine which Get method to call to fetch the full resource.

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

Returns
TypeDescription
SearchResultType

The searchResultType.

getSearchResultTypeValue()

public int getSearchResultTypeValue()

Type of the search result. This field can be used to determine which Get method to call to fetch the full resource.

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

Returns
TypeDescription
int

The enum numeric value on the wire for searchResultType.

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

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

setLinkedResource(String value)

public SearchCatalogResult.Builder setLinkedResource(String value)

The full name of the cloud resource the entry belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Example:

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId

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 cloud resource the entry belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Example:

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId

string linked_resource = 4;

Parameter
NameDescription
valueByteString

The bytes for linkedResource to set.

Returns
TypeDescription
SearchCatalogResult.Builder

This builder for chaining.

setRelativeResourceName(String value)

public SearchCatalogResult.Builder setRelativeResourceName(String value)

The relative resource 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 resource 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. This is a dot-delimited description of the resource's full type, and is the same as the value callers would provide in the "type" search facet. 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. This is a dot-delimited description of the resource's full type, and is the same as the value callers would provide in the "type" search facet. 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. This field can be used to determine which Get method to call to fetch the full resource.

.google.cloud.datacatalog.v1beta1.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. This field can be used to determine which Get method to call to fetch the full resource.

.google.cloud.datacatalog.v1beta1.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