Documentation
¶
Overview ¶
Package googleapi contains the common code shared by all Google API libraries.
Index ¶
- Constants
- Variables
- func Bool(v bool) *bool
- func CheckMediaResponse(res *http.Response) error
- func CheckResponse(res *http.Response) error
- func CloseBody(res *http.Response)
- func CombineFields(s []Field) string
- func ConvertVariant(v map[string]interface{}, dst interface{}) bool
- func Expand(u *url.URL, expansions map[string]string)
- func Float64(v float64) *float64
- func Int32(v int32) *int32
- func Int64(v int64) *int64
- func IsNotModified(err error) bool
- func ResolveRelative(basestr, relstr string) string
- func String(v string) *string
- func Uint32(v uint32) *uint32
- func Uint64(v uint64) *uint64
- func VariantType(t map[string]interface{}) string
- type CallOption
- type ContentTyper
- type Error
- type ErrorItem
- type Field
- type Float64s
- type Int32s
- type Int64s
- type MarshalStyle
- type MediaOption
- type MediaOptions
- type MultiCallOption
- type ProgressUpdater
- type RawMessage
- type ServerResponse
- type SizeReaderAt
- type Uint32s
- type Uint64s
Constants ¶
const ( // Version defines the gax version being used. This is typically sent // in an HTTP header to services. Version = "0.5" // UserAgent is the header string used to identify this package. UserAgent = "google-api-go-client/" + Version // DefaultUploadChunkSize is the default chunk size to use for resumable // uploads if not specified by the user. DefaultUploadChunkSize = 16 * 1024 * 1024 // MinUploadChunkSize is the minimum chunk size that can be used for // resumable uploads. All user-specified chunk sizes must be multiple of // this value. MinUploadChunkSize = 256 * 1024 )
Variables ¶
var WithDataWrapper = MarshalStyle(true)
WithDataWrapper marshals JSON with a {"data": ...} wrapper.
var WithoutDataWrapper = MarshalStyle(false)
WithoutDataWrapper marshals JSON without a {"data": ...} wrapper.
Functions ¶
func Bool ¶
Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
func CheckMediaResponse ¶
CheckMediaResponse returns an error (of type *Error) if the response status code is not 2xx. Unlike CheckResponse it does not assume the body is a JSON error document. It is the caller's responsibility to close res.Body.
func CheckResponse ¶
CheckResponse returns an error (of type *Error) if the response status code is not 2xx.
func CloseBody ¶
CloseBody is used to close res.Body. Prior to calling Close, it also tries to Read a small amount to see an EOF. Not seeing an EOF can prevent HTTP Transports from reusing connections.
func CombineFields ¶
CombineFields combines fields into a single string.
func ConvertVariant ¶
ConvertVariant uses the JSON encoder/decoder to fill in the struct 'dst' with the fields found in variant 'v'. This is used to support "variant" APIs that can return one of a number of different types. It reports whether the conversion was successful.
func Expand ¶
Expand subsitutes any {encoded} strings in the URL passed in using the map supplied.
This calls SetOpaque to avoid encoding of the parameters in the URL path.
func Float64 ¶
Float64 is a helper routine that allocates a new float64 value to store v and returns a pointer to it.
func Int32 ¶
Int32 is a helper routine that allocates a new int32 value to store v and returns a pointer to it.
func Int64 ¶
Int64 is a helper routine that allocates a new int64 value to store v and returns a pointer to it.
func IsNotModified ¶
IsNotModified reports whether err is the result of the server replying with http.StatusNotModified. Such error values are sometimes returned by "Do" methods on calls when If-None-Match is used.
func ResolveRelative ¶
ResolveRelative resolves relatives such as "http://www.golang.org/" and "topics/myproject/mytopic" into a single string, such as "http://www.golang.org/topics/myproject/mytopic". It strips all parent references (e.g. ../..) as well as anything after the host (e.g. /bar/gaz gets stripped out of foo.com/bar/gaz).
ResolveRelative panics if either basestr or relstr is not able to be parsed.
func String ¶
String is a helper routine that allocates a new string value to store v and returns a pointer to it.
func Uint32 ¶
Uint32 is a helper routine that allocates a new uint32 value to store v and returns a pointer to it.
func Uint64 ¶
Uint64 is a helper routine that allocates a new uint64 value to store v and returns a pointer to it.
func VariantType ¶
VariantType returns the type name of the given variant. If the map doesn't contain the named key or the value is not a []interface{}, "" is returned. This is used to support "variant" APIs that can return one of a number of different types.
Types ¶
type CallOption ¶
type CallOption interface {
Get() (key, value string)
}
A CallOption is an optional argument to an API call. It should be treated as an opaque value by users of Google APIs.
A CallOption is something that configures an API call in a way that is not specific to that API; for instance, controlling the quota user for an API call is common across many APIs, and is thus a CallOption.
func QueryParameter ¶ added in v0.53.0
func QueryParameter(key string, values ...string) CallOption
QueryParameter allows setting the value(s) of an arbitrary key.
func QuotaUser ¶
func QuotaUser(u string) CallOption
QuotaUser returns a CallOption that will set the quota user for a call. The quota user can be used by server-side applications to control accounting. It can be an arbitrary string up to 40 characters, and will override UserIP if both are provided.
func Trace ¶
func Trace(traceToken string) CallOption
Trace returns a CallOption that enables diagnostic tracing for a call. traceToken is an ID supplied by Google support.
func UserIP ¶
func UserIP(ip string) CallOption
UserIP returns a CallOption that will set the "userIp" parameter of a call. This should be the IP address of the originating request.
type ContentTyper ¶
type ContentTyper interface {
ContentType() string
}
ContentTyper is an interface for Readers which know (or would like to override) their Content-Type. If a media body doesn't implement ContentTyper, the type is sniffed from the content using http.DetectContentType.
type Error ¶
type Error struct {
// Code is the HTTP response status code and will always be populated.
Code int `json:"code"`
// Message is the server response message and is only populated when
// explicitly referenced by the JSON server response.
Message string `json:"message"`
// Details provide more context to an error.
Details []interface{} `json:"details"`
// Body is the raw response returned by the server.
// It is often but not always JSON, depending on how the request fails.
Body string
// Header contains the response header fields from the server.
Header http.Header
Errors []ErrorItem
}
Error contains an error response from the server.
type ErrorItem ¶
type ErrorItem struct {
// Reason is the typed error code. For example: "some_example".
Reason string `json:"reason"`
// Message is the human-readable description of the error.
Message string `json:"message"`
}
ErrorItem is a detailed error code & message from the Google API frontend.
type Field ¶
type Field string
A Field names a field to be retrieved with a partial response. https://cloud.google.com/storage/docs/json_api/v1/how-tos/performance
Partial responses can dramatically reduce the amount of data that must be sent to your application. In order to request partial responses, you can specify the full list of fields that your application needs by adding the Fields option to your request.
Field strings use camelCase with leading lower-case characters to identify fields within the response.
For example, if your response has a "NextPageToken" and a slice of "Items" with "Id" fields, you could request just those fields like this:
svc.Events.List().Fields("nextPageToken", "items/id").Do()
or if you were also interested in each Item's "Updated" field, you can combine them like this:
svc.Events.List().Fields("nextPageToken", "items(id,updated)").Do()
Another way to find field names is through the Google API explorer: https://developers.google.com/apis-explorer/#p/
type Float64s ¶
type Float64s []float64
Float64s is a slice of float64s that marshal as quoted strings in JSON.
func (Float64s) MarshalJSON ¶
func (*Float64s) UnmarshalJSON ¶
type Int32s ¶
type Int32s []int32
Int32s is a slice of int32s that marshal as quoted strings in JSON.
func (Int32s) MarshalJSON ¶
func (*Int32s) UnmarshalJSON ¶
type Int64s ¶
type Int64s []int64
Int64s is a slice of int64s that marshal as quoted strings in JSON.
func (Int64s) MarshalJSON ¶
func (*Int64s) UnmarshalJSON ¶
type MarshalStyle ¶
type MarshalStyle bool
MarshalStyle defines whether to marshal JSON with a {"data": ...} wrapper.
func (MarshalStyle) JSONReader ¶
func (wrap MarshalStyle) JSONReader(v interface{}) (io.Reader, error)
type MediaOption ¶
type MediaOption interface {
// contains filtered or unexported methods
}
MediaOption defines the interface for setting media options.
func ChunkSize ¶
func ChunkSize(size int) MediaOption
ChunkSize returns a MediaOption which sets the chunk size for media uploads. size will be rounded up to the nearest multiple of 256K. Media which contains fewer than size bytes will be uploaded in a single request. Media which contains size bytes or more will be uploaded in separate chunks. If size is zero, media will be uploaded in a single request.
func ContentType ¶
func ContentType(ctype string) MediaOption
ContentType returns a MediaOption which sets the Content-Type header for media uploads. If ctype is empty, the Content-Type header will be omitted.
type MediaOptions ¶
MediaOptions stores options for customizing media upload. It is not used by developers directly.
func ProcessMediaOptions ¶
func ProcessMediaOptions(opts []MediaOption) *MediaOptions
ProcessMediaOptions stores options from opts in a MediaOptions. It is not used by developers directly.
type MultiCallOption ¶ added in v0.53.0
type MultiCallOption interface {
CallOption
GetMulti() (key string, value []string)
}
A MultiCallOption is an option argument to an API call and can be passed anywhere a CallOption is accepted. It additionally supports returning a slice of values for a given key.
type ProgressUpdater ¶
type ProgressUpdater func(current, total int64)
ProgressUpdater is a function that is called upon every progress update of a resumable upload. This is the only part of a resumable upload (from googleapi) that is usable by the developer. The remaining usable pieces of resumable uploads is exposed in each auto-generated API.
type RawMessage ¶
type RawMessage []byte
RawMessage is a raw encoded JSON value. It is identical to json.RawMessage, except it does not suffer from https://golang.org/issue/14493.
func (RawMessage) MarshalJSON ¶
func (m RawMessage) MarshalJSON() ([]byte, error)
MarshalJSON returns m.
func (*RawMessage) UnmarshalJSON ¶
func (m *RawMessage) UnmarshalJSON(data []byte) error
UnmarshalJSON sets *m to a copy of data.
type ServerResponse ¶
type ServerResponse struct {
// HTTPStatusCode is the server's response status code. When using a
// resource method's Do call, this will always be in the 2xx range.
HTTPStatusCode int
// Header contains the response header fields from the server.
Header http.Header
}
ServerResponse is embedded in each Do response and provides the HTTP status code and header sent by the server.
type SizeReaderAt ¶
A SizeReaderAt is a ReaderAt with a Size method. An io.SectionReader implements SizeReaderAt.
type Uint32s ¶
type Uint32s []uint32
Uint32s is a slice of uint32s that marshal as quoted strings in JSON.
Source Files
Directories