discovery

package
v0.195.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 28, 2024 License: BSD-3-Clause Imports: 16 Imported by: 40

Documentation

Overview

Package discovery provides access to the API Discovery Service.

For product documentation, see: https://developers.google.com/discovery/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/discovery/v1"
...
ctx := context.Background()
discoveryService, err := discovery.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

discoveryService, err := discovery.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
discoveryService, err := discovery.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApisGetRestCall 

type ApisGetRestCall struct {
	// contains filtered or unexported fields
}

func (*ApisGetRestCall) Context 

func (c *ApisGetRestCall) Context(ctx context.Context) *ApisGetRestCall

Context sets the context to be used in this call's Do method.

func (*ApisGetRestCall) Do 

func (c *ApisGetRestCall) Do(opts ...googleapi.CallOption) (*RestDescription, error)

Do executes the "discovery.apis.getRest" call. Any non-2xx status code is an error. Response headers are in either *RestDescription.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 (*ApisGetRestCall) Fields 

func (c *ApisGetRestCall) Fields(s ...googleapi.Field) *ApisGetRestCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ApisGetRestCall) Header 

func (c *ApisGetRestCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ApisGetRestCall) IfNoneMatch 

func (c *ApisGetRestCall) IfNoneMatch(entityTag string) *ApisGetRestCall

IfNoneMatch sets an 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.

type ApisListCall 

type ApisListCall struct {
	// contains filtered or unexported fields
}

func (*ApisListCall) Context 

func (c *ApisListCall) Context(ctx context.Context) *ApisListCall

Context sets the context to be used in this call's Do method.

func (*ApisListCall) Do 

func (c *ApisListCall) Do(opts ...googleapi.CallOption) (*DirectoryList, error)

Do executes the "discovery.apis.list" call. Any non-2xx status code is an error. Response headers are in either *DirectoryList.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 (*ApisListCall) Fields 

func (c *ApisListCall) Fields(s ...googleapi.Field) *ApisListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ApisListCall) Header 

func (c *ApisListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ApisListCall) IfNoneMatch 

func (c *ApisListCall) IfNoneMatch(entityTag string) *ApisListCall

IfNoneMatch sets an 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.

func (*ApisListCall) Name 

func (c *ApisListCall) Name(name string) *ApisListCall

Name sets the optional parameter "name": Only include APIs with the given name.

func (*ApisListCall) Preferred 

func (c *ApisListCall) Preferred(preferred bool) *ApisListCall

Preferred sets the optional parameter "preferred": Return only the preferred version of an API.

type ApisService 

type ApisService struct {
	// contains filtered or unexported fields
}

func NewApisService 

func NewApisService(s *Service) *ApisService

func (*ApisService) GetRest 

func (r *ApisService) GetRest(api string, version string) *ApisGetRestCall

GetRest: Retrieve the description of a particular version of an api.

- api: The name of the API. - version: The version of the API.

func (*ApisService) List 

func (r *ApisService) List() *ApisListCall

List: Retrieve the list of APIs supported at this endpoint.

type DirectoryList 

