Class SearchCatalogResponse.Builder (1.43.0)

public static final class SearchCatalogResponse.Builder extends GeneratedMessageV3.Builder<SearchCatalogResponse.Builder> implements SearchCatalogResponseOrBuilder

Response message for SearchCatalog.

Protobuf type google.cloud.datacatalog.v1.SearchCatalogResponse

Static Methods

getDescriptor()

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

Methods

addAllResults(Iterable<? extends SearchCatalogResult> values)

public SearchCatalogResponse.Builder addAllResults(Iterable<? extends SearchCatalogResult> values)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.datacatalog.v1.SearchCatalogResult>
Returns
TypeDescription
SearchCatalogResponse.Builder

addAllUnreachable(Iterable<String> values)

public SearchCatalogResponse.Builder addAllUnreachable(Iterable<String> values)

Unreachable locations. Search results don't include data from those locations.

To get additional information on an error, repeat the search request and restrict it to specific locations by setting the SearchCatalogRequest.scope.restricted_locations parameter.

repeated string unreachable = 6;

Parameter
NameDescription
valuesIterable<String>

The unreachable to add.

Returns
TypeDescription
SearchCatalogResponse.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addResults(SearchCatalogResult value)

public SearchCatalogResponse.Builder addResults(SearchCatalogResult value)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameter
NameDescription
valueSearchCatalogResult
Returns
TypeDescription
SearchCatalogResponse.Builder

addResults(SearchCatalogResult.Builder builderForValue)

public SearchCatalogResponse.Builder addResults(SearchCatalogResult.Builder builderForValue)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameter
NameDescription
builderForValueSearchCatalogResult.Builder
Returns
TypeDescription
SearchCatalogResponse.Builder

addResults(int index, SearchCatalogResult value)

public SearchCatalogResponse.Builder addResults(int index, SearchCatalogResult value)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameters
NameDescription
indexint
valueSearchCatalogResult
Returns
TypeDescription
SearchCatalogResponse.Builder

addResults(int index, SearchCatalogResult.Builder builderForValue)

public SearchCatalogResponse.Builder addResults(int index, SearchCatalogResult.Builder builderForValue)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameters
NameDescription
indexint
builderForValueSearchCatalogResult.Builder
Returns
TypeDescription
SearchCatalogResponse.Builder

addResultsBuilder()

public SearchCatalogResult.Builder addResultsBuilder()

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Returns
TypeDescription
SearchCatalogResult.Builder

addResultsBuilder(int index)

public SearchCatalogResult.Builder addResultsBuilder(int index)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchCatalogResult.Builder

addUnreachable(String value)

public SearchCatalogResponse.Builder addUnreachable(String value)

Unreachable locations. Search results don't include data from those locations.

To get additional information on an error, repeat the search request and restrict it to specific locations by setting the SearchCatalogRequest.scope.restricted_locations parameter.

repeated string unreachable = 6;

Parameter
NameDescription
valueString

The unreachable to add.

Returns
TypeDescription
SearchCatalogResponse.Builder

This builder for chaining.

addUnreachableBytes(ByteString value)

public SearchCatalogResponse.Builder addUnreachableBytes(ByteString value)

Unreachable locations. Search results don't include data from those locations.

To get additional information on an error, repeat the search request and restrict it to specific locations by setting the SearchCatalogRequest.scope.restricted_locations parameter.

repeated string unreachable = 6;

Parameter
NameDescription
valueByteString

The bytes of the unreachable to add.

Returns
TypeDescription
SearchCatalogResponse.Builder

This builder for chaining.

build()

public SearchCatalogResponse build()
Returns
TypeDescription
SearchCatalogResponse

buildPartial()

public SearchCatalogResponse buildPartial()
Returns
TypeDescription
SearchCatalogResponse

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearNextPageToken()

public SearchCatalogResponse.Builder clearNextPageToken()

Pagination token that can be used in subsequent calls to retrieve the next page of results.

string next_page_token = 3;

Returns
TypeDescription
SearchCatalogResponse.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearResults()

public SearchCatalogResponse.Builder clearResults()

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Returns
TypeDescription
SearchCatalogResponse.Builder

clearTotalSize()

public SearchCatalogResponse.Builder clearTotalSize()

The approximate total number of entries matched by the query.

int32 total_size = 2;

Returns
TypeDescription
SearchCatalogResponse.Builder

This builder for chaining.

clearUnreachable()

public SearchCatalogResponse.Builder clearUnreachable()

Unreachable locations. Search results don't include data from those locations.

To get additional information on an error, repeat the search request and restrict it to specific locations by setting the SearchCatalogRequest.scope.restricted_locations parameter.

repeated string unreachable = 6;

Returns
TypeDescription
SearchCatalogResponse.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public SearchCatalogResponse getDefaultInstanceForType()
Returns
TypeDescription
SearchCatalogResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getNextPageToken()

public String getNextPageToken()

Pagination token that can be used in subsequent calls to retrieve the next page of results.

string next_page_token = 3;

