metadata_service

************ /datasets ***************

SearchDatasets(request)
Parameters:requestSearchDatasetsRequest
Return type:SearchDatasetsResponse
Throws:GAException

Gets a list of Dataset matching the search criteria.

POST /datasets/search must accept a JSON version of SearchDatasetsRequest as the post body and will return a JSON version of SearchDatasetsResponse.

GetDataset(request)
Parameters:requestGetDatasetRequest
Return type:Dataset
Throws:GAException

Gets a Dataset by ID.

GET /datasets/{dataset_id} will return a JSON version of Dataset.

message SearchDatasetsRequest
Fields:
  • page_size (integer) – Specifies the maximum number of results to return in a single page. If unspecified, a system default will be used.
  • page_token (string) – The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of next_page_token from the previous response.

This request maps to the body of POST /datasets/search as JSON.

message SearchDatasetsResponse
Fields:
  • datasets (list of Dataset) – The list of datasets.
  • next_page_token (string) – The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren’t any additional results.

This is the response from POST /datasets/search expressed as JSON.

message GetDatasetRequest
Fields:
  • dataset_id (string) – The ID of the Dataset to be retrieved.

This request maps to the URL GET /datasets/{dataset_id}.