api: google.golang.org/api/run/v1 Index | Files

package run

import "google.golang.org/api/run/v1"

Package run provides access to the Cloud Run API.

For product documentation, see: https://cloud.google.com/run/

Creating a client

Usage example:

import "google.golang.org/api/run/v1"
ctx := context.Background()
runService, err := run.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 option.WithAPIKey:

runService, err := run.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.


Package Files



const (
    // View and manage your data across Google Cloud Platform services
    CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

OAuth2 scopes used by this API.

type Location Uses

type Location struct {
    // DisplayName: The friendly name for this location, typically a nearby
    // city name.
    // For example, "Tokyo".
    DisplayName string `json:"displayName,omitempty"`

    // Labels: Cross-service attributes for the location. For example
    //     {"cloud.googleapis.com/region": "us-east1"}
    Labels map[string]string `json:"labels,omitempty"`

    // LocationId: The canonical id for this location. For example:
    // "us-east1".
    LocationId string `json:"locationId,omitempty"`

    // Metadata: Service-specific metadata. For example the available
    // capacity at the given
    // location.
    Metadata googleapi.RawMessage `json:"metadata,omitempty"`

    // Name: Resource name for the location, which may vary between
    // implementations.
    // For example: "projects/example-project/locations/us-east1"
    Name string `json:"name,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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:"-"`

Location: A resource that represents Google Cloud Platform location.

func (*Location) MarshalJSON Uses

func (s *Location) MarshalJSON() ([]byte, error)

type ProjectsLocationsGetCall Uses

type ProjectsLocationsGetCall struct {
    // contains filtered or unexported fields

func (*ProjectsLocationsGetCall) Context Uses

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

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 (*ProjectsLocationsGetCall) Do Uses

func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)

Do executes the "run.projects.locations.get" call. Exactly one of *Location or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Location.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 (*ProjectsLocationsGetCall) Fields Uses

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

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

func (*ProjectsLocationsGetCall) Header Uses

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

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

func (*ProjectsLocationsGetCall) IfNoneMatch Uses

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

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.

type ProjectsLocationsService Uses

type ProjectsLocationsService struct {
    // contains filtered or unexported fields

func NewProjectsLocationsService Uses

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get Uses

func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall

Get: Gets information about a location.

type ProjectsService Uses

type ProjectsService struct {
    Locations *ProjectsLocationsService
    // contains filtered or unexported fields

func NewProjectsService Uses

func NewProjectsService(s *Service) *ProjectsService

type Service Uses

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

    Projects *ProjectsService
    // contains filtered or unexported fields

func New Uses

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 Uses

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

NewService creates a new Service.

Package run imports 14 packages (graph). Updated 2019-07-13. Refresh now. Tools for package owners.