Returns
TypeDescription
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

Pagination token that can be used in subsequent calls to retrieve the next page of results.

string next_page_token = 3;

Returns
TypeDescription
ByteString

The bytes for nextPageToken.

getResults(int index)

public SearchCatalogResult getResults(int index)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchCatalogResult

getResultsBuilder(int index)

public SearchCatalogResult.Builder getResultsBuilder(int index)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchCatalogResult.Builder

getResultsBuilderList()

public List<SearchCatalogResult.Builder> getResultsBuilderList()

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Returns
TypeDescription
List<Builder>

getResultsCount()

public int getResultsCount()

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Returns
TypeDescription
int

getResultsList()

public List<SearchCatalogResult> getResultsList()

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Returns
TypeDescription
List<SearchCatalogResult>

getResultsOrBuilder(int index)

public SearchCatalogResultOrBuilder getResultsOrBuilder(int index)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchCatalogResultOrBuilder

getResultsOrBuilderList()

public List<? extends SearchCatalogResultOrBuilder> getResultsOrBuilderList()

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Returns
TypeDescription
List<? extends com.google.cloud.datacatalog.v1.SearchCatalogResultOrBuilder>

getTotalSize()

public int getTotalSize()

The approximate total number of entries matched by the query.

int32 total_size = 2;

Returns
TypeDescription
int

The totalSize.

getUnreachable(int index)

public String getUnreachable(int index)

Unreachable locations. Search results don't include data from those locations.

To get additional information on an error, repeat the search request and restrict it to specific locations by setting the SearchCatalogRequest.scope.restricted_locations parameter.

repeated string unreachable = 6;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The unreachable at the given index.

getUnreachableBytes(int index)

public ByteString getUnreachableBytes(int index)

Unreachable locations. Search results don't include data from those locations.

To get additional information on an error, repeat the search request and restrict it to specific locations by setting the SearchCatalogRequest.scope.restricted_locations parameter.

repeated string unreachable = 6;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the unreachable at the given index.

getUnreachableCount()

public int getUnreachableCount()

Unreachable locations. Search results don't include data from those locations.

To get additional information on an error, repeat the search request and restrict it to specific locations by setting the SearchCatalogRequest.scope.restricted_locations parameter.

repeated string unreachable = 6;

Returns
TypeDescription
int

The count of unreachable.

getUnreachableList()

public ProtocolStringList getUnreachableList()

Unreachable locations. Search results don't include data from those locations.

To get additional information on an error, repeat the search request and restrict it to specific locations by setting the SearchCatalogRequest.scope.restricted_locations parameter.

repeated string unreachable = 6;

Returns
TypeDescription
ProtocolStringList

A list containing the unreachable.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchCatalogResponse other)

public SearchCatalogResponse.Builder mergeFrom(SearchCatalogResponse other)
Parameter
NameDescription
otherSearchCatalogResponse
Returns
TypeDescription
SearchCatalogResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeResults(int index)

public SearchCatalogResponse.Builder removeResults(int index)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchCatalogResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setNextPageToken(String value)

public SearchCatalogResponse.Builder setNextPageToken(String value)

Pagination token that can be used in subsequent calls to retrieve the next page of results.

string next_page_token = 3;

Parameter
NameDescription
valueString

The nextPageToken to set.

Returns
TypeDescription
SearchCatalogResponse.Builder

This builder for chaining.

setNextPageTokenBytes(ByteString value)

public SearchCatalogResponse.Builder setNextPageTokenBytes(ByteString value)

Pagination token that can be used in subsequent calls to retrieve the next page of results.

string next_page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for nextPageToken to set.

Returns
TypeDescription
SearchCatalogResponse.Builder

This builder for chaining.

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

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

setResults(int index, SearchCatalogResult value)

public SearchCatalogResponse.Builder setResults(int index, SearchCatalogResult value)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameters
NameDescription
indexint
valueSearchCatalogResult
Returns
TypeDescription
SearchCatalogResponse.Builder

setResults(int index, SearchCatalogResult.Builder builderForValue)

public SearchCatalogResponse.Builder setResults(int index, SearchCatalogResult.Builder builderForValue)

Search results.

repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;

Parameters
NameDescription
indexint
builderForValueSearchCatalogResult.Builder
Returns
TypeDescription
SearchCatalogResponse.Builder

setTotalSize(int value)

public SearchCatalogResponse.Builder setTotalSize(int value)

The approximate total number of entries matched by the query.

int32 total_size = 2;

Parameter
NameDescription
valueint

The totalSize to set.

Returns
TypeDescription
SearchCatalogResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUnreachable(int index, String value)

public SearchCatalogResponse.Builder setUnreachable(int index, String value)

Unreachable locations. Search results don't include data from those locations.

To get additional information on an error, repeat the search request and restrict it to specific locations by setting the SearchCatalogRequest.scope.restricted_locations parameter.

repeated string unreachable = 6;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The unreachable to set.

Returns
TypeDescription
SearchCatalogResponse.Builder

This builder for chaining.