get method

Future<Operation> get(
  1. String sequenceId, {
  2. String? filter,
  3. String? view,
  4. String? $fields,
})

Gets the metadata of the specified PhotoSequence via the Operation interface.

This method returns the following three types of responses: * Operation.done = false, if the processing of PhotoSequence is not finished yet. * Operation.done = true and Operation.error is populated, if there was an error in processing. * Operation.done = true and Operation.response is poulated, which contains a PhotoSequence message. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested PhotoSequence. * google.rpc.Code.NOT_FOUND if the requested PhotoSequence does not exist.

Request parameters:

sequenceId - Required. ID of the photo sequence.

filter - Optional. The filter expression. For example: published_status=PUBLISHED. The filters supported are: published_status. See https://google.aip.dev/160 for more information.

view - Specifies if a download URL for the photo sequence should be returned in download_url of individual photos in the PhotoSequence response. > Note: Currently not implemented. Possible string values are:

  • "BASIC" : Server responses do not include the download URL for the photo bytes. The default value.
  • "INCLUDE_DOWNLOAD_URL" : Server responses include the download URL for the photo bytes.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Operation.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Operation> get(
  core.String sequenceId, {
  core.String? filter,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/photoSequence/' + commons.escapeVariable('$sequenceId');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}