Class SearchCatalogResponse (1.51.0)

public final class SearchCatalogResponse extends GeneratedMessageV3 implements SearchCatalogResponseOrBuilder

Response message for SearchCatalog.

Protobuf type google.cloud.datacatalog.v1.SearchCatalogResponse

Static Fields

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_SIZE_FIELD_NUMBER

public static final int TOTAL_SIZE_FIELD_NUMBER
Field Value
Type Description
int

UNREACHABLE_FIELD_NUMBER

public static final int UNREACHABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchCatalogResponse getDefaultInstance()
Returns
Type Description
SearchCatalogResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchCatalogResponse.Builder newBuilder()
Returns
Type Description
SearchCatalogResponse.Builder

newBuilder(SearchCatalogResponse prototype)

public static SearchCatalogResponse.Builder newBuilder(SearchCatalogResponse prototype)
Parameter
Name Description
prototype SearchCatalogResponse
Returns
Type Description
SearchCatalogResponse.Builder

parseDelimitedFrom(InputStream input)

public static SearchCatalogResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchCatalogResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchCatalogResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchCatalogResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchCatalogResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchCatalogResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchCatalogResponse> parser()
Returns
Type Description
Parser<SearchCatalogResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchCatalogResponse getDefaultInstanceForType()
Returns
Type Description
SearchCatalogResponse

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
Type Description
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
Type Description
ByteString

The bytes for nextPageToken.

getParserForType()

public Parser<SearchCatalogResponse> getParserForType()
Returns
Type Description
Parser<SearchCatalogResponse>
Overrides

getResults(int index)

public 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 int getResultsCount()

Search results.

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

Returns
Type Description
int

getResultsList()

public List<SearchCatalogResult> getResultsList()

Search results.

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

Returns
Type Description
List<SearchCatalogResult>

getResultsOrBuilder(int index)

public 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 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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalSize()

public 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 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 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 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 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
Type Description
ProtocolStringList

A list containing the unreachable.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchCatalogResponse.Builder newBuilderForType()
Returns
Type Description
SearchCatalogResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchCatalogResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchCatalogResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchCatalogResponse.Builder toBuilder()
Returns
Type Description
SearchCatalogResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException