Class SearchCatalogResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datacatalog.v1.SearchCatalogResponse
All Implemented Interfaces:
SearchCatalogResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class SearchCatalogResponse extends com.google.protobuf.GeneratedMessage implements SearchCatalogResponseOrBuilder
 Response message for
 [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
 
Protobuf type google.cloud.datacatalog.v1.SearchCatalogResponse
See Also:
  • Field Details

    • RESULTS_FIELD_NUMBER

      public static final int RESULTS_FIELD_NUMBER
      See Also:
    • TOTAL_SIZE_FIELD_NUMBER

      public static final int TOTAL_SIZE_FIELD_NUMBER
      See Also:
    • NEXT_PAGE_TOKEN_FIELD_NUMBER

      public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
      See Also:
    • UNREACHABLE_FIELD_NUMBER

      public static final int UNREACHABLE_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getResultsList

      public List<SearchCatalogResult> getResultsList()
       Search results.
       
      repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;
      Specified by:
      getResultsList in interface SearchCatalogResponseOrBuilder
    • getResultsOrBuilderList

      public List<? extends SearchCatalogResultOrBuilder> getResultsOrBuilderList()
       Search results.
       
      repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;
      Specified by:
      getResultsOrBuilderList in interface SearchCatalogResponseOrBuilder
    • getResultsCount

      public int getResultsCount()
       Search results.
       
      repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;
      Specified by:
      getResultsCount in interface SearchCatalogResponseOrBuilder
    • getResults

      public SearchCatalogResult getResults(int index)
       Search results.
       
      repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;
      Specified by:
      getResults in interface SearchCatalogResponseOrBuilder
    • getResultsOrBuilder

      public SearchCatalogResultOrBuilder getResultsOrBuilder(int index)
       Search results.
       
      repeated .google.cloud.datacatalog.v1.SearchCatalogResult results = 1;
      Specified by:
      getResultsOrBuilder in interface SearchCatalogResponseOrBuilder
    • getTotalSize

      public int getTotalSize()
       The approximate total number of entries matched by the query.
       
      int32 total_size = 2;
      Specified by:
      getTotalSize in interface SearchCatalogResponseOrBuilder
      Returns:
      The totalSize.
    • 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;
      Specified by:
      getNextPageToken in interface SearchCatalogResponseOrBuilder
      Returns:
      The nextPageToken.
    • getNextPageTokenBytes

      public 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;
      Specified by:
      getNextPageTokenBytes in interface SearchCatalogResponseOrBuilder
      Returns:
      The bytes for nextPageToken.
    • getUnreachableList

      public com.google.protobuf.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;
      Specified by:
      getUnreachableList in interface SearchCatalogResponseOrBuilder
      Returns:
      A list containing the unreachable.
    • 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;
      Specified by:
      getUnreachableCount in interface SearchCatalogResponseOrBuilder
      Returns:
      The count of unreachable.
    • getUnreachable

      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;
      Specified by:
      getUnreachable in interface SearchCatalogResponseOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The unreachable at the given index.
    • getUnreachableBytes

      public 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;
      Specified by:
      getUnreachableBytes in interface SearchCatalogResponseOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the unreachable at the given index.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static SearchCatalogResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchCatalogResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchCatalogResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchCatalogResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchCatalogResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchCatalogResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchCatalogResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchCatalogResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SearchCatalogResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SearchCatalogResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchCatalogResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchCatalogResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public SearchCatalogResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static SearchCatalogResponse.Builder newBuilder()
    • newBuilder

      public static SearchCatalogResponse.Builder newBuilder(SearchCatalogResponse prototype)
    • toBuilder

      public SearchCatalogResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected SearchCatalogResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static SearchCatalogResponse getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<SearchCatalogResponse> parser()
    • getParserForType

      public com.google.protobuf.Parser<SearchCatalogResponse> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public SearchCatalogResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder