com.google.cloud.datacatalog.v1

Interface SearchCatalogResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchCatalogResponse, SearchCatalogResponse.Builder

public interface SearchCatalogResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getNextPageToken() Pagination token that can be used in subsequent calls to retrieve the next page of results.
com.google.protobuf.ByteString	getNextPageTokenBytes() Pagination token that can be used in subsequent calls to retrieve the next page of results.
SearchCatalogResult	getResults(int index) Search results.
int	getResultsCount() Search results.
List<SearchCatalogResult>	getResultsList() Search results.
SearchCatalogResultOrBuilder	getResultsOrBuilder(int index) Search results.
List<? extends SearchCatalogResultOrBuilder>	getResultsOrBuilderList() Search results.
int	getTotalSize() The approximate total number of entries matched by the query.
String	getUnreachable(int index) Unreachable locations.
com.google.protobuf.ByteString	getUnreachableBytes(int index) Unreachable locations.
int	getUnreachableCount() Unreachable locations.
List<String>	getUnreachableList() Unreachable locations.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getResultsList

List<SearchCatalogResult> getResultsList()

 Search results.
 

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

getResults

SearchCatalogResult getResults(int index)

 Search results.
 

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

getResultsCount

int getResultsCount()

 Search results.
 

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

getResultsOrBuilderList

List<? extends SearchCatalogResultOrBuilder> getResultsOrBuilderList()

 Search results.
 

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

getResultsOrBuilder

SearchCatalogResultOrBuilder getResultsOrBuilder(int index)

 Search results.
 

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

getTotalSize

int getTotalSize()

 The approximate total number of entries matched by the query.
 

int32 total_size = 2;

Returns:

The totalSize.

getNextPageToken

String getNextPageToken()

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

string next_page_token = 3;

Returns:

The nextPageToken.

getNextPageTokenBytes

com.google.protobuf.ByteString getNextPageTokenBytes()

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

string next_page_token = 3;

Returns:

The bytes for nextPageToken.

getUnreachableList

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:

A list containing the unreachable.

getUnreachableCount

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:

The count of unreachable.

getUnreachable

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;

Parameters:

index - The index of the element to return.

Returns:

The unreachable at the given index.

getUnreachableBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the unreachable at the given index.