View Source GoogleApi.StreetViewPublish.V1.Api.PhotoSequence (google_api_street_view_publish v0.20.0)

API calls for all endpoints tagged PhotoSequence.

Summary

Functions

streetviewpublish_photo_sequence_create(connection, optional_params \\ [], opts \\ [])

After the client finishes uploading the PhotoSequence with the returned UploadRef, CreatePhotoSequence extracts a sequence of 360 photos from a video or Extensible Device Metadata (XDM, http://www.xdm.org/) to be published to Street View on Google Maps. CreatePhotoSequence returns an Operation, with the PhotoSequence Id set in the Operation.name field. This method returns the following error codes: google.rpc.Code.INVALID_ARGUMENT if the request is malformed. google.rpc.Code.NOT_FOUND if the upload reference does not exist.

streetviewpublish_photo_sequence_delete(connection, sequence_id, optional_params \\ [], opts \\ [])

Deletes a PhotoSequence and its metadata. This method returns the following error codes: google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo sequence. google.rpc.Code.NOT_FOUND if the photo sequence ID does not exist. * google.rpc.Code.FAILED_PRECONDITION if the photo sequence ID is not yet finished processing.

streetviewpublish_photo_sequence_get(connection, sequence_id, optional_params \\ [], opts \\ [])

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.

streetviewpublish_photo_sequence_start_upload(connection, optional_params \\ [], opts \\ [])

Creates an upload session to start uploading photo sequence data. The upload URL of the returned UploadRef is used to upload the data for the photoSequence. After the upload is complete, the UploadRef is used with CreatePhotoSequence to create the PhotoSequence object entry.

Functions

streetviewpublish_photo_sequence_create(connection, optional_params \\ [], opts \\ [])

@spec streetviewpublish_photo_sequence_create(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StreetViewPublish.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.StreetViewPublish.V1.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :inputType (type: String.t) - Required. The input form of PhotoSequence.
- :body (type: GoogleApi.StreetViewPublish.V1.Model.PhotoSequence.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StreetViewPublish.V1.Model.Operation{}} on success
{:error, info} on failure

streetviewpublish_photo_sequence_delete(connection, sequence_id, optional_params \\ [], opts \\ [])

@spec streetviewpublish_photo_sequence_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StreetViewPublish.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.StreetViewPublish.V1.Connection.t) - Connection to server
sequence_id (type: String.t) - Required. ID of the PhotoSequence.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StreetViewPublish.V1.Model.Empty{}} on success
{:error, info} on failure

streetviewpublish_photo_sequence_get(connection, sequence_id, optional_params \\ [], opts \\ [])

@spec streetviewpublish_photo_sequence_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StreetViewPublish.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.StreetViewPublish.V1.Connection.t) - Connection to server
sequence_id (type: String.t) - Required. ID of the photo sequence.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :filter (type: String.t) - 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 (type: String.t) - 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.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StreetViewPublish.V1.Model.Operation{}} on success
{:error, info} on failure

streetviewpublish_photo_sequence_start_upload(connection, optional_params \\ [], opts \\ [])

@spec streetviewpublish_photo_sequence_start_upload(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StreetViewPublish.V1.Model.UploadRef.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.StreetViewPublish.V1.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.StreetViewPublish.V1.Model.Empty.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StreetViewPublish.V1.Model.UploadRef{}} on success
{:error, info} on failure