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)

var WithDataWrapper =MarshalStyle(true)

var WithoutDataWrapper =MarshalStyle(false)

funcBool¶

func Bool(vbool) *bool

Bool is a helper routine that allocates a new bool valueto store v and returns a pointer to it.

funcCheckMediaResponse¶

func CheckMediaResponse(res *http.Response)error

CheckMediaResponse returns an error (of type *Error) if the responsestatus code is not 2xx. Unlike CheckResponse it does not assume thebody is a JSON error document.It is the caller's responsibility to close res.Body.

funcCheckResponse¶

func CheckResponse(res *http.Response)error

CheckResponse returns an error (of type *Error) if the responsestatus code is not 2xx.

funcCheckResponseWithBody¶added inv0.218.0

func CheckResponseWithBody(res *http.Response, body []byte)error

CheckResponseWithBody returns an error (of type *Error) if the responsestatus code is not 2xx. Distinct from CheckResponse to allow for checkinga previously-read body to maintain error detail content.

funcCloseBody¶

func CloseBody(res *http.Response)

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.

funcCombineFields¶

func CombineFields(s []Field)string

CombineFields combines fields into a single string.

funcConvertVariant¶

func ConvertVariant(v map[string]interface{}, dst interface{})bool

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.

funcExpand¶

func Expand(u *url.URL, expansions map[string]string)

Expand subsitutes any {encoded} strings in the URL passed in usingthe map supplied.

This calls SetOpaque to avoid encoding of the parameters in the URL path.

funcFloat64¶

func Float64(vfloat64) *float64

Float64 is a helper routine that allocates a new float64 valueto store v and returns a pointer to it.

funcInt32¶

func Int32(vint32) *int32

Int32 is a helper routine that allocates a new int32 valueto store v and returns a pointer to it.

funcInt64¶

func Int64(vint64) *int64

Int64 is a helper routine that allocates a new int64 valueto store v and returns a pointer to it.

funcIsNotModified¶

func IsNotModified(errerror)bool

IsNotModified reports whether err is the result of theserver replying with http.StatusNotModified.Such error values are sometimes returned by "Do" methodson calls when If-None-Match is used.

funcResolveRelative¶

func ResolveRelative(basestr, relstrstring)string

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 parentreferences (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.

funcString¶

func String(vstring) *string

String is a helper routine that allocates a new string valueto store v and returns a pointer to it.

funcUint32¶

func Uint32(vuint32) *uint32

Uint32 is a helper routine that allocates a new uint32 valueto store v and returns a pointer to it.

funcUint64¶

func Uint64(vuint64) *uint64

Uint64 is a helper routine that allocates a new uint64 valueto store v and returns a pointer to it.

funcVariantType¶

func VariantType(t map[string]interface{})string

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.

typeCallOption¶

type CallOption interface {Get() (key, valuestring)}

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 isnot specific to that API; for instance, controlling the quota user foran API call is common across many APIs, and is thus a CallOption.

func QueryParameter(keystring, values ...string)CallOption

func QuotaUser(ustring)CallOption

func Trace(traceTokenstring)CallOption

func UserIP(ipstring)CallOption

typeContentTyper¶

type ContentTyper interface {ContentType()string}

ContentTyper is an interface for Readers which know (or would liketo override) their Content-Type. If a media body doesn't implementContentTyper, the type is sniffed from the content usinghttp.DetectContentType.

typeError¶

type Error struct {// Code is the HTTP response status code and will always be populated.Codeint `json:"code"`// Message is the server response message and is only populated when// explicitly referenced by the JSON server response.Messagestring `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.Bodystring// Header contains the response header fields from the server.Headerhttp.HeaderErrors []ErrorItem// contains filtered or unexported fields}

Error contains an error response from the server.

func (e *Error) Error()string

func (e *Error) Unwrap()error

func (e *Error) Wrap(errerror)

typeErrorItem¶

type ErrorItem struct {// Reason is the typed error code. For example: "some_example".Reasonstring `json:"reason"`// Message is the human-readable description of the error.Messagestring `json:"message"`}

ErrorItem is a detailed error code & message from the Google API frontend.

typeField¶

type Fieldstring

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 fieldsthat 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/

typeFloat64s¶

type Float64s []float64

Float64s is a slice of float64s that marshal as quoted strings in JSON.

func (qFloat64s) MarshalJSON() ([]byte,error)

func (q *Float64s) UnmarshalJSON(raw []byte)error

typeInt32s¶

type Int32s []int32

Int32s is a slice of int32s that marshal as quoted strings in JSON.

func (qInt32s) MarshalJSON() ([]byte,error)

func (q *Int32s) UnmarshalJSON(raw []byte)error

typeInt64s¶

type Int64s []int64

Int64s is a slice of int64s that marshal as quoted strings in JSON.

func (qInt64s) MarshalJSON() ([]byte,error)

func (q *Int64s) UnmarshalJSON(raw []byte)error

typeMarshalStyle¶

type MarshalStylebool

MarshalStyle defines whether to marshal JSON with a {"data": ...} wrapper.

func (wrapMarshalStyle) JSONBuffer(v interface{}) (*bytes.Buffer,error)

func (wrapMarshalStyle) JSONReader(v interface{}) (io.Reader,error)

typeMediaOption¶

type MediaOption interface {// contains filtered or unexported methods}

MediaOption defines the interface for setting media options.

func ChunkRetryDeadline(deadlinetime.Duration)MediaOption

func ChunkSize(sizeint)MediaOption

func ChunkTransferTimeout(timeouttime.Duration)MediaOption

func ContentType(ctypestring)MediaOption

typeMediaOptions¶

type MediaOptions struct {ContentTypestringForceEmptyContentTypeboolChunkSizeintChunkRetryDeadlinetime.DurationChunkTransferTimeouttime.Duration}

MediaOptions stores options for customizing media upload. It is not used by developers directly.

func ProcessMediaOptions(opts []MediaOption) *MediaOptions

typeMultiCallOption¶added inv0.53.0

type MultiCallOption interface {CallOptionGetMulti() (keystring, value []string)}

A MultiCallOption is an option argument to an API call and can be passedanywhere a CallOption is accepted. It additionally supports returning a sliceof values for a given key.

typeProgressUpdater¶

type ProgressUpdater func(current, totalint64)

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.

typeRawMessage¶

type RawMessage []byte

RawMessage is a raw encoded JSON value.It is identical to json.RawMessage, except it does not suffer fromhttps://golang.org/issue/14493.

func (mRawMessage) MarshalJSON() ([]byte,error)

func (m *RawMessage) UnmarshalJSON(data []byte)error

typeServerResponse¶

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.HTTPStatusCodeint// Header contains the response header fields from the server.Headerhttp.Header}

ServerResponse is embedded in each Do response andprovides the HTTP status code and header sent by the server.

typeSizeReaderAt¶

type SizeReaderAt interface {io.ReaderAtSize()int64}

A SizeReaderAt is a ReaderAt with a Size method.An io.SectionReader implements SizeReaderAt.

typeUint32s¶

type Uint32s []uint32

Uint32s is a slice of uint32s that marshal as quoted strings in JSON.

func (qUint32s) MarshalJSON() ([]byte,error)

func (q *Uint32s) UnmarshalJSON(raw []byte)error

typeUint64s¶

type Uint64s []uint64

Uint64s is a slice of uint64s that marshal as quoted strings in JSON.

func (qUint64s) MarshalJSON() ([]byte,error)

func (q *Uint64s) UnmarshalJSON(raw []byte)error