type DirectoryList struct {
	// DiscoveryVersion: Indicate the version of the Discovery API used to generate
	// this doc.
	DiscoveryVersion string `json:"discoveryVersion,omitempty"`
	// Items: The individual directory entries. One entry per api/version pair.
	Items []*DirectoryListItems `json:"items,omitempty"`
	// Kind: The kind for this response.
	Kind string `json:"kind,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DiscoveryVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DiscoveryVersion") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (DirectoryList) MarshalJSON 

func (s DirectoryList) MarshalJSON() ([]byte, error)

type DirectoryListItems 

type DirectoryListItems struct {
	// Description: The description of this API.
	Description string `json:"description,omitempty"`
	// DiscoveryLink: A link to the discovery document.
	DiscoveryLink string `json:"discoveryLink,omitempty"`
	// DiscoveryRestUrl: The URL for the discovery REST document.
	DiscoveryRestUrl string `json:"discoveryRestUrl,omitempty"`
	// DocumentationLink: A link to human readable documentation for the API.
	DocumentationLink string `json:"documentationLink,omitempty"`
	// Icons: Links to 16x16 and 32x32 icons representing the API.
	Icons *DirectoryListItemsIcons `json:"icons,omitempty"`
	// Id: The id of this API.
	Id string `json:"id,omitempty"`
	// Kind: The kind for this response.
	Kind string `json:"kind,omitempty"`
	// Labels: Labels for the status of this API, such as labs or deprecated.
	Labels []string `json:"labels,omitempty"`
	// Name: The name of the API.
	Name string `json:"name,omitempty"`
	// Preferred: True if this version is the preferred version to use.
	Preferred bool `json:"preferred,omitempty"`
	// Title: The title of this API.
	Title string `json:"title,omitempty"`
	// Version: The version of the API.
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (DirectoryListItems) MarshalJSON 

func (s DirectoryListItems) MarshalJSON() ([]byte, error)

type DirectoryListItemsIcons 

type DirectoryListItemsIcons struct {
	// X16: The URL of the 16x16 icon.
	X16 string `json:"x16,omitempty"`
	// X32: The URL of the 32x32 icon.
	X32 string `json:"x32,omitempty"`
	// ForceSendFields is a list of field names (e.g. "X16") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "X16") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DirectoryListItemsIcons: Links to 16x16 and 32x32 icons representing the API.

func (DirectoryListItemsIcons) MarshalJSON 

func (s DirectoryListItemsIcons) MarshalJSON() ([]byte, error)

type JsonSchema 

type JsonSchema struct {
	// Ref: A reference to another schema. The value of this property is the "id"
	// of another schema.
	Ref string `json:"$ref,omitempty"`
	// AdditionalProperties: If this is a schema for an object, this property is
	// the schema for any additional properties with dynamic keys on this object.
	AdditionalProperties *JsonSchema `json:"additionalProperties,omitempty"`
	// Annotations: Additional information about this property.
	Annotations *JsonSchemaAnnotations `json:"annotations,omitempty"`
	// Default: The default value of this property (if one exists).
	Default string `json:"default,omitempty"`
	// Deprecated -- Whether the parameter is deprecated.
	Deprecated bool `json:"deprecated,omitempty"`
	// Description: A description of this object.
	Description string `json:"description,omitempty"`
	// Enum: Values this parameter may take (if it is an enum).
	Enum []string `json:"enum,omitempty"`
	// EnumDeprecated: The deprecation status for the enums. Each position maps to
	// the corresponding value in the "enum" array.
	EnumDeprecated []bool `json:"enumDeprecated,omitempty"`
	// EnumDescriptions: The descriptions for the enums. Each position maps to the
	// corresponding value in the "enum" array.
	EnumDescriptions []string `json:"enumDescriptions,omitempty"`
	// Format: An additional regular expression or key that helps constrain the
	// value. For more details see:
	// http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
	Format string `json:"format,omitempty"`
	// Id: Unique identifier for this schema.
	Id string `json:"id,omitempty"`
	// Items: If this is a schema for an array, this property is the schema for
	// each element in the array.
	Items *JsonSchema `json:"items,omitempty"`
	// Location: Whether this parameter goes in the query or the path for REST
	// requests.
	Location string `json:"location,omitempty"`
	// Maximum: The maximum value of this parameter.
	Maximum string `json:"maximum,omitempty"`
	// Minimum: The minimum value of this parameter.
	Minimum string `json:"minimum,omitempty"`
	// Pattern: The regular expression this parameter must conform to. Uses Java 6
	// regex format:
	// http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
	Pattern string `json:"pattern,omitempty"`
	// Properties: If this is a schema for an object, list the schema for each
	// property of this object.
	Properties map[string]JsonSchema `json:"properties,omitempty"`
	// ReadOnly: The value is read-only, generated by the service. The value cannot
	// be modified by the client. If the value is included in a POST, PUT, or PATCH
	// request, it is ignored by the service.
	ReadOnly bool `json:"readOnly,omitempty"`
	// Repeated: Whether this parameter may appear multiple times.
	Repeated bool `json:"repeated,omitempty"`
	// Required: Whether the parameter is required.
	Required bool `json:"required,omitempty"`
	// Type: The value type for this schema. A list of values can be found here:
	// http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
	Type string `json:"type,omitempty"`
	// Variant: In a variant data type, the value of one property is used to
	// determine how to interpret the entire entity. Its value must exist in a map
	// of descriminant values to schema names.
	Variant *JsonSchemaVariant `json:"variant,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Ref") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Ref") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (JsonSchema) MarshalJSON 

func (s JsonSchema) MarshalJSON() ([]byte, error)

type JsonSchemaAnnotations 

type JsonSchemaAnnotations struct {
	// Required: A list of methods for which this property is required on requests.
	Required []string `json:"required,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Required") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Required") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

JsonSchemaAnnotations: Additional information about this property.

func (JsonSchemaAnnotations) MarshalJSON 

func (s JsonSchemaAnnotations) MarshalJSON() ([]byte, error)

type JsonSchemaVariant 

type JsonSchemaVariant struct {
	// Discriminant: The name of the type discriminant property.
	Discriminant string `json:"discriminant,omitempty"`
	// Map: The map of discriminant value to schema to use for parsing..
	Map []*JsonSchemaVariantMap `json:"map,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Discriminant") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Discriminant") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

