Class SearchCatalogResponse (1.28.0)

public final class SearchCatalogResponse extends GeneratedMessageV3 implements SearchCatalogResponseOrBuilder

Response message for SearchCatalog.

Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogResponse

Static Fields

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_SIZE_FIELD_NUMBER

public static final int TOTAL_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

UNREACHABLE_FIELD_NUMBER

public static final int UNREACHABLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchCatalogResponse getDefaultInstance()
Returns
TypeDescription
SearchCatalogResponse

getDescriptor()

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

newBuilder()

public static SearchCatalogResponse.Builder newBuilder()
Returns
TypeDescription
SearchCatalogResponse.Builder

newBuilder(SearchCatalogResponse prototype)

public static SearchCatalogResponse.Builder newBuilder(SearchCatalogResponse prototype)
Parameter
NameDescription
prototypeSearchCatalogResponse
Returns
TypeDescription
SearchCatalogResponse.Builder

parseDelimitedFrom(InputStream input)

public static SearchCatalogResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchCatalogResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchCatalogResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchCatalogResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchCatalogResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchCatalogResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchCatalogResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchCatalogResponse> parser()
Returns
TypeDescription
Parser<SearchCatalogResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchCatalogResponse getDefaultInstanceForType()
Returns
TypeDescription
SearchCatalogResponse

getNextPageToken()

public String getNextPageToken()

The token that can be used to retrieve the next page of results.

string next_page_token = 3;

Returns
TypeDescription
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

The token that can be used to retrieve the next page of results.

string next_page_token = 3;

Returns
TypeDescription
ByteString

The bytes for nextPageToken.

getParserForType()

public Parser<SearchCatalogResponse> getParserForType()
Returns
TypeDescription
Parser<SearchCatalogResponse>
Overrides

getResults(int index)

public SearchCatalogResult getResults(int index)

Search results.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchCatalogResult

getResultsCount()

public int getResultsCount()

Search results.

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

Returns
TypeDescription
int

getResultsList()

public List<SearchCatalogResult> getResultsList()

Search results.

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

Returns
TypeDescription
List<SearchCatalogResult>

getResultsOrBuilder(int index)

public SearchCatalogResultOrBuilder getResultsOrBuilder(int index)

Search results.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchCatalogResultOrBuilder

getResultsOrBuilderList()

public List<? extends SearchCatalogResultOrBuilder> getResultsOrBuilderList()

Search results.

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

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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 result does not include data from those locations. Users can get additional information on the error by repeating the search request with a more restrictive parameter -- setting the value for SearchDataCatalogRequest.scope.restricted_locations.

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 result does not include data from those locations. Users can get additional information on the error by repeating the search request with a more restrictive parameter -- setting the value for SearchDataCatalogRequest.scope.restricted_locations.

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 result does not include data from those locations. Users can get additional information on the error by repeating the search request with a more restrictive parameter -- setting the value for SearchDataCatalogRequest.scope.restricted_locations.

repeated string unreachable = 6;

Returns
TypeDescription
int

The count of unreachable.

getUnreachableList()

public ProtocolStringList getUnreachableList()

Unreachable locations. Search result does not include data from those locations. Users can get additional information on the error by repeating the search request with a more restrictive parameter -- setting the value for SearchDataCatalogRequest.scope.restricted_locations.

repeated string unreachable = 6;

Returns
TypeDescription
ProtocolStringList

A list containing the unreachable.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchCatalogResponse.Builder newBuilderForType()
Returns
TypeDescription
SearchCatalogResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchCatalogResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchCatalogResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchCatalogResponse.Builder toBuilder()
Returns
TypeDescription
SearchCatalogResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException