Class: Google::Cloud::DataCatalog::V1::SearchCatalogResponse

Inherits:

Object

• Object
• Google::Cloud::DataCatalog::V1::SearchCatalogResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/datacatalog/v1/datacatalog.rb

Overview

Response message for SearchCatalog.

Instance Attribute Summary

• #next_page_token ⇒ ::String

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

• #results ⇒ ::Array<::Google::Cloud::DataCatalog::V1::SearchCatalogResult>

  Search results.

• #total_size ⇒ ::Integer

  The approximate total number of entries matched by the query.

• #unreachable ⇒ ::Array<::String>

  Unreachable locations.

Instance Attribute Details

#next_page_token ⇒ ::String

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

Returns:

• (::String) —

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

# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 147

class SearchCatalogResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#results ⇒ ::Array<::Google::Cloud::DataCatalog::V1::SearchCatalogResult>

Returns Search results.

Returns:

• (::Array<::Google::Cloud::DataCatalog::V1::SearchCatalogResult>) —

  Search results.

# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 147

class SearchCatalogResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#total_size ⇒ ::Integer

Returns The approximate total number of entries matched by the query.

Returns:

• (::Integer) —

  The approximate total number of entries matched by the query.

# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 147

class SearchCatalogResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#unreachable ⇒ ::Array<::String>

Returns 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.

Returns:

• (::Array<::String>) —

  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.

# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 147

class SearchCatalogResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end