JsonSchemaVariant: In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.

func (JsonSchemaVariant) MarshalJSON 

func (s JsonSchemaVariant) MarshalJSON() ([]byte, error)

type JsonSchemaVariantMap 

type JsonSchemaVariantMap struct {
	Ref       string `json:"$ref,omitempty"`
	TypeValue string `json:"type_value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Ref") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Ref") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (JsonSchemaVariantMap) MarshalJSON 

func (s JsonSchemaVariantMap) MarshalJSON() ([]byte, error)

type RestDescription 

type RestDescription struct {
	// Auth: Authentication information.
	Auth *RestDescriptionAuth `json:"auth,omitempty"`
	// BasePath: [DEPRECATED] The base path for REST requests.
	BasePath string `json:"basePath,omitempty"`
	// BaseUrl: [DEPRECATED] The base URL for REST requests.
	BaseUrl string `json:"baseUrl,omitempty"`
	// BatchPath: The path for REST batch requests.
	BatchPath string `json:"batchPath,omitempty"`
	// CanonicalName: Indicates how the API name should be capitalized and split
	// into various parts. Useful for generating pretty class names.
	CanonicalName string `json:"canonicalName,omitempty"`
	// Description: The description of this API.
	Description string `json:"description,omitempty"`
	// DiscoveryVersion: Indicate the version of the Discovery API used to generate
	// this doc.
	DiscoveryVersion string `json:"discoveryVersion,omitempty"`
	// DocumentationLink: A link to human readable documentation for the API.
	DocumentationLink string `json:"documentationLink,omitempty"`
	// Endpoints: A list of location-based endpoint objects for this API. Each
	// object contains the endpoint URL, location, description and deprecation
	// status.
	Endpoints []*RestDescriptionEndpoints `json:"endpoints,omitempty"`
	// Etag: The ETag for this response.
	Etag string `json:"etag,omitempty"`
	// ExponentialBackoffDefault: Enable exponential backoff for suitable methods
	// in the generated clients.
	ExponentialBackoffDefault bool `json:"exponentialBackoffDefault,omitempty"`
	// Features: A list of supported features for this API.
	Features []string `json:"features,omitempty"`
	// Icons: Links to 16x16 and 32x32 icons representing the API.
	Icons *RestDescriptionIcons `json:"icons,omitempty"`
	// Id: The ID of this API.
	Id string `json:"id,omitempty"`
	// Kind: The kind for this response.
	Kind string `json:"kind,omitempty"`
	// Labels: Labels for the status of this API, such as labs or deprecated.
	Labels []string `json:"labels,omitempty"`
	// Methods: API-level methods for this API.
	Methods map[string]RestMethod `json:"methods,omitempty"`
	// Name: The name of this API.
	Name string `json:"name,omitempty"`
	// OwnerDomain: The domain of the owner of this API. Together with the
	// ownerName and a packagePath values, this can be used to generate a library
	// for this API which would have a unique fully qualified name.
	OwnerDomain string `json:"ownerDomain,omitempty"`
	// OwnerName: The name of the owner of this API. See ownerDomain.
	OwnerName string `json:"ownerName,omitempty"`
	// PackagePath: The package of the owner of this API. See ownerDomain.
	PackagePath string `json:"packagePath,omitempty"`
	// Parameters: Common parameters that apply across all apis.
	Parameters map[string]JsonSchema `json:"parameters,omitempty"`
	// Protocol: The protocol described by this document.
	Protocol string `json:"protocol,omitempty"`
	// Resources: The resources in this API.
	Resources map[string]RestResource `json:"resources,omitempty"`
	// Revision: The version of this API.
	Revision string `json:"revision,omitempty"`
	// RootUrl: The root URL under which all API services live.
	RootUrl string `json:"rootUrl,omitempty"`
	// Schemas: The schemas for this API.
	Schemas map[string]JsonSchema `json:"schemas,omitempty"`
	// ServicePath: The base path for all REST requests.
	ServicePath string `json:"servicePath,omitempty"`
	// Title: The title of this API.
	Title string `json:"title,omitempty"`
	// Version: The version of this API.
	Version       string `json:"version,omitempty"`
	VersionModule bool   `json:"version_module,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Auth") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Auth") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (RestDescription) MarshalJSON 

func (s RestDescription) MarshalJSON() ([]byte, error)

type RestDescriptionAuth 

