Interface SearchCatalogResponseOrBuilder (1.57.0)

public interface SearchCatalogResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getNextPageToken()

public abstract String getNextPageToken()

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

string next_page_token = 3;

Returns
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public abstract ByteString getNextPageTokenBytes()

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

string next_page_token = 3;

Returns
Type Description
ByteString

The bytes for nextPageToken.

getResults(int index)

public abstract SearchCatalogResult getResults(int index)

Search results.

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

Parameter
Name Description
index int
Returns
Type Description
SearchCatalogResult

getResultsCount()

public abstract int getResultsCount()

Search results.

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

Returns
Type Description
int

getResultsList()

public abstract List<SearchCatalogResult> getResultsList()

Search results.

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

Returns
Type Description
List<SearchCatalogResult>

getResultsOrBuilder(int index)

public abstract SearchCatalogResultOrBuilder getResultsOrBuilder(int index)

Search results.

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

Parameter
Name Description
index int
Returns
Type Description
SearchCatalogResultOrBuilder

getResultsOrBuilderList()

public abstract List<? extends SearchCatalogResultOrBuilder> getResultsOrBuilderList()

Search results.

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

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

getTotalSize()

public abstract int getTotalSize()

The approximate total number of entries matched by the query.

int32 total_size = 2;

Returns
Type Description
int

The totalSize.

getUnreachable(int index)

public abstract 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
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The unreachable at the given index.

getUnreachableBytes(int index)

public abstract 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
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the unreachable at the given index.

getUnreachableCount()

public abstract 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
Type Description
int

The count of unreachable.

getUnreachableList()

public abstract List<String> 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
Type Description
List<String>

A list containing the unreachable.