Documentation ¶
Overview ¶
Package streetviewpublish provides access to the Street View Publish API.
See https://developers.google.com/streetview/publish/
Usage example:
import "google.golang.org/api/streetviewpublish/v1" ... streetviewpublishService, err := streetviewpublish.New(oauthHttpClient)
Index ¶
- Constants
- type BatchDeletePhotosRequest
- type BatchDeletePhotosResponse
- type BatchGetPhotosResponse
- type BatchUpdatePhotosRequest
- type BatchUpdatePhotosResponse
- type Connection
- type Empty
- type LatLng
- type Level
- type ListPhotosResponse
- type Operation
- type Photo
- type PhotoCreateCall
- type PhotoDeleteCall
- type PhotoGetCall
- func (c *PhotoGetCall) Context(ctx context.Context) *PhotoGetCall
- func (c *PhotoGetCall) Do(opts ...googleapi.CallOption) (*Photo, error)
- func (c *PhotoGetCall) Fields(s ...googleapi.Field) *PhotoGetCall
- func (c *PhotoGetCall) Header() http.Header
- func (c *PhotoGetCall) IfNoneMatch(entityTag string) *PhotoGetCall
- func (c *PhotoGetCall) View(view string) *PhotoGetCall
- type PhotoId
- type PhotoResponse
- type PhotoService
- func (r *PhotoService) Create(photo *Photo) *PhotoCreateCall
- func (r *PhotoService) Delete(photoId string) *PhotoDeleteCall
- func (r *PhotoService) Get(photoId string) *PhotoGetCall
- func (r *PhotoService) StartUpload(empty *Empty) *PhotoStartUploadCall
- func (r *PhotoService) Update(id string, photo *Photo) *PhotoUpdateCall
- type PhotoStartUploadCall
- type PhotoUpdateCall
- func (c *PhotoUpdateCall) Context(ctx context.Context) *PhotoUpdateCall
- func (c *PhotoUpdateCall) Do(opts ...googleapi.CallOption) (*Photo, error)
- func (c *PhotoUpdateCall) Fields(s ...googleapi.Field) *PhotoUpdateCall
- func (c *PhotoUpdateCall) Header() http.Header
- func (c *PhotoUpdateCall) UpdateMask(updateMask string) *PhotoUpdateCall
- type PhotosBatchDeleteCall
- func (c *PhotosBatchDeleteCall) Context(ctx context.Context) *PhotosBatchDeleteCall
- func (c *PhotosBatchDeleteCall) Do(opts ...googleapi.CallOption) (*BatchDeletePhotosResponse, error)
- func (c *PhotosBatchDeleteCall) Fields(s ...googleapi.Field) *PhotosBatchDeleteCall
- func (c *PhotosBatchDeleteCall) Header() http.Header
- type PhotosBatchGetCall
- func (c *PhotosBatchGetCall) Context(ctx context.Context) *PhotosBatchGetCall
- func (c *PhotosBatchGetCall) Do(opts ...googleapi.CallOption) (*BatchGetPhotosResponse, error)
- func (c *PhotosBatchGetCall) Fields(s ...googleapi.Field) *PhotosBatchGetCall
- func (c *PhotosBatchGetCall) Header() http.Header
- func (c *PhotosBatchGetCall) IfNoneMatch(entityTag string) *PhotosBatchGetCall
- func (c *PhotosBatchGetCall) PhotoIds(photoIds ...string) *PhotosBatchGetCall
- func (c *PhotosBatchGetCall) View(view string) *PhotosBatchGetCall
- type PhotosBatchUpdateCall
- func (c *PhotosBatchUpdateCall) Context(ctx context.Context) *PhotosBatchUpdateCall
- func (c *PhotosBatchUpdateCall) Do(opts ...googleapi.CallOption) (*BatchUpdatePhotosResponse, error)
- func (c *PhotosBatchUpdateCall) Fields(s ...googleapi.Field) *PhotosBatchUpdateCall
- func (c *PhotosBatchUpdateCall) Header() http.Header
- type PhotosListCall
- func (c *PhotosListCall) Context(ctx context.Context) *PhotosListCall
- func (c *PhotosListCall) Do(opts ...googleapi.CallOption) (*ListPhotosResponse, error)
- func (c *PhotosListCall) Fields(s ...googleapi.Field) *PhotosListCall
- func (c *PhotosListCall) Filter(filter string) *PhotosListCall
- func (c *PhotosListCall) Header() http.Header
- func (c *PhotosListCall) IfNoneMatch(entityTag string) *PhotosListCall
- func (c *PhotosListCall) PageSize(pageSize int64) *PhotosListCall
- func (c *PhotosListCall) PageToken(pageToken string) *PhotosListCall
- func (c *PhotosListCall) Pages(ctx context.Context, f func(*ListPhotosResponse) error) error
- func (c *PhotosListCall) View(view string) *PhotosListCall
- type PhotosService
- func (r *PhotosService) BatchDelete(batchdeletephotosrequest *BatchDeletePhotosRequest) *PhotosBatchDeleteCall
- func (r *PhotosService) BatchGet() *PhotosBatchGetCall
- func (r *PhotosService) BatchUpdate(batchupdatephotosrequest *BatchUpdatePhotosRequest) *PhotosBatchUpdateCall
- func (r *PhotosService) List() *PhotosListCall
- type Place
- type Pose
- type Service
- type Status
- type UpdatePhotoRequest
- type UploadRef
Constants ¶
const (
// Publish and manage your 360 photos on Google Street View
StreetviewpublishScope = "https://www.googleapis.com/auth/streetviewpublish"
)
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BatchDeletePhotosRequest ¶
type BatchDeletePhotosRequest struct { // PhotoIds: Required. IDs of the Photos. For HTTP // GET requests, the URL query parameter should // be // `photoIds=<id1>&photoIds=<id2>&...`. PhotoIds []string `json:"photoIds,omitempty"` // ForceSendFields is a list of field names (e.g. "PhotoIds") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "PhotoIds") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchDeletePhotosRequest: Request to delete multiple Photos.
func (*BatchDeletePhotosRequest) MarshalJSON ¶
func (s *BatchDeletePhotosRequest) MarshalJSON() ([]byte, error)
type BatchDeletePhotosResponse ¶
type BatchDeletePhotosResponse struct { // Status: The status for the operation to delete a single // Photo in the batch request. Status []*Status `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Status") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Status") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchDeletePhotosResponse: Response to batch delete of one or more Photos.
func (*BatchDeletePhotosResponse) MarshalJSON ¶
func (s *BatchDeletePhotosResponse) MarshalJSON() ([]byte, error)
type BatchGetPhotosResponse ¶
type BatchGetPhotosResponse struct { // Results: List of results for each individual // Photo requested, in the same order as // the requests in // BatchGetPhotos. Results []*PhotoResponse `json:"results,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Results") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Results") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchGetPhotosResponse: Response to batch get of Photos.
func (*BatchGetPhotosResponse) MarshalJSON ¶
func (s *BatchGetPhotosResponse) MarshalJSON() ([]byte, error)
type BatchUpdatePhotosRequest ¶
type BatchUpdatePhotosRequest struct { // UpdatePhotoRequests: Required. List of // UpdatePhotoRequests. UpdatePhotoRequests []*UpdatePhotoRequest `json:"updatePhotoRequests,omitempty"` // ForceSendFields is a list of field names (e.g. "UpdatePhotoRequests") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "UpdatePhotoRequests") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
BatchUpdatePhotosRequest: Request to update the metadata of photos. Updating the pixels of photos is not supported.
func (*BatchUpdatePhotosRequest) MarshalJSON ¶
func (s *BatchUpdatePhotosRequest) MarshalJSON() ([]byte, error)
type BatchUpdatePhotosResponse ¶
type BatchUpdatePhotosResponse struct { // Results: List of results for each individual // Photo updated, in the same order as // the request. Results []*PhotoResponse `json:"results,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Results") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Results") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchUpdatePhotosResponse: Response to batch update of metadata of one or more Photos.
func (*BatchUpdatePhotosResponse) MarshalJSON ¶
func (s *BatchUpdatePhotosResponse) MarshalJSON() ([]byte, error)
type Connection ¶
type Connection struct { // Target: Required. The destination of the connection from the // containing photo to // another photo. Target *PhotoId `json:"target,omitempty"` // ForceSendFields is a list of field names (e.g. "Target") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Target") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Connection: A connection is the link from a source photo to a destination photo.
func (*Connection) MarshalJSON ¶
func (s *Connection) MarshalJSON() ([]byte, error)
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
service Foo { rpc Bar(google.protobuf.Empty) returns
(google.protobuf.Empty);
}
The JSON representation for `Empty` is empty JSON object `{}`.
type LatLng ¶
type LatLng struct { // Latitude: The latitude in degrees. It must be in the range [-90.0, // +90.0]. Latitude float64 `json:"latitude,omitempty"` // Longitude: The longitude in degrees. It must be in the range [-180.0, // +180.0]. Longitude float64 `json:"longitude,omitempty"` // ForceSendFields is a list of field names (e.g. "Latitude") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Latitude") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
LatLng: An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 st andard</a>. Values must be within normalized ranges.
func (*LatLng) MarshalJSON ¶
func (*LatLng) UnmarshalJSON ¶
type Level ¶
type Level struct { // Name: Required. A name assigned to this Level, restricted to 3 // characters. // Consider how the elevator buttons would be labeled for this level if // there // was an elevator. Name string `json:"name,omitempty"` // Number: Floor number, used for ordering. 0 indicates the ground // level, 1 indicates // the first level above ground level, -1 indicates the first level // under // ground level. Non-integer values are OK. Number float64 `json:"number,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Level: Level information containing level number and its corresponding name.
func (*Level) MarshalJSON ¶
func (*Level) UnmarshalJSON ¶
type ListPhotosResponse ¶
type ListPhotosResponse struct { // NextPageToken: Token to retrieve the next page of results, or empty // if there are no more // results in the list. NextPageToken string `json:"nextPageToken,omitempty"` // Photos: List of photos. The maximum number of items returned is based // on the // pageSize field // in the request. Photos []*Photo `json:"photos,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListPhotosResponse: Response to list all photos that belong to a user.
func (*ListPhotosResponse) MarshalJSON ¶
func (s *ListPhotosResponse) MarshalJSON() ([]byte, error)
type Operation ¶
type Operation struct { // Done: If the value is `false`, it means the operation is still in // progress. // If `true`, the operation is completed, and either `error` or // `response` is // available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or // cancellation. Error *Status `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. // It typically // contains progress information and common metadata such as create // time. // Some services might not provide such metadata. Any method that // returns a // long-running operation should document the metadata type, if any. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: The server-assigned name, which is only unique within the same // service that // originally returns it. If you use the default HTTP mapping, // the // `name` should have the format of `operations/some/unique/name`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. // If the original // method returns no data on success, such as `Delete`, the response // is // `google.protobuf.Empty`. If the original method is // standard // `Get`/`Create`/`Update`, the response should be the resource. For // other // methods, the response should have the type `XxxResponse`, where // `Xxx` // is the original method name. For example, if the original method // name // is `TakeSnapshot()`, the inferred response type // is // `TakeSnapshotResponse`. Response googleapi.RawMessage `json:"response,omitempty"` // ForceSendFields is a list of field names (e.g. "Done") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Done") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶
type Photo ¶
type Photo struct { // CaptureTime: Absolute time when the photo was captured. // When the photo has no exif timestamp, this is used to set a timestamp // in // the photo metadata. CaptureTime string `json:"captureTime,omitempty"` // Connections: Connections to other photos. A connection represents the // link from this // photo to another photo. Connections []*Connection `json:"connections,omitempty"` // DownloadUrl: Output only. The download URL for the photo bytes. This // field is set only // when // GetPhotoRequest.view // is set to // PhotoView.INCLUDE_DOWNLOAD_URL. DownloadUrl string `json:"downloadUrl,omitempty"` // PhotoId: Required when updating a photo. Output only when creating a // photo. // Identifier for the photo, which is unique among all photos in // Google. PhotoId *PhotoId `json:"photoId,omitempty"` // Places: Places where this photo belongs. Places []*Place `json:"places,omitempty"` // Pose: Pose of the photo. Pose *Pose `json:"pose,omitempty"` ShareLink string `json:"shareLink,omitempty"` // ThumbnailUrl: Output only. The thumbnail URL for showing a preview of // the given photo. ThumbnailUrl string `json:"thumbnailUrl,omitempty"` // UploadReference: Required when creating a photo. Input only. The // resource URL where the // photo bytes are uploaded to. UploadReference *UploadRef `json:"uploadReference,omitempty"` // ViewCount: Output only. View count of the photo. ViewCount int64 `json:"viewCount,omitempty,string"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "CaptureTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CaptureTime") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Photo: Photo is used to store 360 photos along with photo metadata.
func (*Photo) MarshalJSON ¶
type PhotoCreateCall ¶
type PhotoCreateCall struct {
// contains filtered or unexported fields
}
func (*PhotoCreateCall) Context ¶
func (c *PhotoCreateCall) Context(ctx context.Context) *PhotoCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PhotoCreateCall) Do ¶
func (c *PhotoCreateCall) Do(opts ...googleapi.CallOption) (*Photo, error)
Do executes the "streetviewpublish.photo.create" call. Exactly one of *Photo or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Photo.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PhotoCreateCall) Fields ¶
func (c *PhotoCreateCall) Fields(s ...googleapi.Field) *PhotoCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PhotoCreateCall) Header ¶
func (c *PhotoCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type PhotoDeleteCall ¶
type PhotoDeleteCall struct {
// contains filtered or unexported fields
}
func (*PhotoDeleteCall) Context ¶
func (c *PhotoDeleteCall) Context(ctx context.Context) *PhotoDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PhotoDeleteCall) Do ¶
func (c *PhotoDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "streetviewpublish.photo.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PhotoDeleteCall) Fields ¶
func (c *PhotoDeleteCall) Fields(s ...googleapi.Field) *PhotoDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PhotoDeleteCall) Header ¶
func (c *PhotoDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type PhotoGetCall ¶
type PhotoGetCall struct {
// contains filtered or unexported fields
}
func (*PhotoGetCall) Context ¶
func (c *PhotoGetCall) Context(ctx context.Context) *PhotoGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PhotoGetCall) Do ¶
func (c *PhotoGetCall) Do(opts ...googleapi.CallOption) (*Photo, error)
Do executes the "streetviewpublish.photo.get" call. Exactly one of *Photo or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Photo.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PhotoGetCall) Fields ¶
func (c *PhotoGetCall) Fields(s ...googleapi.Field) *PhotoGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PhotoGetCall) Header ¶
func (c *PhotoGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PhotoGetCall) IfNoneMatch ¶
func (c *PhotoGetCall) IfNoneMatch(entityTag string) *PhotoGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*PhotoGetCall) View ¶
func (c *PhotoGetCall) View(view string) *PhotoGetCall
View sets the optional parameter "view": Specifies if a download URL for the photo bytes should be returned in the Photo response.
Possible values:
"BASIC" "INCLUDE_DOWNLOAD_URL"
type PhotoId ¶
type PhotoId struct { // Id: Required. A unique identifier for a photo. Id string `json:"id,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Id") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
PhotoId: Identifier for a Photo.
func (*PhotoId) MarshalJSON ¶
type PhotoResponse ¶
type PhotoResponse struct { // Photo: The Photo resource, if the request // was successful. Photo *Photo `json:"photo,omitempty"` // Status: The status for the operation to get or update a single photo // in the batch // request. Status *Status `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "Photo") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Photo") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
PhotoResponse: Response payload for a single Photo in batch operations including BatchGetPhotos and BatchUpdatePhotos.
func (*PhotoResponse) MarshalJSON ¶
func (s *PhotoResponse) MarshalJSON() ([]byte, error)
type PhotoService ¶
type PhotoService struct {
// contains filtered or unexported fields
}
func NewPhotoService ¶
func NewPhotoService(s *Service) *PhotoService
func (*PhotoService) Create ¶
func (r *PhotoService) Create(photo *Photo) *PhotoCreateCall
Create: After the client finishes uploading the photo with the returned UploadRef, CreatePhoto publishes the uploaded Photo to Street View on Google Maps.
Currently, the only way to set heading, pitch, and roll in CreatePhoto is through the [Photo Sphere XMP metadata](https://developers.google.com/streetview/spherical-metad ata) in the photo bytes. The `pose.heading`, `pose.pitch`, `pose.roll`, `pose.altitude`, and `pose.level` fields in Pose are ignored for CreatePhoto.
This method returns the following error codes:
* google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if the uploaded photo is not a 360 photo. * google.rpc.Code.NOT_FOUND if the upload reference does not exist. * google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the storage limit.
func (*PhotoService) Delete ¶
func (r *PhotoService) Delete(photoId string) *PhotoDeleteCall
Delete: Deletes a Photo 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. * google.rpc.Code.NOT_FOUND if the photo ID does not exist.
func (*PhotoService) Get ¶
func (r *PhotoService) Get(photoId string) *PhotoGetCall
Get: Gets the metadata of the specified Photo.
This method returns the following error codes:
* google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested Photo. * google.rpc.Code.NOT_FOUND if the requested Photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed.
func (*PhotoService) StartUpload ¶
func (r *PhotoService) StartUpload(empty *Empty) *PhotoStartUploadCall
StartUpload: Creates an upload session to start uploading photo bytes. The upload URL of the returned UploadRef is used to upload the bytes for the Photo.
In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275 604, the photo must also meet the following requirements:
* Photo Sphere XMP metadata must be included in the photo medadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275 604, and the photo must be a full 360 horizontally.
After the upload is complete, the UploadRef is used with CreatePhoto to create the Photo object entry.
func (*PhotoService) Update ¶
func (r *PhotoService) Update(id string, photo *Photo) *PhotoUpdateCall
Update: Updates the metadata of a Photo, such as pose, place association, connections, etc. Changing the pixels of a photo is not supported.
Only the fields specified in the updateMask field are used. If `updateMask` is not present, the update applies to all fields.
<aside class="note"><b>Note:</b> To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail.</aside>
This method returns the following error codes:
* google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. * google.rpc.Code.INVALID_ARGUMENT if the request is malformed. * google.rpc.Code.NOT_FOUND if the requested photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed.
type PhotoStartUploadCall ¶
type PhotoStartUploadCall struct {
// contains filtered or unexported fields
}
func (*PhotoStartUploadCall) Context ¶
func (c *PhotoStartUploadCall) Context(ctx context.Context) *PhotoStartUploadCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PhotoStartUploadCall) Do ¶
func (c *PhotoStartUploadCall) Do(opts ...googleapi.CallOption) (*UploadRef, error)
Do executes the "streetviewpublish.photo.startUpload" call. Exactly one of *UploadRef or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *UploadRef.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PhotoStartUploadCall) Fields ¶
func (c *PhotoStartUploadCall) Fields(s ...googleapi.Field) *PhotoStartUploadCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PhotoStartUploadCall) Header ¶
func (c *PhotoStartUploadCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type PhotoUpdateCall ¶
type PhotoUpdateCall struct {
// contains filtered or unexported fields
}
func (*PhotoUpdateCall) Context ¶
func (c *PhotoUpdateCall) Context(ctx context.Context) *PhotoUpdateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PhotoUpdateCall) Do ¶
func (c *PhotoUpdateCall) Do(opts ...googleapi.CallOption) (*Photo, error)
Do executes the "streetviewpublish.photo.update" call. Exactly one of *Photo or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Photo.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PhotoUpdateCall) Fields ¶
func (c *PhotoUpdateCall) Fields(s ...googleapi.Field) *PhotoUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PhotoUpdateCall) Header ¶
func (c *PhotoUpdateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PhotoUpdateCall) UpdateMask ¶
func (c *PhotoUpdateCall) UpdateMask(updateMask string) *PhotoUpdateCall
UpdateMask sets the optional parameter "updateMask": Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata will be entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list.
The following fields are valid:
* `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places`
<aside class="note"><b>Note:</b> Repeated fields in updateMask mean the entire set of repeated values will be replaced with the new contents. For example, if updateMask contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections will be removed.</aside>
type PhotosBatchDeleteCall ¶
type PhotosBatchDeleteCall struct {
// contains filtered or unexported fields
}
func (*PhotosBatchDeleteCall) Context ¶
func (c *PhotosBatchDeleteCall) Context(ctx context.Context) *PhotosBatchDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PhotosBatchDeleteCall) Do ¶
func (c *PhotosBatchDeleteCall) Do(opts ...googleapi.CallOption) (*BatchDeletePhotosResponse, error)
Do executes the "streetviewpublish.photos.batchDelete" call. Exactly one of *BatchDeletePhotosResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchDeletePhotosResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PhotosBatchDeleteCall) Fields ¶
func (c *PhotosBatchDeleteCall) Fields(s ...googleapi.Field) *PhotosBatchDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PhotosBatchDeleteCall) Header ¶
func (c *PhotosBatchDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type PhotosBatchGetCall ¶
type PhotosBatchGetCall struct {
// contains filtered or unexported fields
}
func (*PhotosBatchGetCall) Context ¶
func (c *PhotosBatchGetCall) Context(ctx context.Context) *PhotosBatchGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PhotosBatchGetCall) Do ¶
func (c *PhotosBatchGetCall) Do(opts ...googleapi.CallOption) (*BatchGetPhotosResponse, error)
Do executes the "streetviewpublish.photos.batchGet" call. Exactly one of *BatchGetPhotosResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchGetPhotosResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PhotosBatchGetCall) Fields ¶
func (c *PhotosBatchGetCall) Fields(s ...googleapi.Field) *PhotosBatchGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PhotosBatchGetCall) Header ¶
func (c *PhotosBatchGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PhotosBatchGetCall) IfNoneMatch ¶
func (c *PhotosBatchGetCall) IfNoneMatch(entityTag string) *PhotosBatchGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*PhotosBatchGetCall) PhotoIds ¶
func (c *PhotosBatchGetCall) PhotoIds(photoIds ...string) *PhotosBatchGetCall
PhotoIds sets the optional parameter "photoIds": Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=<id1>&photoIds=<id2>&...`.
func (*PhotosBatchGetCall) View ¶
func (c *PhotosBatchGetCall) View(view string) *PhotosBatchGetCall
View sets the optional parameter "view": Specifies if a download URL for the photo bytes should be returned in the Photo response.
Possible values:
"BASIC" "INCLUDE_DOWNLOAD_URL"
type PhotosBatchUpdateCall ¶
type PhotosBatchUpdateCall struct {
// contains filtered or unexported fields
}
func (*PhotosBatchUpdateCall) Context ¶
func (c *PhotosBatchUpdateCall) Context(ctx context.Context) *PhotosBatchUpdateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PhotosBatchUpdateCall) Do ¶
func (c *PhotosBatchUpdateCall) Do(opts ...googleapi.CallOption) (*BatchUpdatePhotosResponse, error)
Do executes the "streetviewpublish.photos.batchUpdate" call. Exactly one of *BatchUpdatePhotosResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchUpdatePhotosResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PhotosBatchUpdateCall) Fields ¶
func (c *PhotosBatchUpdateCall) Fields(s ...googleapi.Field) *PhotosBatchUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PhotosBatchUpdateCall) Header ¶
func (c *PhotosBatchUpdateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type PhotosListCall ¶
type PhotosListCall struct {
// contains filtered or unexported fields
}
func (*PhotosListCall) Context ¶
func (c *PhotosListCall) Context(ctx context.Context) *PhotosListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PhotosListCall) Do ¶
func (c *PhotosListCall) Do(opts ...googleapi.CallOption) (*ListPhotosResponse, error)
Do executes the "streetviewpublish.photos.list" call. Exactly one of *ListPhotosResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListPhotosResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PhotosListCall) Fields ¶
func (c *PhotosListCall) Fields(s ...googleapi.Field) *PhotosListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PhotosListCall) Filter ¶
func (c *PhotosListCall) Filter(filter string) *PhotosListCall
Filter sets the optional parameter "filter": The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.
The only filter supported at the moment is `placeId`.
func (*PhotosListCall) Header ¶
func (c *PhotosListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PhotosListCall) IfNoneMatch ¶
func (c *PhotosListCall) IfNoneMatch(entityTag string) *PhotosListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*PhotosListCall) PageSize ¶
func (c *PhotosListCall) PageSize(pageSize int64) *PhotosListCall
PageSize sets the optional parameter "pageSize": The maximum number of photos to return. `pageSize` must be non-negative. If `pageSize` is zero or is not provided, the default page size of 100 will be used. The number of photos returned in the response may be less than `pageSize` if the number of photos that belong to the user is less than `pageSize`.
func (*PhotosListCall) PageToken ¶
func (c *PhotosListCall) PageToken(pageToken string) *PhotosListCall
PageToken sets the optional parameter "pageToken": The nextPageToken value returned from a previous ListPhotos request, if any.
func (*PhotosListCall) Pages ¶
func (c *PhotosListCall) Pages(ctx context.Context, f func(*ListPhotosResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*PhotosListCall) View ¶
func (c *PhotosListCall) View(view string) *PhotosListCall
View sets the optional parameter "view": Specifies if a download URL for the photos bytes should be returned in the Photos response.
Possible values:
"BASIC" "INCLUDE_DOWNLOAD_URL"
type PhotosService ¶
type PhotosService struct {
// contains filtered or unexported fields
}
func NewPhotosService ¶
func NewPhotosService(s *Service) *PhotosService
func (*PhotosService) BatchDelete ¶
func (r *PhotosService) BatchDelete(batchdeletephotosrequest *BatchDeletePhotosRequest) *PhotosBatchDeleteCall
BatchDelete: Deletes a list of Photos and their metadata.
Note that if BatchDeletePhotos fails, either critical fields are missing or there was an authentication error. Even if BatchDeletePhotos succeeds, there may have been failures for single photos in the batch. These failures will be specified in each PhotoResponse.status in BatchDeletePhotosResponse.results. See De letePhoto for specific failures that can occur per photo.
func (*PhotosService) BatchGet ¶
func (r *PhotosService) BatchGet() *PhotosBatchGetCall
BatchGet: Gets the metadata of the specified Photo batch.
Note that if BatchGetPhotos fails, either critical fields are missing or there was an authentication error. Even if BatchGetPhotos succeeds, there may have been failures for single photos in the batch. These failures will be specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPh oto for specific failures that can occur per photo.
func (*PhotosService) BatchUpdate ¶
func (r *PhotosService) BatchUpdate(batchupdatephotosrequest *BatchUpdatePhotosRequest) *PhotosBatchUpdateCall
BatchUpdate: Updates the metadata of Photos, such as pose, place association, connections, etc. Changing the pixels of photos is not supported.
Note that if BatchUpdatePhotos fails, either critical fields are missing or there was an authentication error. Even if BatchUpdatePhotos succeeds, there may have been failures for single photos in the batch. These failures will be specified in each PhotoResponse.status in BatchUpdatePhotosResponse.results. See Up datePhoto for specific failures that can occur per photo.
Only the fields specified in updateMask field are used. If `updateMask` is not present, the update applies to all fields.
<aside class="note"><b>Note:</b> To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail.</aside>
func (*PhotosService) List ¶
func (r *PhotosService) List() *PhotosListCall
List: Lists all the Photos that belong to the user.
<aside class="note"><b>Note:</b> Recently created photos that are still being indexed are not returned in the response.</aside>
type Place ¶
type Place struct { // PlaceId: Place identifier, as described // in // https://developers.google.com/places/place-id. PlaceId string `json:"placeId,omitempty"` // ForceSendFields is a list of field names (e.g. "PlaceId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "PlaceId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Place: Place metadata for an entity.
func (*Place) MarshalJSON ¶
type Pose ¶
type Pose struct { // Altitude: Altitude of the pose in meters above WGS84 ellipsoid. // NaN indicates an unmeasured quantity. Altitude float64 `json:"altitude,omitempty"` // Heading: Compass heading, measured at the center of the photo in // degrees clockwise // from North. Value must be >=0 and <360. // NaN indicates an unmeasured quantity. Heading float64 `json:"heading,omitempty"` // LatLngPair: Latitude and longitude pair of the pose, as explained // here: // https://cloud.google.com/datastore/docs/reference/rest/Shared.Ty // pes/LatLng // When creating a Photo, if the // latitude and longitude pair are not provided here, the geolocation // from the // exif header will be used. If the latitude and longitude pair is // not // provided and cannot be found in the exif header, the create photo // process // will fail. LatLngPair *LatLng `json:"latLngPair,omitempty"` // Level: Level (the floor in a building) used to configure vertical // navigation. Level *Level `json:"level,omitempty"` // Pitch: Pitch, measured at the center of the photo in degrees. Value // must be >=-90 // and <= 90. A value of -90 means looking directly down, and a value of // 90 // means looking directly up. // NaN indicates an unmeasured quantity. Pitch float64 `json:"pitch,omitempty"` // Roll: Roll, measured in degrees. Value must be >= 0 and <360. A value // of 0 // means level with the horizon. // NaN indicates an unmeasured quantity. Roll float64 `json:"roll,omitempty"` // ForceSendFields is a list of field names (e.g. "Altitude") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Altitude") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Pose: Raw pose measurement for an entity.
func (*Pose) MarshalJSON ¶
func (*Pose) UnmarshalJSON ¶
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Photo *PhotoService Photos *PhotosService // contains filtered or unexported fields }
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a // common set of // message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any // user-facing error message should be localized and sent in // the // google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:
- Simple to use and understand for most users - Flexible enough to meet unexpected needs
Overview ¶
The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions.
Language mapping ¶
The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.
Other uses ¶
The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.
Example uses of this error model include:
- Partial errors. If a service needs to return partial errors to the client,
it may embed the `Status` in the normal response to indicate the
partial
errors.
- Workflow errors. A typical workflow has multiple steps. Each step may
have a `Status` message for error reporting.
- Batch operations. If a client uses batch request and batch response, the
`Status` message should be used directly inside batch response,
one for
each error sub-response.
- Asynchronous operations. If an API call embeds asynchronous operation
results in its response, the status of those operations should
be
represented directly using the `Status` message.
- Logging. If some API errors are stored in logs, the message `Status` could
be used directly after any stripping needed for security/privacy
reasons.
func (*Status) MarshalJSON ¶
type UpdatePhotoRequest ¶
type UpdatePhotoRequest struct { // Photo: Required. Photo object containing the // new metadata. Photo *Photo `json:"photo,omitempty"` // UpdateMask: Mask that identifies fields on the photo metadata to // update. // If not present, the old Photo // metadata will be entirely replaced with the // new Photo metadata in this request. // The update fails if invalid fields are specified. Multiple fields can // be // specified in a comma-delimited list. // // The following fields are valid: // // * `pose.heading` // * `pose.latLngPair` // * `pose.pitch` // * `pose.roll` // * `pose.level` // * `pose.altitude` // * `connections` // * `places` // // // <aside class="note"><b>Note:</b> Repeated fields in // updateMask // mean the entire set of repeated values will be replaced with the // new // contents. For example, if // updateMask // contains `connections` and `UpdatePhotoRequest.photo.connections` is // empty, // all connections will be removed.</aside> UpdateMask string `json:"updateMask,omitempty"` // ForceSendFields is a list of field names (e.g. "Photo") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Photo") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
UpdatePhotoRequest: Request to update the metadata of a Photo. Updating the pixels of a photo is not supported.
func (*UpdatePhotoRequest) MarshalJSON ¶
func (s *UpdatePhotoRequest) MarshalJSON() ([]byte, error)
type UploadRef ¶
type UploadRef struct { // UploadUrl: Required. An upload reference should be unique for each // user. It follows // the // form: // "https://streetviewpublish.googleapis.com/media/user/{account_id // }/photo/{upload_reference}" UploadUrl string `json:"uploadUrl,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "UploadUrl") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "UploadUrl") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
UploadRef: Upload reference for media files.