type RestDescriptionAuth struct {
	// Oauth2: OAuth 2.0 authentication information.
	Oauth2 *RestDescriptionAuthOauth2 `json:"oauth2,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Oauth2") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Oauth2") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestDescriptionAuth: Authentication information.

func (RestDescriptionAuth) MarshalJSON 

func (s RestDescriptionAuth) MarshalJSON() ([]byte, error)

type RestDescriptionAuthOauth2 

type RestDescriptionAuthOauth2 struct {
	// Scopes: Available OAuth 2.0 scopes.
	Scopes map[string]RestDescriptionAuthOauth2Scopes `json:"scopes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Scopes") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Scopes") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestDescriptionAuthOauth2: OAuth 2.0 authentication information.

func (RestDescriptionAuthOauth2) MarshalJSON 

func (s RestDescriptionAuthOauth2) MarshalJSON() ([]byte, error)

type RestDescriptionAuthOauth2Scopes 

type RestDescriptionAuthOauth2Scopes struct {
	// Description: Description of scope.
	Description string `json:"description,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestDescriptionAuthOauth2Scopes: The scope value.

func (RestDescriptionAuthOauth2Scopes) MarshalJSON 

func (s RestDescriptionAuthOauth2Scopes) MarshalJSON() ([]byte, error)

type RestDescriptionEndpoints added in v0.135.0 

type RestDescriptionEndpoints struct {
	// Deprecated -- Whether this endpoint is deprecated
	Deprecated bool `json:"deprecated,omitempty"`
	// Description: A string describing the host designated by the URL
	Description string `json:"description,omitempty"`
	// EndpointUrl: The URL of the endpoint target host
	EndpointUrl string `json:"endpointUrl,omitempty"`
	// Location: The location of the endpoint
	Location string `json:"location,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Deprecated") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Deprecated") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestDescriptionEndpoints: A single endpoint object

func (RestDescriptionEndpoints) MarshalJSON added in v0.135.0 

func (s RestDescriptionEndpoints) MarshalJSON() ([]byte, error)

type RestDescriptionIcons 

