Google Cloud Data Catalog V1 Client - Class SearchCatalogResponse (2.0.1)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class SearchCatalogResponse.

Response message for SearchCatalog.

Generated from protobuf message google.cloud.datacatalog.v1.SearchCatalogResponse

Namespace

Google \ Cloud \ DataCatalog \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ results array<Google\Cloud\DataCatalog\V1\SearchCatalogResult>

Search results.

↳ total_size int

The approximate total number of entries matched by the query.

↳ next_page_token string

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

↳ unreachable array

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.

getResults

Search results.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setResults

Search results.

Parameter
Name Description
var array<Google\Cloud\DataCatalog\V1\SearchCatalogResult>
Returns
Type Description
$this

getTotalSize

The approximate total number of entries matched by the query.

Returns
Type Description
int

setTotalSize

The approximate total number of entries matched by the query.

Parameter
Name Description
var int
Returns
Type Description
$this

getNextPageToken

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

Returns
Type Description
string

setNextPageToken

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

Parameter
Name Description
var string
Returns
Type Description
$this

getUnreachable

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
Type Description
Google\Protobuf\Internal\RepeatedField

setUnreachable

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this