type RestDescriptionIcons struct {
	// X16: The URL of the 16x16 icon.
	X16 string `json:"x16,omitempty"`
	// X32: The URL of the 32x32 icon.
	X32 string `json:"x32,omitempty"`
	// ForceSendFields is a list of field names (e.g. "X16") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "X16") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestDescriptionIcons: Links to 16x16 and 32x32 icons representing the API.

func (RestDescriptionIcons) MarshalJSON 

func (s RestDescriptionIcons) MarshalJSON() ([]byte, error)

type RestMethod 

type RestMethod struct {
	// ApiVersion: The API Version of this method, as passed in via the
	// `X-Goog-Api-Version` header or `$apiVersion` query parameter.
	ApiVersion string `json:"apiVersion,omitempty"`
	// Deprecated -- Whether this method is deprecated.
	Deprecated bool `json:"deprecated,omitempty"`
	// Description: Description of this method.
	Description string `json:"description,omitempty"`
	// EtagRequired: Whether this method requires an ETag to be specified. The ETag
	// is sent as an HTTP If-Match or If-None-Match header.
	EtagRequired bool `json:"etagRequired,omitempty"`
	// FlatPath: The URI path of this REST method in (RFC 6570) format without
	// level 2 features ({+var}). Supplementary to the path property.
	FlatPath string `json:"flatPath,omitempty"`
	// HttpMethod: HTTP method used by this method.
	HttpMethod string `json:"httpMethod,omitempty"`
	// Id: A unique ID for this method. This property can be used to match methods
	// between different versions of Discovery.
	Id string `json:"id,omitempty"`
	// MediaUpload: Media upload parameters.
	MediaUpload *RestMethodMediaUpload `json:"mediaUpload,omitempty"`
	// ParameterOrder: Ordered list of required parameters, serves as a hint to
	// clients on how to structure their method signatures. The array is ordered
	// such that the "most-significant" parameter appears first.
	ParameterOrder []string `json:"parameterOrder,omitempty"`
	// Parameters: Details for all parameters in this method.
	Parameters map[string]JsonSchema `json:"parameters,omitempty"`
	// Path: The URI path of this REST method. Should be used in conjunction with
	// the basePath property at the api-level.
	Path string `json:"path,omitempty"`
	// Request: The schema for the request.
	Request *RestMethodRequest `json:"request,omitempty"`
	// Response: The schema for the response.
	Response *RestMethodResponse `json:"response,omitempty"`
	// Scopes: OAuth 2.0 scopes applicable to this method.
	Scopes []string `json:"scopes,omitempty"`
	// SupportsMediaDownload: Whether this method supports media downloads.
	SupportsMediaDownload bool `json:"supportsMediaDownload,omitempty"`
	// SupportsMediaUpload: Whether this method supports media uploads.
	SupportsMediaUpload bool `json:"supportsMediaUpload,omitempty"`
	// SupportsSubscription: Whether this method supports subscriptions.
	SupportsSubscription bool `json:"supportsSubscription,omitempty"`
	// UseMediaDownloadService: Indicates that downloads from this method should
	// use the download service URL (i.e. "/download"). Only applies if the method
	// supports media download.
	UseMediaDownloadService bool `json:"useMediaDownloadService,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (RestMethod) MarshalJSON 

func (s RestMethod) MarshalJSON() ([]byte, error)

type RestMethodMediaUpload 

type RestMethodMediaUpload struct {
	// Accept: MIME Media Ranges for acceptable media uploads to this method.
	Accept []string `json:"accept,omitempty"`
	// MaxSize: Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
	MaxSize string `json:"maxSize,omitempty"`
	// Protocols: Supported upload protocols.
	Protocols *RestMethodMediaUploadProtocols `json:"protocols,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Accept") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Accept") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestMethodMediaUpload: Media upload parameters.

func (RestMethodMediaUpload) MarshalJSON 

func (s RestMethodMediaUpload) MarshalJSON() ([]byte, error)

type RestMethodMediaUploadProtocols 

type RestMethodMediaUploadProtocols struct {
	// Resumable: Supports the Resumable Media Upload protocol.
	Resumable *RestMethodMediaUploadProtocolsResumable `json:"resumable,omitempty"`
	// Simple: Supports uploading as a single HTTP request.
	Simple *RestMethodMediaUploadProtocolsSimple `json:"simple,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Resumable") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Resumable") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestMethodMediaUploadProtocols: Supported upload protocols.

func (RestMethodMediaUploadProtocols) MarshalJSON 

func (s RestMethodMediaUploadProtocols) MarshalJSON() ([]byte, error)

type RestMethodMediaUploadProtocolsResumable 

type RestMethodMediaUploadProtocolsResumable struct {
	// Multipart: True if this endpoint supports uploading multipart media.
	//
	// Default: true
	Multipart *bool `json:"multipart,omitempty"`
	// Path: The URI path to be used for upload. Should be used in conjunction with
	// the basePath property at the api-level.
	Path string `json:"path,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Multipart") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Multipart") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestMethodMediaUploadProtocolsResumable: Supports the Resumable Media Upload protocol.

func (RestMethodMediaUploadProtocolsResumable) MarshalJSON 

func (s RestMethodMediaUploadProtocolsResumable) MarshalJSON() ([]byte, error)

type RestMethodMediaUploadProtocolsSimple 

type RestMethodMediaUploadProtocolsSimple struct {
	// Multipart: True if this endpoint supports upload multipart media.
	//
	// Default: true
	Multipart *bool `json:"multipart,omitempty"`
	// Path: The URI path to be used for upload. Should be used in conjunction with
	// the basePath property at the api-level.
	Path string `json:"path,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Multipart") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Multipart") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestMethodMediaUploadProtocolsSimple: Supports uploading as a single HTTP request.

func (RestMethodMediaUploadProtocolsSimple) MarshalJSON 

func (s RestMethodMediaUploadProtocolsSimple) MarshalJSON() ([]byte, error)

type RestMethodRequest 

type RestMethodRequest struct {
	// Ref: Schema ID for the request schema.
	Ref string `json:"$ref,omitempty"`
	// ParameterName: parameter name.
	ParameterName string `json:"parameterName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Ref") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Ref") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestMethodRequest: The schema for the request.

func (RestMethodRequest) MarshalJSON 

func (s RestMethodRequest) MarshalJSON() ([]byte, error)

type RestMethodResponse 

type RestMethodResponse struct {
	// Ref: Schema ID for the response schema.
	Ref string `json:"$ref,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Ref") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Ref") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestMethodResponse: The schema for the response.

func (RestMethodResponse) MarshalJSON 

func (s RestMethodResponse) MarshalJSON() ([]byte, error)

type RestResource 

type RestResource struct {
	// Deprecated -- Whether this resource is deprecated.
	Deprecated bool `json:"deprecated,omitempty"`
	// Methods: Methods on this resource.
	Methods map[string]RestMethod `json:"methods,omitempty"`
	// Resources: Sub-resources on this resource.
	Resources map[string]RestResource `json:"resources,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Deprecated") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Deprecated") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (RestResource) MarshalJSON 

func (s RestResource) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Apis *ApisService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.