appengine

package

v0.257.0Latest Latest

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

Go to latest Published: Dec 2, 2025 License:BSD-3-ClauseImports:15Imported by:1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/googleapis/google-api-go-client

Documentation ¶

Overview¶

Package appengine provides access to the App Engine Admin API.

For product documentation, see:https://cloud.google.com/appengine/docs/admin-api/

Creating a client¶

Usage example:

import "google.golang.org/api/appengine/v1beta4"...ctx := context.Background()appengineService, err := appengine.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options¶

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

appengineService, err := appengine.NewService(ctx, option.WithScopes(appengine.CloudPlatformReadOnlyScope))

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

appengineService, err := appengine.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, ...)appengineService, err := appengine.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index¶

Constants¶

View Source

const (// View and manage your applications deployed on Google App EngineAppengineAdminScope = "https://www.googleapis.com/auth/appengine.admin"// View and manage your data across Google Cloud Platform servicesCloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"// View your data across Google Cloud Platform servicesCloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only")

OAuth2 scopes used by this API.

Variables¶

This section is empty.

Functions¶

This section is empty.

Types¶

typeAPIService ¶

type APIService struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentApps *AppsService// contains filtered or unexported fields}

funcNewdeprecated

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

New creates a new APIService. 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.

funcNewService ¶added inv0.5.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*APIService,error)

NewService creates a new APIService.

typeApiConfigHandler ¶

type ApiConfigHandler struct {// AuthFailAction: Action to take when users access resources that// require authentication. Defaults to redirect.//// Possible values:// "AUTH_FAIL_ACTION_UNSPECIFIED" - Not specified.// AUTH_FAIL_ACTION_REDIRECT is assumed.// "AUTH_FAIL_ACTION_REDIRECT" - Redirects user to// "accounts.google.com". The user is redirected back to the application// URL after signing in or creating an account.// "AUTH_FAIL_ACTION_UNAUTHORIZED" - Rejects request with a 401 HTTP// status code and an error message.AuthFailActionstring `json:"authFailAction,omitempty"`// Login: Level of login required to access this resource. Defaults to// optional.//// Possible values:// "LOGIN_UNSPECIFIED" - Not specified. LOGIN_OPTIONAL is assumed.// "LOGIN_OPTIONAL" - Does not require that the user is signed in.// "LOGIN_ADMIN" - If the user is not signed in, the auth_fail_action// is taken. In addition, if the user is not an administrator for the// application, they are given an error message regardless of// auth_fail_action. If the user is an administrator, the handler// proceeds.// "LOGIN_REQUIRED" - If the user has signed in, the handler proceeds// normally. Otherwise, the auth_fail_action is taken.Loginstring `json:"login,omitempty"`// Script: Path to the script from the application root directory.Scriptstring `json:"script,omitempty"`// SecurityLevel: Security (HTTPS) enforcement for this URL.//// Possible values:// "SECURE_UNSPECIFIED" - Not specified.// "SECURE_DEFAULT" - Both HTTP and HTTPS requests with URLs that// match the handler succeed without redirects. The application can// examine the request to determine which protocol was used, and respond// accordingly.// "SECURE_NEVER" - Requests for a URL that match this handler that// use HTTPS are automatically redirected to the HTTP equivalent URL.// "SECURE_OPTIONAL" - Both HTTP and HTTPS requests with URLs that// match the handler succeed without redirects. The application can// examine the request to determine which protocol was used and respond// accordingly.// "SECURE_ALWAYS" - Requests for a URL that match this handler that// do not use HTTPS are automatically redirected to the HTTPS URL with// the same path. Query parameters are reserved for the redirect.SecurityLevelstring `json:"securityLevel,omitempty"`// Url: URL to serve the endpoint at.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "AuthFailAction") 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. "AuthFailAction") 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:"-"`}

ApiConfigHandler: Google Cloud Endpoints(https://cloud.google.com/appengine/docs/python/endpoints/)configuration for API handlers.

func (*ApiConfigHandler)MarshalJSON ¶

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

typeApiEndpointHandler ¶

type ApiEndpointHandler struct {// ScriptPath: Path to the script from the application root directory.ScriptPathstring `json:"scriptPath,omitempty"`// ForceSendFields is a list of field names (e.g. "ScriptPath") 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. "ScriptPath") 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:"-"`}

ApiEndpointHandler: Uses Google Cloud Endpoints to handle requests.

func (*ApiEndpointHandler)MarshalJSON ¶

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

typeApplication ¶

type Application struct {// AuthDomain: Google Apps authentication domain that controls which// users can access this application.Defaults to open access for any// Google Account.AuthDomainstring `json:"authDomain,omitempty"`// CodeBucket: Google Cloud Storage bucket that can be used for storing// files associated with this application. This bucket is associated// with the application and can be used by the gcloud deployment// commands.@OutputOnlyCodeBucketstring `json:"codeBucket,omitempty"`// DefaultBucket: Google Cloud Storage bucket that can be used by this// application to store content.@OutputOnlyDefaultBucketstring `json:"defaultBucket,omitempty"`// DefaultCookieExpiration: Cookie expiration policy for this// application.DefaultCookieExpirationstring `json:"defaultCookieExpiration,omitempty"`// DefaultHostname: Hostname used to reach the application, as resolved// by App Engine.@OutputOnlyDefaultHostnamestring `json:"defaultHostname,omitempty"`// DispatchRules: HTTP path dispatch rules for requests to the// application that do not explicitly target a module or version. Rules// are order-dependent.@OutputOnlyDispatchRules []*UrlDispatchRule `json:"dispatchRules,omitempty"`Iap *IdentityAwareProxy `json:"iap,omitempty"`// Id: Identifier of the Application resource. This identifier is// equivalent to the project ID of the Google Cloud Platform project// where you want to deploy your application. Example: myapp.Idstring `json:"id,omitempty"`// Location: Location from which this application will be run.// Application instances will run out of data centers in the chosen// location, which is also where all of the application's end user// content is stored.Defaults to us-central.Options are:us-central -// Central USeurope-west - Western Europeus-east1 - Eastern USLocationstring `json:"location,omitempty"`// Name: Full path to the Application resource in the API. Example:// apps/myapp.@OutputOnlyNamestring `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. "AuthDomain") 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. "AuthDomain") 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:"-"`}

Application: An Application resource contains the top-levelconfiguration of an App Engine application.

func (*Application)MarshalJSON ¶

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

typeAppsCreateCall ¶

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

func (*AppsCreateCall)Context ¶

func (c *AppsCreateCall) Context(ctxcontext.Context) *AppsCreateCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsCreateCall)Do ¶

func (c *AppsCreateCall) Do(opts ...googleapi.CallOption) (*Operation,error)

Do executes the "appengine.apps.create" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsCreateCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsCreateCall)Header ¶

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

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

typeAppsGetCall ¶

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

func (*AppsGetCall)Context ¶

func (c *AppsGetCall) Context(ctxcontext.Context) *AppsGetCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsGetCall)Do ¶

func (c *AppsGetCall) Do(opts ...googleapi.CallOption) (*Application,error)

Do executes the "appengine.apps.get" call.Exactly one of *Application or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Application.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsGetCall)EnsureResourcesExist ¶

func (c *AppsGetCall) EnsureResourcesExist(ensureResourcesExistbool) *AppsGetCall

EnsureResourcesExist sets the optional parameter"ensureResourcesExist": Certain resources associated with anapplication are created on-demand. Controls whether these resourcesshould be created when performing the GET operation. If specified andany resources could not be created, the request will fail with anerror code. Additionally, this parameter can cause the request totake longer to complete.

func (*AppsGetCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsGetCall)Header ¶

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

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

func (*AppsGetCall)IfNoneMatch ¶

func (c *AppsGetCall) IfNoneMatch(entityTagstring) *AppsGetCall

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

typeAppsLocationsGetCall ¶

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

func (*AppsLocationsGetCall)Context ¶

func (c *AppsLocationsGetCall) Context(ctxcontext.Context) *AppsLocationsGetCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsLocationsGetCall)Do ¶

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

Do executes the "appengine.apps.locations.get" call.Exactly one of *Location or error will be non-nil. Any non-2xx statuscode is an error. Response headers are in either*Location.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsLocationsGetCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsLocationsGetCall)Header ¶

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

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

func (*AppsLocationsGetCall)IfNoneMatch ¶

func (c *AppsLocationsGetCall) IfNoneMatch(entityTagstring) *AppsLocationsGetCall

typeAppsLocationsListCall ¶

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

func (*AppsLocationsListCall)Context ¶

func (c *AppsLocationsListCall) Context(ctxcontext.Context) *AppsLocationsListCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsLocationsListCall)Do ¶

func (c *AppsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse,error)

Do executes the "appengine.apps.locations.list" call.Exactly one of *ListLocationsResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*ListLocationsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*AppsLocationsListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsLocationsListCall)Filter ¶

func (c *AppsLocationsListCall) Filter(filterstring) *AppsLocationsListCall

Filter sets the optional parameter "filter": The standard listfilter.

func (*AppsLocationsListCall)Header ¶

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

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

func (*AppsLocationsListCall)IfNoneMatch ¶

func (c *AppsLocationsListCall) IfNoneMatch(entityTagstring) *AppsLocationsListCall

func (*AppsLocationsListCall)PageSize ¶

func (c *AppsLocationsListCall) PageSize(pageSizeint64) *AppsLocationsListCall

PageSize sets the optional parameter "pageSize": The standard listpage size.

func (*AppsLocationsListCall)PageToken ¶

func (c *AppsLocationsListCall) PageToken(pageTokenstring) *AppsLocationsListCall

PageToken sets the optional parameter "pageToken": The standard listpage token.

func (*AppsLocationsListCall)Pages ¶

func (c *AppsLocationsListCall) Pages(ctxcontext.Context, f func(*ListLocationsResponse)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.

typeAppsLocationsService ¶

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

funcNewAppsLocationsService ¶

func NewAppsLocationsService(s *APIService) *AppsLocationsService

func (*AppsLocationsService)Get ¶

func (r *AppsLocationsService) Get(appsIdstring, locationsIdstring) *AppsLocationsGetCall

Get: Gets information about a location.

func (*AppsLocationsService)List ¶

func (r *AppsLocationsService) List(appsIdstring) *AppsLocationsListCall

List: Lists information about the supported locations for thisservice.

typeAppsModulesDeleteCall ¶

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

func (*AppsModulesDeleteCall)Context ¶

func (c *AppsModulesDeleteCall) Context(ctxcontext.Context) *AppsModulesDeleteCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesDeleteCall)Do ¶

func (c *AppsModulesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation,error)

Do executes the "appengine.apps.modules.delete" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsModulesDeleteCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesDeleteCall)Header ¶

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

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

typeAppsModulesGetCall ¶

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

func (*AppsModulesGetCall)Context ¶

func (c *AppsModulesGetCall) Context(ctxcontext.Context) *AppsModulesGetCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesGetCall)Do ¶

func (c *AppsModulesGetCall) Do(opts ...googleapi.CallOption) (*Module,error)

Do executes the "appengine.apps.modules.get" call.Exactly one of *Module or error will be non-nil. Any non-2xx statuscode is an error. Response headers are in either*Module.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModifiedwas returned.

func (*AppsModulesGetCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesGetCall)Header ¶

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

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

func (*AppsModulesGetCall)IfNoneMatch ¶

func (c *AppsModulesGetCall) IfNoneMatch(entityTagstring) *AppsModulesGetCall

typeAppsModulesListCall ¶

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

func (*AppsModulesListCall)Context ¶

func (c *AppsModulesListCall) Context(ctxcontext.Context) *AppsModulesListCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesListCall)Do ¶

func (c *AppsModulesListCall) Do(opts ...googleapi.CallOption) (*ListModulesResponse,error)

Do executes the "appengine.apps.modules.list" call.Exactly one of *ListModulesResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*ListModulesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*AppsModulesListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesListCall)Header ¶

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

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

func (*AppsModulesListCall)IfNoneMatch ¶

func (c *AppsModulesListCall) IfNoneMatch(entityTagstring) *AppsModulesListCall

func (*AppsModulesListCall)PageSize ¶

func (c *AppsModulesListCall) PageSize(pageSizeint64) *AppsModulesListCall

PageSize sets the optional parameter "pageSize": Maximum results toreturn per page.

func (*AppsModulesListCall)PageToken ¶

func (c *AppsModulesListCall) PageToken(pageTokenstring) *AppsModulesListCall

PageToken sets the optional parameter "pageToken": Continuation tokenfor fetching the next page of results.

func (*AppsModulesListCall)Pages ¶

func (c *AppsModulesListCall) Pages(ctxcontext.Context, f func(*ListModulesResponse)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.

typeAppsModulesPatchCall ¶

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

func (*AppsModulesPatchCall)Context ¶

func (c *AppsModulesPatchCall) Context(ctxcontext.Context) *AppsModulesPatchCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesPatchCall)Do ¶

func (c *AppsModulesPatchCall) Do(opts ...googleapi.CallOption) (*Operation,error)

Do executes the "appengine.apps.modules.patch" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsModulesPatchCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesPatchCall)Header ¶

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

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

func (*AppsModulesPatchCall)Mask ¶

func (c *AppsModulesPatchCall) Mask(maskstring) *AppsModulesPatchCall

Mask sets the optional parameter "mask": Standard field mask for theset of fields to be updated.

func (*AppsModulesPatchCall)MigrateTraffic ¶

func (c *AppsModulesPatchCall) MigrateTraffic(migrateTrafficbool) *AppsModulesPatchCall

MigrateTraffic sets the optional parameter "migrateTraffic": Set totrue to gradually shift traffic to one or more versions that youspecify. By default, traffic is shifted immediately. For gradualtraffic migration, the target versions must be located withininstances that are configured for both warmup requests(https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype)and automatic scaling(https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling).You must specify the shardBy(https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby)field in the Module resource. Gradual traffic migration is notsupported in the App Engine flexible environment. For examples, seeMigrating and Splitting Traffic(https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).

typeAppsModulesService ¶

type AppsModulesService struct {Versions *AppsModulesVersionsService// contains filtered or unexported fields}

funcNewAppsModulesService ¶

func NewAppsModulesService(s *APIService) *AppsModulesService

func (*AppsModulesService)Delete ¶

func (r *AppsModulesService) Delete(appsIdstring, modulesIdstring) *AppsModulesDeleteCall

Delete: Deletes the specified module and all enclosed versions.

func (*AppsModulesService)Get ¶

func (r *AppsModulesService) Get(appsIdstring, modulesIdstring) *AppsModulesGetCall

Get: Gets the current configuration of the specified module.

func (*AppsModulesService)List ¶

func (r *AppsModulesService) List(appsIdstring) *AppsModulesListCall

List: Lists all the modules in the application.

func (*AppsModulesService)Patch ¶

func (r *AppsModulesService) Patch(appsIdstring, modulesIdstring, module *Module) *AppsModulesPatchCall

Patch: Updates the configuration of the specified module.

typeAppsModulesVersionsCreateCall ¶

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

func (*AppsModulesVersionsCreateCall)Context ¶

func (c *AppsModulesVersionsCreateCall) Context(ctxcontext.Context) *AppsModulesVersionsCreateCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesVersionsCreateCall)Do ¶

func (c *AppsModulesVersionsCreateCall) Do(opts ...googleapi.CallOption) (*Operation,error)

Do executes the "appengine.apps.modules.versions.create" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsModulesVersionsCreateCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesVersionsCreateCall)Header ¶

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

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

typeAppsModulesVersionsDeleteCall ¶

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

func (*AppsModulesVersionsDeleteCall)Context ¶

func (c *AppsModulesVersionsDeleteCall) Context(ctxcontext.Context) *AppsModulesVersionsDeleteCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesVersionsDeleteCall)Do ¶

func (c *AppsModulesVersionsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation,error)

Do executes the "appengine.apps.modules.versions.delete" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsModulesVersionsDeleteCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesVersionsDeleteCall)Header ¶

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

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

typeAppsModulesVersionsGetCall ¶

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

func (*AppsModulesVersionsGetCall)Context ¶

func (c *AppsModulesVersionsGetCall) Context(ctxcontext.Context) *AppsModulesVersionsGetCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesVersionsGetCall)Do ¶

func (c *AppsModulesVersionsGetCall) Do(opts ...googleapi.CallOption) (*Version,error)

Do executes the "appengine.apps.modules.versions.get" call.Exactly one of *Version or error will be non-nil. Any non-2xx statuscode is an error. Response headers are in either*Version.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModifiedwas returned.

func (*AppsModulesVersionsGetCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesVersionsGetCall)Header ¶

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

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

func (*AppsModulesVersionsGetCall)IfNoneMatch ¶

func (c *AppsModulesVersionsGetCall) IfNoneMatch(entityTagstring) *AppsModulesVersionsGetCall

func (*AppsModulesVersionsGetCall)View ¶

func (c *AppsModulesVersionsGetCall) View(viewstring) *AppsModulesVersionsGetCall

View sets the optional parameter "view": Controls the set of fieldsreturned in the Get response.

Possible values:

"BASIC""FULL"

typeAppsModulesVersionsInstancesDebugCall ¶

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

func (*AppsModulesVersionsInstancesDebugCall)Context ¶

func (c *AppsModulesVersionsInstancesDebugCall) Context(ctxcontext.Context) *AppsModulesVersionsInstancesDebugCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesVersionsInstancesDebugCall)Do ¶

func (c *AppsModulesVersionsInstancesDebugCall) Do(opts ...googleapi.CallOption) (*Operation,error)

Do executes the "appengine.apps.modules.versions.instances.debug" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsModulesVersionsInstancesDebugCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesVersionsInstancesDebugCall)Header ¶

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

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

typeAppsModulesVersionsInstancesDeleteCall ¶

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

func (*AppsModulesVersionsInstancesDeleteCall)Context ¶

func (c *AppsModulesVersionsInstancesDeleteCall) Context(ctxcontext.Context) *AppsModulesVersionsInstancesDeleteCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesVersionsInstancesDeleteCall)Do ¶

func (c *AppsModulesVersionsInstancesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation,error)

Do executes the "appengine.apps.modules.versions.instances.delete" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsModulesVersionsInstancesDeleteCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesVersionsInstancesDeleteCall)Header ¶

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

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

typeAppsModulesVersionsInstancesGetCall ¶

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

func (*AppsModulesVersionsInstancesGetCall)Context ¶

func (c *AppsModulesVersionsInstancesGetCall) Context(ctxcontext.Context) *AppsModulesVersionsInstancesGetCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesVersionsInstancesGetCall)Do ¶

func (c *AppsModulesVersionsInstancesGetCall) Do(opts ...googleapi.CallOption) (*Instance,error)

Do executes the "appengine.apps.modules.versions.instances.get" call.Exactly one of *Instance or error will be non-nil. Any non-2xx statuscode is an error. Response headers are in either*Instance.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsModulesVersionsInstancesGetCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesVersionsInstancesGetCall)Header ¶

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

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

func (*AppsModulesVersionsInstancesGetCall)IfNoneMatch ¶

func (c *AppsModulesVersionsInstancesGetCall) IfNoneMatch(entityTagstring) *AppsModulesVersionsInstancesGetCall

typeAppsModulesVersionsInstancesListCall ¶

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

func (*AppsModulesVersionsInstancesListCall)Context ¶

func (c *AppsModulesVersionsInstancesListCall) Context(ctxcontext.Context) *AppsModulesVersionsInstancesListCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesVersionsInstancesListCall)Do ¶

func (c *AppsModulesVersionsInstancesListCall) Do(opts ...googleapi.CallOption) (*ListInstancesResponse,error)

Do executes the "appengine.apps.modules.versions.instances.list" call.Exactly one of *ListInstancesResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*ListInstancesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*AppsModulesVersionsInstancesListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesVersionsInstancesListCall)Header ¶

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

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

func (*AppsModulesVersionsInstancesListCall)IfNoneMatch ¶

func (c *AppsModulesVersionsInstancesListCall) IfNoneMatch(entityTagstring) *AppsModulesVersionsInstancesListCall

func (*AppsModulesVersionsInstancesListCall)PageSize ¶

func (c *AppsModulesVersionsInstancesListCall) PageSize(pageSizeint64) *AppsModulesVersionsInstancesListCall

PageSize sets the optional parameter "pageSize": Maximum results toreturn per page.

func (*AppsModulesVersionsInstancesListCall)PageToken ¶

func (c *AppsModulesVersionsInstancesListCall) PageToken(pageTokenstring) *AppsModulesVersionsInstancesListCall

PageToken sets the optional parameter "pageToken": Continuation tokenfor fetching the next page of results.

func (*AppsModulesVersionsInstancesListCall)Pages ¶

func (c *AppsModulesVersionsInstancesListCall) Pages(ctxcontext.Context, f func(*ListInstancesResponse)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.

typeAppsModulesVersionsInstancesService ¶

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

funcNewAppsModulesVersionsInstancesService ¶

func NewAppsModulesVersionsInstancesService(s *APIService) *AppsModulesVersionsInstancesService

func (*AppsModulesVersionsInstancesService)Debug ¶

func (r *AppsModulesVersionsInstancesService) Debug(appsIdstring, modulesIdstring, versionsIdstring, instancesIdstring, debuginstancerequest *DebugInstanceRequest) *AppsModulesVersionsInstancesDebugCall

Debug: Enables debugging on a VM instance. This allows you to use theSSH command to connect to the virtual machine where the instancelives. While in "debug mode", the instance continues to serve livetraffic. You should delete the instance when you are done debuggingand then allow the system to take over and determine if anotherinstance should be started.Only applicable for instances in AppEngine flexible environment.

func (*AppsModulesVersionsInstancesService)Delete ¶

func (r *AppsModulesVersionsInstancesService) Delete(appsIdstring, modulesIdstring, versionsIdstring, instancesIdstring) *AppsModulesVersionsInstancesDeleteCall

Delete: Stops a running instance.

func (*AppsModulesVersionsInstancesService)Get ¶

func (r *AppsModulesVersionsInstancesService) Get(appsIdstring, modulesIdstring, versionsIdstring, instancesIdstring) *AppsModulesVersionsInstancesGetCall

Get: Gets instance information.

func (*AppsModulesVersionsInstancesService)List ¶

func (r *AppsModulesVersionsInstancesService) List(appsIdstring, modulesIdstring, versionsIdstring) *AppsModulesVersionsInstancesListCall

List: Lists the instances of a version.Tip: To aggregate detailsabout instances over time, see the Stackdriver Monitoring API(https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).

typeAppsModulesVersionsListCall ¶

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

func (*AppsModulesVersionsListCall)Context ¶

func (c *AppsModulesVersionsListCall) Context(ctxcontext.Context) *AppsModulesVersionsListCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesVersionsListCall)Do ¶

func (c *AppsModulesVersionsListCall) Do(opts ...googleapi.CallOption) (*ListVersionsResponse,error)

Do executes the "appengine.apps.modules.versions.list" call.Exactly one of *ListVersionsResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*ListVersionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*AppsModulesVersionsListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesVersionsListCall)Header ¶

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

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

func (*AppsModulesVersionsListCall)IfNoneMatch ¶

func (c *AppsModulesVersionsListCall) IfNoneMatch(entityTagstring) *AppsModulesVersionsListCall

func (*AppsModulesVersionsListCall)PageSize ¶

func (c *AppsModulesVersionsListCall) PageSize(pageSizeint64) *AppsModulesVersionsListCall

PageSize sets the optional parameter "pageSize": Maximum results toreturn per page.

func (*AppsModulesVersionsListCall)PageToken ¶

func (c *AppsModulesVersionsListCall) PageToken(pageTokenstring) *AppsModulesVersionsListCall

PageToken sets the optional parameter "pageToken": Continuation tokenfor fetching the next page of results.

func (*AppsModulesVersionsListCall)Pages ¶

func (c *AppsModulesVersionsListCall) Pages(ctxcontext.Context, f func(*ListVersionsResponse)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 (*AppsModulesVersionsListCall)View ¶

func (c *AppsModulesVersionsListCall) View(viewstring) *AppsModulesVersionsListCall

View sets the optional parameter "view": Controls the set of fieldsreturned in the List response.

Possible values:

"BASIC""FULL"

typeAppsModulesVersionsPatchCall ¶

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

func (*AppsModulesVersionsPatchCall)Context ¶

func (c *AppsModulesVersionsPatchCall) Context(ctxcontext.Context) *AppsModulesVersionsPatchCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsModulesVersionsPatchCall)Do ¶

func (c *AppsModulesVersionsPatchCall) Do(opts ...googleapi.CallOption) (*Operation,error)

Do executes the "appengine.apps.modules.versions.patch" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsModulesVersionsPatchCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsModulesVersionsPatchCall)Header ¶

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

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

func (*AppsModulesVersionsPatchCall)Mask ¶

func (c *AppsModulesVersionsPatchCall) Mask(maskstring) *AppsModulesVersionsPatchCall

Mask sets the optional parameter "mask": Standard field mask for theset of fields to be updated.

typeAppsModulesVersionsService ¶

type AppsModulesVersionsService struct {Instances *AppsModulesVersionsInstancesService// contains filtered or unexported fields}

funcNewAppsModulesVersionsService ¶

func NewAppsModulesVersionsService(s *APIService) *AppsModulesVersionsService

func (*AppsModulesVersionsService)Create ¶

func (r *AppsModulesVersionsService) Create(appsIdstring, modulesIdstring, version *Version) *AppsModulesVersionsCreateCall

Create: Deploys code and resource files to a new version.

func (*AppsModulesVersionsService)Delete ¶

func (r *AppsModulesVersionsService) Delete(appsIdstring, modulesIdstring, versionsIdstring) *AppsModulesVersionsDeleteCall

Delete: Deletes an existing version.

func (*AppsModulesVersionsService)Get ¶

func (r *AppsModulesVersionsService) Get(appsIdstring, modulesIdstring, versionsIdstring) *AppsModulesVersionsGetCall

Get: Gets the specified Version resource. By default, only aBASIC_VIEW will be returned. Specify the FULL_VIEW parameter to getthe full resource.

func (*AppsModulesVersionsService)List ¶

func (r *AppsModulesVersionsService) List(appsIdstring, modulesIdstring) *AppsModulesVersionsListCall

List: Lists the versions of a module.

func (*AppsModulesVersionsService)Patch ¶

func (r *AppsModulesVersionsService) Patch(appsIdstring, modulesIdstring, versionsIdstring, version *Version) *AppsModulesVersionsPatchCall

Patch: Updates the specified Version resource. You can specify thefollowing fields depending on the App Engine environment and type ofscaling that the version resource uses:serving_status(https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status):

For Version resources that use basic scaling, manual scaling, or run

in the App Engine flexible environment.instance_class(https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class):

For Version resources that run in the App Engine standard

environment.automatic_scaling.min_idle_instances(https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling):

For Version resources that use automatic scaling and run in the App

Engine standard environment.automatic_scaling.max_idle_instances(https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling):

For Version resources that use automatic scaling and run in the App

Engine standard environment.

typeAppsOperationsGetCall ¶

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

func (*AppsOperationsGetCall)Context ¶

func (c *AppsOperationsGetCall) Context(ctxcontext.Context) *AppsOperationsGetCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsOperationsGetCall)Do ¶

func (c *AppsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation,error)

Do executes the "appengine.apps.operations.get" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsOperationsGetCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsOperationsGetCall)Header ¶

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

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

func (*AppsOperationsGetCall)IfNoneMatch ¶

func (c *AppsOperationsGetCall) IfNoneMatch(entityTagstring) *AppsOperationsGetCall

typeAppsOperationsListCall ¶

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

func (*AppsOperationsListCall)Context ¶

func (c *AppsOperationsListCall) Context(ctxcontext.Context) *AppsOperationsListCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsOperationsListCall)Do ¶

func (c *AppsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse,error)

Do executes the "appengine.apps.operations.list" call.Exactly one of *ListOperationsResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*ListOperationsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*AppsOperationsListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsOperationsListCall)Filter ¶

func (c *AppsOperationsListCall) Filter(filterstring) *AppsOperationsListCall

Filter sets the optional parameter "filter": The standard listfilter.

func (*AppsOperationsListCall)Header ¶

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

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

func (*AppsOperationsListCall)IfNoneMatch ¶

func (c *AppsOperationsListCall) IfNoneMatch(entityTagstring) *AppsOperationsListCall

func (*AppsOperationsListCall)PageSize ¶

func (c *AppsOperationsListCall) PageSize(pageSizeint64) *AppsOperationsListCall

PageSize sets the optional parameter "pageSize": The standard listpage size.

func (*AppsOperationsListCall)PageToken ¶

func (c *AppsOperationsListCall) PageToken(pageTokenstring) *AppsOperationsListCall

PageToken sets the optional parameter "pageToken": The standard listpage token.

func (*AppsOperationsListCall)Pages ¶

func (c *AppsOperationsListCall) Pages(ctxcontext.Context, f func(*ListOperationsResponse)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.

typeAppsOperationsService ¶

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

funcNewAppsOperationsService ¶

func NewAppsOperationsService(s *APIService) *AppsOperationsService

func (*AppsOperationsService)Get ¶

func (r *AppsOperationsService) Get(appsIdstring, operationsIdstring) *AppsOperationsGetCall

Get: Gets the latest state of a long-running operation. Clients canuse this method to poll the operation result at intervals asrecommended by the API service.

func (*AppsOperationsService)List ¶

func (r *AppsOperationsService) List(appsIdstring) *AppsOperationsListCall

List: Lists operations that match the specified filter in therequest. If the server doesn't support this method, it returnsUNIMPLEMENTED.NOTE: the name binding allows API services to overridethe binding to use different resource name schemes, such asusers/*/operations. To override the binding, API services can add abinding such as "/v1/{name=users/*}/operations" to their serviceconfiguration. For backwards compatibility, the default name includesthe operations collection id, however overriding users must ensurethe name binding is the parent resource, without the operationscollection id.

typeAppsPatchCall ¶

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

func (*AppsPatchCall)Context ¶

func (c *AppsPatchCall) Context(ctxcontext.Context) *AppsPatchCall

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*AppsPatchCall)Do ¶

func (c *AppsPatchCall) Do(opts ...googleapi.CallOption) (*Operation,error)

Do executes the "appengine.apps.patch" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AppsPatchCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*AppsPatchCall)Header ¶

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

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

func (*AppsPatchCall)Mask ¶

func (c *AppsPatchCall) Mask(maskstring) *AppsPatchCall

Mask sets the optional parameter "mask": Standard field mask for theset of fields to be updated.

typeAppsService ¶

type AppsService struct {Locations *AppsLocationsServiceModules *AppsModulesServiceOperations *AppsOperationsService// contains filtered or unexported fields}

funcNewAppsService ¶

func NewAppsService(s *APIService) *AppsService

func (*AppsService)Create ¶

func (r *AppsService) Create(application *Application) *AppsCreateCall

Create: Creates an App Engine application for a Google Cloud Platformproject. Required fields:id - The ID of the target Cloud Platform project.location - The region(https://cloud.google.com/appengine/docs/locations) where you wantthe App Engine application located.For more information about AppEngine applications, see Managing Projects, Applications, and Billing(https://cloud.google.com/appengine/docs/python/console/).

func (*AppsService)Get ¶

func (r *AppsService) Get(appsIdstring) *AppsGetCall

Get: Gets information about an application.

func (*AppsService)Patch ¶

func (r *AppsService) Patch(appsIdstring, application *Application) *AppsPatchCall

Patch: Updates the specified Application resource. You can update thefollowing fields:auth_domain(https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)default_cookie_expiration(https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)

typeAutomaticScaling ¶

type AutomaticScaling struct {// CoolDownPeriod: The time period that the Autoscaler// (https://cloud.google.com/compute/docs/autoscaler/) should wait// before it starts collecting information from a new instance. This// prevents the autoscaler from collecting information when the instance// is initializing, during which the collected usage would not be// reliable. Only applicable in the App Engine flexible environment.CoolDownPeriodstring `json:"coolDownPeriod,omitempty"`// CpuUtilization: Target scaling by CPU usage.CpuUtilization *CpuUtilization `json:"cpuUtilization,omitempty"`// DiskUtilization: Target scaling by disk usage.DiskUtilization *DiskUtilization `json:"diskUtilization,omitempty"`// MaxConcurrentRequests: Number of concurrent requests an automatic// scaling instance can accept before the scheduler spawns a new// instance.Defaults to a runtime-specific value.MaxConcurrentRequestsint64 `json:"maxConcurrentRequests,omitempty"`// MaxIdleInstances: Maximum number of idle instances that should be// maintained for this version.MaxIdleInstancesint64 `json:"maxIdleInstances,omitempty"`// MaxPendingLatency: Maximum amount of time that a request should wait// in the pending queue before starting a new instance to handle it.MaxPendingLatencystring `json:"maxPendingLatency,omitempty"`// MaxTotalInstances: Maximum number of instances that should be started// to handle requests.MaxTotalInstancesint64 `json:"maxTotalInstances,omitempty"`// MinIdleInstances: Minimum number of idle instances that should be// maintained for this version. Only applicable for the default version// of a module.MinIdleInstancesint64 `json:"minIdleInstances,omitempty"`// MinPendingLatency: Minimum amount of time a request should wait in// the pending queue before starting a new instance to handle it.MinPendingLatencystring `json:"minPendingLatency,omitempty"`// MinTotalInstances: Minimum number of instances that should be// maintained for this version.MinTotalInstancesint64 `json:"minTotalInstances,omitempty"`// NetworkUtilization: Target scaling by network usage.NetworkUtilization *NetworkUtilization `json:"networkUtilization,omitempty"`// RequestUtilization: Target scaling by request utilization.RequestUtilization *RequestUtilization `json:"requestUtilization,omitempty"`// ForceSendFields is a list of field names (e.g. "CoolDownPeriod") 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. "CoolDownPeriod") 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:"-"`}

AutomaticScaling: Automatic scaling is based on request rate,response latencies, and other application metrics.

func (*AutomaticScaling)MarshalJSON ¶

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

typeBasicScaling ¶

type BasicScaling struct {// IdleTimeout: Duration of time after the last request that an instance// must wait before the instance is shut down.IdleTimeoutstring `json:"idleTimeout,omitempty"`// MaxInstances: Maximum number of instances to create for this version.MaxInstancesint64 `json:"maxInstances,omitempty"`// ForceSendFields is a list of field names (e.g. "IdleTimeout") 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. "IdleTimeout") 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:"-"`}

BasicScaling: A module with basic scaling will create an instancewhen the application receives a request. The instance will be turneddown when the app becomes idle. Basic scaling is ideal for work thatis intermittent or driven by user activity.

func (*BasicScaling)MarshalJSON ¶

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

typeContainerInfo ¶

type ContainerInfo struct {// Image: URI to the hosted container image in Google Container// Registry. The URI must be fully qualified and include a tag or// digest. Examples: "gcr.io/my-project/image:tag" or// "gcr.io/my-project/image@digest"Imagestring `json:"image,omitempty"`// ForceSendFields is a list of field names (e.g. "Image") 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. "Image") 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:"-"`}

ContainerInfo: Docker image that is used to create a container andstart a VM instance for the version that you deploy. Only applicablefor instances running in the App Engine flexible environment.

func (*ContainerInfo)MarshalJSON ¶

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

typeCpuUtilization ¶

type CpuUtilization struct {// AggregationWindowLength: Period of time over which CPU utilization is// calculated.AggregationWindowLengthstring `json:"aggregationWindowLength,omitempty"`// TargetUtilization: Target CPU utilization ratio to maintain when// scaling. Must be between 0 and 1.TargetUtilizationfloat64 `json:"targetUtilization,omitempty"`// ForceSendFields is a list of field names (e.g.// "AggregationWindowLength") 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. "AggregationWindowLength")// 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:"-"`}

CpuUtilization: Target scaling by CPU usage.

func (*CpuUtilization)MarshalJSON ¶

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

func (*CpuUtilization)UnmarshalJSON ¶

func (s *CpuUtilization) UnmarshalJSON(data []byte)error

typeCreateVersionMetadataV1 ¶

type CreateVersionMetadataV1 struct {// CloudBuildId: The Cloud Build ID if one was created as part of the// version create. @OutputOnlyCloudBuildIdstring `json:"cloudBuildId,omitempty"`// ForceSendFields is a list of field names (e.g. "CloudBuildId") 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. "CloudBuildId") 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:"-"`}

CreateVersionMetadataV1: Metadata for the givengoogle.longrunning.Operation during agoogle.appengine.v1.CreateVersionRequest.

func (*CreateVersionMetadataV1)MarshalJSON ¶

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

typeCreateVersionMetadataV1Alpha ¶

type CreateVersionMetadataV1Alpha struct {// CloudBuildId: The Cloud Build ID if one was created as part of the// version create. @OutputOnlyCloudBuildIdstring `json:"cloudBuildId,omitempty"`// ForceSendFields is a list of field names (e.g. "CloudBuildId") 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. "CloudBuildId") 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:"-"`}

CreateVersionMetadataV1Alpha: Metadata for the givengoogle.longrunning.Operation during agoogle.appengine.v1alpha.CreateVersionRequest.

func (*CreateVersionMetadataV1Alpha)MarshalJSON ¶

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

typeCreateVersionMetadataV1Beta ¶

type CreateVersionMetadataV1Beta struct {// CloudBuildId: The Cloud Build ID if one was created as part of the// version create. @OutputOnlyCloudBuildIdstring `json:"cloudBuildId,omitempty"`// ForceSendFields is a list of field names (e.g. "CloudBuildId") 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. "CloudBuildId") 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:"-"`}

CreateVersionMetadataV1Beta: Metadata for the givengoogle.longrunning.Operation during agoogle.appengine.v1beta.CreateVersionRequest.

func (*CreateVersionMetadataV1Beta)MarshalJSON ¶

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

typeDebugInstanceRequest ¶

type DebugInstanceRequest struct {// SshKey: Public SSH key to add to the instance.// Examples:// [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]// [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh// {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more// information, see Adding and Removing SSH Keys// (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).SshKeystring `json:"sshKey,omitempty"`// ForceSendFields is a list of field names (e.g. "SshKey") 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. "SshKey") 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:"-"`}

DebugInstanceRequest: Request message for Instances.DebugInstance.

func (*DebugInstanceRequest)MarshalJSON ¶

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

typeDeployment ¶

type Deployment struct {// Container: The Docker image for the container that runs the version.// Only applicable for instances running in the App Engine flexible// environment.Container *ContainerInfo `json:"container,omitempty"`// Files: Manifest of the files stored in Google Cloud Storage that are// included as part of this version. All files must be readable using// the credentials supplied with this call.Files map[string]FileInfo `json:"files,omitempty"`// SourceReferences: Origin of the source code for this deployment.// There can be more than one source reference per version if source// code is distributed among multiple repositories.SourceReferences []*SourceReference `json:"sourceReferences,omitempty"`// ForceSendFields is a list of field names (e.g. "Container") 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. "Container") 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:"-"`}

Deployment: Code and application artifacts used to deploy a versionto App Engine.

func (*Deployment)MarshalJSON ¶

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

typeDiskUtilization ¶

type DiskUtilization struct {// TargetReadBytesPerSec: Target bytes read per second.TargetReadBytesPerSecint64 `json:"targetReadBytesPerSec,omitempty"`// TargetReadOpsPerSec: Target ops read per second.TargetReadOpsPerSecint64 `json:"targetReadOpsPerSec,omitempty"`// TargetWriteBytesPerSec: Target bytes written per second.TargetWriteBytesPerSecint64 `json:"targetWriteBytesPerSec,omitempty"`// TargetWriteOpsPerSec: Target ops written per second.TargetWriteOpsPerSecint64 `json:"targetWriteOpsPerSec,omitempty"`// ForceSendFields is a list of field names (e.g.// "TargetReadBytesPerSec") 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. "TargetReadBytesPerSec") 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:"-"`}

DiskUtilization: Target scaling by disk usage. Only applicable for VMruntimes.

func (*DiskUtilization)MarshalJSON ¶

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

typeEndpointsApiService ¶

type EndpointsApiService struct {// ConfigId: Endpoints service configuration id as specified by the// Service Management API. For example "2016-09-19r1"By default, the// Endpoints service configuration id is fixed and config_id must be// specified. To keep the Endpoints service configuration id updated// with each rollout, specify RolloutStrategy.MANAGED and omit// config_id.ConfigIdstring `json:"configId,omitempty"`// DisableTraceSampling: Enable or disable trace sampling. By default,// this is set to false for enabled.DisableTraceSamplingbool `json:"disableTraceSampling,omitempty"`// Name: Endpoints service name which is the name of the "service"// resource in the Service Management API. For example// "myapi.endpoints.myproject.cloud.goog"Namestring `json:"name,omitempty"`// RolloutStrategy: Endpoints rollout strategy. If FIXED, config_id must// be specified. If MANAGED, config_id must be omitted.//// Possible values://   "UNSPECIFIED_ROLLOUT_STRATEGY" - Not specified. Defaults to FIXED.//   "FIXED" - Endpoints service configuration id will be fixed to the// configuration id specified by config_id.//   "MANAGED" - Endpoints service configuration id will be updated with// each rollout.RolloutStrategystring `json:"rolloutStrategy,omitempty"`// ForceSendFields is a list of field names (e.g. "ConfigId") 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. "ConfigId") 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:"-"`}

EndpointsApiService: Cloud Endpoints(https://cloud.google.com/endpoints) configuration. The Endpoints APIService provides tooling for serving Open API and gRPC endpoints viaan NGINX proxy. Only valid for App Engine Flexible environmentdeployments..The fields here refer to the name and configuration idof a "service" resource in the Service Management API(https://cloud.google.com/service-management/overview).

func (*EndpointsApiService)MarshalJSON ¶

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

typeErrorHandler ¶

type ErrorHandler struct {// ErrorCode: Error condition this handler applies to.//// Possible values:// "ERROR_CODE_UNSPECIFIED" - Not specified. ERROR_CODE_DEFAULT is// assumed.// "ERROR_CODE_DEFAULT" - All other error types.// "ERROR_CODE_OVER_QUOTA" - Application has exceeded a resource// quota.// "ERROR_CODE_DOS_API_DENIAL" - Client blocked by the application's// Denial of Service protection configuration.// "ERROR_CODE_TIMEOUT" - Deadline reached before the application// responds.ErrorCodestring `json:"errorCode,omitempty"`// MimeType: MIME type of file. Defaults to text/html.MimeTypestring `json:"mimeType,omitempty"`// StaticFile: Static file content to be served for this error.StaticFilestring `json:"staticFile,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorCode") 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. "ErrorCode") 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:"-"`}

ErrorHandler: Custom static error page to be served when an erroroccurs.

func (*ErrorHandler)MarshalJSON ¶

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

typeFileInfo ¶

type FileInfo struct {// MimeType: The MIME type of the file.Defaults to the value from Google// Cloud Storage.MimeTypestring `json:"mimeType,omitempty"`// Sha1Sum: The SHA1 hash of the file, in hex.Sha1Sumstring `json:"sha1Sum,omitempty"`// SourceUrl: URL source to use to fetch this file. Must be a URL to a// resource in Google Cloud Storage in the form// 'http(s)://storage.googleapis.com/<bucket>/<object>'.SourceUrlstring `json:"sourceUrl,omitempty"`// ForceSendFields is a list of field names (e.g. "MimeType") 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. "MimeType") 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:"-"`}

FileInfo: Single source file that is part of the version to bedeployed. Each source file that is deployed must be specifiedseparately.

func (*FileInfo)MarshalJSON ¶

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

typeHealthCheck ¶

type HealthCheck struct {// CheckInterval: Interval between health checks.CheckIntervalstring `json:"checkInterval,omitempty"`// DisableHealthCheck: Whether to explicitly disable health checks for// this instance.DisableHealthCheckbool `json:"disableHealthCheck,omitempty"`// HealthyThreshold: Number of consecutive successful health checks// required before receiving traffic.HealthyThresholdint64 `json:"healthyThreshold,omitempty"`// Host: Host header to send when performing an HTTP health check.// Example: "myapp.appspot.com"Hoststring `json:"host,omitempty"`// RestartThreshold: Number of consecutive failed health checks required// before an instance is restarted.RestartThresholdint64 `json:"restartThreshold,omitempty"`// Timeout: Time before the health check is considered failed.Timeoutstring `json:"timeout,omitempty"`// UnhealthyThreshold: Number of consecutive failed health checks// required before removing traffic.UnhealthyThresholdint64 `json:"unhealthyThreshold,omitempty"`// ForceSendFields is a list of field names (e.g. "CheckInterval") 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. "CheckInterval") 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:"-"`}

HealthCheck: Health checking configuration for VM instances.Unhealthy instances are killed and replaced with new instances. Onlyapplicable for instances in App Engine flexible environment.

func (*HealthCheck)MarshalJSON ¶

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

typeIdentityAwareProxy ¶

type IdentityAwareProxy struct {// Enabled: Whether the serving infrastructure will authenticate and// authorize all incoming requests.If true, the oauth2_client_id and// oauth2_client_secret fields must be non-empty.Enabledbool `json:"enabled,omitempty"`// Oauth2ClientId: OAuth2 client ID to use for the authentication flow.Oauth2ClientIdstring `json:"oauth2ClientId,omitempty"`// Oauth2ClientSecret: For security reasons, this value cannot be// retrieved via the API. Instead, the SHA-256 hash of the value is// returned in the oauth2_client_secret_sha256 field.@InputOnlyOauth2ClientSecretstring `json:"oauth2ClientSecret,omitempty"`// Oauth2ClientSecretSha256: Hex-encoded SHA-256 hash of the client// secret.@OutputOnlyOauth2ClientSecretSha256string `json:"oauth2ClientSecretSha256,omitempty"`// ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"`}

IdentityAwareProxy: Identity-Aware Proxy

func (*IdentityAwareProxy)MarshalJSON ¶

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

typeInstance ¶

type Instance struct {// AppEngineRelease: App Engine release this instance is running// on.@OutputOnlyAppEngineReleasestring `json:"appEngineRelease,omitempty"`// Availability: Availability of the instance.@OutputOnly//// Possible values://   "UNSPECIFIED"//   "RESIDENT"//   "DYNAMIC"Availabilitystring `json:"availability,omitempty"`// AverageLatency: Average latency (ms) over the last minute.@OutputOnlyAverageLatencyint64 `json:"averageLatency,omitempty"`// Errors: Number of errors since this instance was started.@OutputOnlyErrorsint64 `json:"errors,omitempty"`// Id: Relative name of the instance within the version. Example:// instance-1.@OutputOnlyIdstring `json:"id,omitempty"`// MemoryUsage: Total memory in use (bytes).@OutputOnlyMemoryUsageint64 `json:"memoryUsage,omitempty,string"`// Name: Full path to the Instance resource in the API. Example:// apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnl// yNamestring `json:"name,omitempty"`// Qps: Average queries per second (QPS) over the last// minute.@OutputOnlyQpsfloat64 `json:"qps,omitempty"`// Requests: Number of requests since this instance was// started.@OutputOnlyRequestsint64 `json:"requests,omitempty"`// StartTimestamp: Time that this instance was started.@OutputOnlyStartTimestampstring `json:"startTimestamp,omitempty"`// VmId: Virtual machine ID of this instance. Only applicable for// instances in App Engine flexible environment.@OutputOnlyVmIdstring `json:"vmId,omitempty"`// VmIp: The IP address of this instance. Only applicable for instances// in App Engine flexible environment.@OutputOnlyVmIpstring `json:"vmIp,omitempty"`// VmName: Name of the virtual machine where this instance lives. Only// applicable for instances in App Engine flexible// environment.@OutputOnlyVmNamestring `json:"vmName,omitempty"`// VmStatus: Status of the virtual machine where this instance lives.// Only applicable for instances in App Engine flexible// environment.@OutputOnlyVmStatusstring `json:"vmStatus,omitempty"`// VmUnlocked: Whether this instance is in debug mode. Only applicable// for instances in App Engine flexible environment.@OutputOnlyVmUnlockedbool `json:"vmUnlocked,omitempty"`// VmZoneName: Zone where the virtual machine is located. Only// applicable for instances in App Engine flexible// environment.@OutputOnlyVmZoneNamestring `json:"vmZoneName,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AppEngineRelease") 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. "AppEngineRelease") 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:"-"`}

Instance: An Instance resource is the computing unit that App Engineuses to automatically scale an application.

func (*Instance)MarshalJSON ¶

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

func (*Instance)UnmarshalJSON ¶

func (s *Instance) UnmarshalJSON(data []byte)error

typeLibrary ¶

type Library struct {// Name: Name of the library. Example: "django".Namestring `json:"name,omitempty"`// Version: Version of the library to select, or "latest".Versionstring `json:"version,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:"-"`}

Library: Third-party Python runtime library that is required by theapplication.

func (*Library)MarshalJSON ¶

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

typeListInstancesResponse ¶

type ListInstancesResponse struct {// Instances: The instances belonging to the requested version.Instances []*Instance `json:"instances,omitempty"`// NextPageToken: Continuation token for fetching the next page of// results.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Instances") 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. "Instances") 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:"-"`}

ListInstancesResponse: Response message for Instances.ListInstances.

func (*ListInstancesResponse)MarshalJSON ¶

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

typeListLocationsResponse ¶

type ListLocationsResponse struct {// Locations: A list of locations that matches the specified filter in// the request.Locations []*Location `json:"locations,omitempty"`// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Locations") 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. "Locations") 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:"-"`}

ListLocationsResponse: The response message forLocations.ListLocations.

func (*ListLocationsResponse)MarshalJSON ¶

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

typeListModulesResponse ¶

type ListModulesResponse struct {// Modules: The modules belonging to the requested application.Modules []*Module `json:"modules,omitempty"`// NextPageToken: Continuation token for fetching the next page of// results.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Modules") 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. "Modules") 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:"-"`}

ListModulesResponse: Response message for Modules.ListModules.

func (*ListModulesResponse)MarshalJSON ¶

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

typeListOperationsResponse ¶

type ListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in// the request.Operations []*Operation `json:"operations,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:"-"`}

ListOperationsResponse: The response message forOperations.ListOperations.

func (*ListOperationsResponse)MarshalJSON ¶

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

typeListVersionsResponse ¶

type ListVersionsResponse struct {// NextPageToken: Continuation token for fetching the next page of// results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Versions: The versions belonging to the requested module.Versions []*Version `json:"versions,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:"-"`}

ListVersionsResponse: Response message for Versions.ListVersions.

func (*ListVersionsResponse)MarshalJSON ¶

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

typeLocation ¶

type Location struct {// DisplayName: The friendly name for this location, typically a nearby// city name. For example, "Tokyo".DisplayNamestring `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".LocationIdstring `json:"locationId,omitempty"`// Metadata: Service-specific metadata. For example the available// capacity at the given location.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: Resource name for the location, which may vary between// implementations. For example:// "projects/example-project/locations/us-east1"Namestring `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 ¶

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

typeLocationMetadata ¶

type LocationMetadata struct {// FlexibleEnvironmentAvailable: App Engine flexible environment is// available in the given location.@OutputOnlyFlexibleEnvironmentAvailablebool `json:"flexibleEnvironmentAvailable,omitempty"`// StandardEnvironmentAvailable: App Engine standard environment is// available in the given location.@OutputOnlyStandardEnvironmentAvailablebool `json:"standardEnvironmentAvailable,omitempty"`// ForceSendFields is a list of field names (e.g.// "FlexibleEnvironmentAvailable") 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.// "FlexibleEnvironmentAvailable") 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:"-"`}

LocationMetadata: Metadata for the givengoogle.cloud.location.Location.

func (*LocationMetadata)MarshalJSON ¶

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

typeManualScaling ¶

type ManualScaling struct {// Instances: Number of instances to assign to the module at the start.// This number can later be altered by using the Modules API// (https://cloud.google.com/appengine/docs/python/modules/functions)// set_num_instances() function.Instancesint64 `json:"instances,omitempty"`// ForceSendFields is a list of field names (e.g. "Instances") 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. "Instances") 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:"-"`}

ManualScaling: A module with manual scaling runs continuously,allowing you to perform complex initialization and rely on the stateof its memory over time.

func (*ManualScaling)MarshalJSON ¶

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

typeModule ¶

type Module struct {// Id: Relative name of the module within the application. Example:// default.@OutputOnlyIdstring `json:"id,omitempty"`// Name: Full path to the Module resource in the API. Example:// apps/myapp/modules/default.@OutputOnlyNamestring `json:"name,omitempty"`// Split: Mapping that defines fractional HTTP traffic diversion to// different versions within the module.Split *TrafficSplit `json:"split,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// 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:"-"`}

Module: A Module resource is a logical component of an applicationthat can share state and communicate in a secure fashion with othermodules. For example, an application that handles customer requestsmight include separate modules to handle tasks such as backend dataanalysis or API requests from mobile devices. Each module has acollection of versions that define a specific set of code used toimplement the functionality of that module.

func (*Module)MarshalJSON ¶

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

typeNetwork ¶

type Network struct {// ForwardedPorts: List of ports, or port pairs, to forward from the// virtual machine to the application container.ForwardedPorts []string `json:"forwardedPorts,omitempty"`// InstanceTag: Tag to apply to the VM instance during creation.InstanceTagstring `json:"instanceTag,omitempty"`// Name: Google Cloud Platform network where the virtual machines are// created. Specify the short name, not the resource path.Defaults to// default.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "ForwardedPorts") 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. "ForwardedPorts") 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:"-"`}

Network: Extra network settings. Only applicable for VM runtimes.

func (*Network)MarshalJSON ¶

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

typeNetworkUtilization ¶

type NetworkUtilization struct {// TargetReceivedBytesPerSec: Target bytes received per second.TargetReceivedBytesPerSecint64 `json:"targetReceivedBytesPerSec,omitempty"`// TargetReceivedPacketsPerSec: Target packets received per second.TargetReceivedPacketsPerSecint64 `json:"targetReceivedPacketsPerSec,omitempty"`// TargetSentBytesPerSec: Target bytes sent per second.TargetSentBytesPerSecint64 `json:"targetSentBytesPerSec,omitempty"`// TargetSentPacketsPerSec: Target packets sent per second.TargetSentPacketsPerSecint64 `json:"targetSentPacketsPerSec,omitempty"`// ForceSendFields is a list of field names (e.g.// "TargetReceivedBytesPerSec") 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.// "TargetReceivedBytesPerSec") 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:"-"`}

NetworkUtilization: Target scaling by network usage. Only applicablefor VM runtimes.

func (*NetworkUtilization)MarshalJSON ¶

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

typeOperation ¶

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.Donebool `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.Metadatagoogleapi.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.Namestring `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.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// 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 isthe result of a network API call.

func (*Operation)MarshalJSON ¶

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

typeOperationMetadata ¶

type OperationMetadata struct {// EndTime: Timestamp that this operation completed.@OutputOnlyEndTimestring `json:"endTime,omitempty"`// InsertTime: Timestamp that this operation was created.@OutputOnlyInsertTimestring `json:"insertTime,omitempty"`// Method: API method that initiated this operation. Example:// google.appengine.v1beta4.Version.CreateVersion.@OutputOnlyMethodstring `json:"method,omitempty"`// OperationType: Type of this operation. Deprecated, use method field// instead. Example: "create_version".@OutputOnlyOperationTypestring `json:"operationType,omitempty"`// Target: Name of the resource that this operation is acting on.// Example: apps/myapp/modules/default.@OutputOnlyTargetstring `json:"target,omitempty"`// User: User who requested this operation.@OutputOnlyUserstring `json:"user,omitempty"`// ForceSendFields is a list of field names (e.g. "EndTime") 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. "EndTime") 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:"-"`}

OperationMetadata: Metadata for the givengoogle.longrunning.Operation.

func (*OperationMetadata)MarshalJSON ¶

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

typeOperationMetadataV1 ¶

type OperationMetadataV1 struct {CreateVersionMetadata *CreateVersionMetadataV1 `json:"createVersionMetadata,omitempty"`// EndTime: Time that this operation completed.@OutputOnlyEndTimestring `json:"endTime,omitempty"`// EphemeralMessage: Ephemeral message that may change every time the// operation is polled. @OutputOnlyEphemeralMessagestring `json:"ephemeralMessage,omitempty"`// InsertTime: Time that this operation was created.@OutputOnlyInsertTimestring `json:"insertTime,omitempty"`// Method: API method that initiated this operation. Example:// google.appengine.v1.Versions.CreateVersion.@OutputOnlyMethodstring `json:"method,omitempty"`// Target: Name of the resource that this operation is acting on.// Example: apps/myapp/services/default.@OutputOnlyTargetstring `json:"target,omitempty"`// User: User who requested this operation.@OutputOnlyUserstring `json:"user,omitempty"`// Warning: Durable messages that persist on every operation poll.// @OutputOnlyWarning []string `json:"warning,omitempty"`// ForceSendFields is a list of field names (e.g.// "CreateVersionMetadata") 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. "CreateVersionMetadata") 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:"-"`}

OperationMetadataV1: Metadata for the givengoogle.longrunning.Operation.

func (*OperationMetadataV1)MarshalJSON ¶

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

typeOperationMetadataV1Alpha ¶

type OperationMetadataV1Alpha struct {CreateVersionMetadata *CreateVersionMetadataV1Alpha `json:"createVersionMetadata,omitempty"`// EndTime: Time that this operation completed.@OutputOnlyEndTimestring `json:"endTime,omitempty"`// EphemeralMessage: Ephemeral message that may change every time the// operation is polled. @OutputOnlyEphemeralMessagestring `json:"ephemeralMessage,omitempty"`// InsertTime: Time that this operation was created.@OutputOnlyInsertTimestring `json:"insertTime,omitempty"`// Method: API method that initiated this operation. Example:// google.appengine.v1alpha.Versions.CreateVersion.@OutputOnlyMethodstring `json:"method,omitempty"`// Target: Name of the resource that this operation is acting on.// Example: apps/myapp/services/default.@OutputOnlyTargetstring `json:"target,omitempty"`// User: User who requested this operation.@OutputOnlyUserstring `json:"user,omitempty"`// Warning: Durable messages that persist on every operation poll.// @OutputOnlyWarning []string `json:"warning,omitempty"`// ForceSendFields is a list of field names (e.g.// "CreateVersionMetadata") 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. "CreateVersionMetadata") 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:"-"`}

OperationMetadataV1Alpha: Metadata for the givengoogle.longrunning.Operation.

func (*OperationMetadataV1Alpha)MarshalJSON ¶

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

typeOperationMetadataV1Beta ¶

type OperationMetadataV1Beta struct {CreateVersionMetadata *CreateVersionMetadataV1Beta `json:"createVersionMetadata,omitempty"`// EndTime: Time that this operation completed.@OutputOnlyEndTimestring `json:"endTime,omitempty"`// EphemeralMessage: Ephemeral message that may change every time the// operation is polled. @OutputOnlyEphemeralMessagestring `json:"ephemeralMessage,omitempty"`// InsertTime: Time that this operation was created.@OutputOnlyInsertTimestring `json:"insertTime,omitempty"`// Method: API method that initiated this operation. Example:// google.appengine.v1beta.Versions.CreateVersion.@OutputOnlyMethodstring `json:"method,omitempty"`// Target: Name of the resource that this operation is acting on.// Example: apps/myapp/services/default.@OutputOnlyTargetstring `json:"target,omitempty"`// User: User who requested this operation.@OutputOnlyUserstring `json:"user,omitempty"`// Warning: Durable messages that persist on every operation poll.// @OutputOnlyWarning []string `json:"warning,omitempty"`// ForceSendFields is a list of field names (e.g.// "CreateVersionMetadata") 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. "CreateVersionMetadata") 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:"-"`}

OperationMetadataV1Beta: Metadata for the givengoogle.longrunning.Operation.

func (*OperationMetadataV1Beta)MarshalJSON ¶

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

typeOperationMetadataV1Beta5 ¶

type OperationMetadataV1Beta5 struct {// EndTime: Timestamp that this operation completed.@OutputOnlyEndTimestring `json:"endTime,omitempty"`// InsertTime: Timestamp that this operation was created.@OutputOnlyInsertTimestring `json:"insertTime,omitempty"`// Method: API method name that initiated this operation. Example:// google.appengine.v1beta5.Version.CreateVersion.@OutputOnlyMethodstring `json:"method,omitempty"`// Target: Name of the resource that this operation is acting on.// Example: apps/myapp/services/default.@OutputOnlyTargetstring `json:"target,omitempty"`// User: User who requested this operation.@OutputOnlyUserstring `json:"user,omitempty"`// ForceSendFields is a list of field names (e.g. "EndTime") 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. "EndTime") 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:"-"`}

OperationMetadataV1Beta5: Metadata for the givengoogle.longrunning.Operation.

func (*OperationMetadataV1Beta5)MarshalJSON ¶

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

typeRequestUtilization ¶

type RequestUtilization struct {// TargetConcurrentRequests: Target number of concurrent requests.TargetConcurrentRequestsint64 `json:"targetConcurrentRequests,omitempty"`// TargetRequestCountPerSec: Target requests per second.TargetRequestCountPerSecint64 `json:"targetRequestCountPerSec,omitempty"`// ForceSendFields is a list of field names (e.g.// "TargetConcurrentRequests") 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. "TargetConcurrentRequests")// 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:"-"`}

RequestUtilization: Target scaling by request utilization. Onlyapplicable for VM runtimes.

func (*RequestUtilization)MarshalJSON ¶

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

typeResources ¶

type Resources struct {// Cpu: Number of CPU cores needed.Cpufloat64 `json:"cpu,omitempty"`// DiskGb: Disk size (GB) needed.DiskGbfloat64 `json:"diskGb,omitempty"`// MemoryGb: Memory (GB) needed.MemoryGbfloat64 `json:"memoryGb,omitempty"`// Volumes: User specified volumes.Volumes []*Volume `json:"volumes,omitempty"`// ForceSendFields is a list of field names (e.g. "Cpu") 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. "Cpu") 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:"-"`}

Resources: Machine resources for a version.

func (*Resources)MarshalJSON ¶

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

func (*Resources)UnmarshalJSON ¶

func (s *Resources) UnmarshalJSON(data []byte)error

typeScriptHandler ¶

type ScriptHandler struct {// ScriptPath: Path to the script from the application root directory.ScriptPathstring `json:"scriptPath,omitempty"`// ForceSendFields is a list of field names (e.g. "ScriptPath") 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. "ScriptPath") 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:"-"`}

ScriptHandler: Executes a script to handle the request that matchesthe URL pattern.

func (*ScriptHandler)MarshalJSON ¶

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

typeSourceReference ¶

type SourceReference struct {// Repository: URI string identifying the repository. Example:// "https://source.developers.google.com/p/app-123/r/default"Repositorystring `json:"repository,omitempty"`// RevisionId: The canonical, persistent identifier of the deployed// revision. Aliases that include tags or branch names are not allowed.// Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"RevisionIdstring `json:"revisionId,omitempty"`// ForceSendFields is a list of field names (e.g. "Repository") 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. "Repository") 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:"-"`}

SourceReference: Reference to a particular snapshot of the sourcetree used to build and deploy the application.

func (*SourceReference)MarshalJSON ¶

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

typeStaticDirectoryHandler ¶

type StaticDirectoryHandler struct {// ApplicationReadable: Whether files should also be uploaded as code// data. By default, files declared in static directory handlers are// uploaded as static data and are only served to end users; they cannot// be read by the application. If enabled, uploads are charged against// both your code and static data storage resource quotas.ApplicationReadablebool `json:"applicationReadable,omitempty"`// Directory: Path to the directory containing the static files from the// application root directory. Everything after the end of the matched// URL pattern is appended to static_dir to form the full path to the// requested file.Directorystring `json:"directory,omitempty"`// Expiration: Time a static file served by this handler should be// cached.Expirationstring `json:"expiration,omitempty"`// HttpHeaders: HTTP headers to use for all responses from these URLs.HttpHeaders map[string]string `json:"httpHeaders,omitempty"`// MimeType: MIME type used to serve all files served by this handler.// Defaults to file-specific MIME types, which are direved from each// file's filename extension.MimeTypestring `json:"mimeType,omitempty"`// RequireMatchingFile: Whether this handler should match the request if// the file referenced by the handler does not exist.RequireMatchingFilebool `json:"requireMatchingFile,omitempty"`// ForceSendFields is a list of field names (e.g. "ApplicationReadable")// 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. "ApplicationReadable") 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:"-"`}

StaticDirectoryHandler: Files served directly to the user for a givenURL, such as images, CSS stylesheets, or JavaScript source files.Static directory handlers make it easy to serve the entire contentsof a directory as static files.

func (*StaticDirectoryHandler)MarshalJSON ¶

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

typeStaticFilesHandler ¶

type StaticFilesHandler struct {// ApplicationReadable: Whether files should also be uploaded as code// data. By default, files declared in static file handlers are uploaded// as static data and are only served to end users; they cannot be read// by the application. If enabled, uploads are charged against both your// code and static data storage resource quotas.ApplicationReadablebool `json:"applicationReadable,omitempty"`// Expiration: Time a static file served by this handler should be// cached.Expirationstring `json:"expiration,omitempty"`// HttpHeaders: HTTP headers to use for all responses from these URLs.HttpHeaders map[string]string `json:"httpHeaders,omitempty"`// MimeType: MIME type used to serve all files served by this handler.// Defaults to file-specific MIME types, which are derived from each// file's filename extension.MimeTypestring `json:"mimeType,omitempty"`// Path: Path to the static files matched by the URL pattern, from the// application root directory. The path can refer to text matched in// groupings in the URL pattern.Pathstring `json:"path,omitempty"`// RequireMatchingFile: Whether this handler should match the request if// the file referenced by the handler does not exist.RequireMatchingFilebool `json:"requireMatchingFile,omitempty"`// UploadPathRegex: Regular expression that matches the file paths for// all files that should be referenced by this handler.UploadPathRegexstring `json:"uploadPathRegex,omitempty"`// ForceSendFields is a list of field names (e.g. "ApplicationReadable")// 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. "ApplicationReadable") 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:"-"`}

StaticFilesHandler: Files served directly to the user for a givenURL, such as images, CSS stylesheets, or JavaScript source files.Static file handlers describe which files in the applicationdirectory are static files, and which URLs serve them.

func (*StaticFilesHandler)MarshalJSON ¶

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

typeStatus ¶

type Status struct {// Code: The status code, which should be an enum value of// google.rpc.Code.Codeint64 `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.Messagestring `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 issuitable for different programming environments, including REST APIsand RPC APIs. It is used by gRPC (https://github.com/grpc). The errormodel is designed to be:Simple to use and understand for most usersFlexible enough to meet unexpected needsOverviewThe Status messagecontains three pieces of data: error code, error message, and errordetails. The error code should be an enum value of google.rpc.Code,but it may accept additional error codes if needed. The error messageshould be a developer-facing English message that helps developersunderstand and resolve the error. If a localized user-facing errormessage is needed, put the localized message in the error details orlocalize it in the client. The optional error details may containarbitrary information about the error. There is a predefined set oferror detail types in the package google.rpc that can be used forcommon error conditions.Language mappingThe Status message is thelogical representation of the error model, but it is not necessarilythe actual wire format. When the Status message is exposed indifferent client libraries and different wire protocols, it can bemapped differently. For example, it will likely be mapped to someexceptions in Java, but more likely mapped to some error codes inC.Other usesThe error model and the Status message can be used in avariety of environments, either with or without APIs, to provide aconsistent developer experience across different environments.Exampleuses of this error model include:Partial errors. If a service needs to return partial errors to theclient, it may embed the Status in the normal response to indicatethe partial errors.Workflow errors. A typical workflow has multiple steps. Each step mayhave 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, onefor each error sub-response.Asynchronous operations. If an API call embeds asynchronous operationresults in its response, the status of those operations should berepresented directly using the Status message.Logging. If some API errors are stored in logs, the message Statuscould be used directly after any stripping needed forsecurity/privacy reasons.

func (*Status)MarshalJSON ¶

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

typeTrafficSplit ¶

type TrafficSplit struct {// Allocations: Mapping from version IDs within the module to fractional// (0.000, 1] allocations of traffic for that version. Each version can// be specified only once, but some versions in the module may not have// any traffic allocation. Modules that have traffic allocated cannot be// deleted until either the module is deleted or their traffic// allocation is removed. Allocations must sum to 1. Up to two decimal// place precision is supported for IP-based splits and up to three// decimal places is supported for cookie-based splits.Allocations map[string]float64 `json:"allocations,omitempty"`// ShardBy: Mechanism used to determine which version a request is sent// to. The traffic selection algorithm will be stable for either type// until allocations are changed.//// Possible values:// "UNSPECIFIED" - Diversion method unspecified.// "COOKIE" - Diversion based on a specially named cookie,// "GOOGAPPUID." The cookie must be set by the application itself or// else no diversion will occur.// "IP" - Diversion based on applying the modulus operation to a// fingerprint of the IP address.ShardBystring `json:"shardBy,omitempty"`// ForceSendFields is a list of field names (e.g. "Allocations") 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. "Allocations") 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:"-"`}

TrafficSplit: Traffic routing configuration for versions within asingle module. Traffic splits define how traffic directed to themodule is assigned to versions.

func (*TrafficSplit)MarshalJSON ¶

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

typeUrlDispatchRule ¶

type UrlDispatchRule struct {// Domain: Domain name to match against. The wildcard "*" is supported// if specified before a period: "*.".Defaults to matching all domains:// "*".Domainstring `json:"domain,omitempty"`// Module: Resource ID of a module in this application that should serve// the matched request. The module must already exist. Example: default.Modulestring `json:"module,omitempty"`// Path: Pathname within the host. Must start with a "/". A single "*"// can be included at the end of the path. The sum of the lengths of the// domain and path may not exceed 100 characters.Pathstring `json:"path,omitempty"`// ForceSendFields is a list of field names (e.g. "Domain") 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. "Domain") 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:"-"`}

UrlDispatchRule: Rules to match an HTTP request and dispatch thatrequest to a module.

func (*UrlDispatchRule)MarshalJSON ¶

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

typeUrlMap ¶

type UrlMap struct {// ApiEndpoint: Uses API Endpoints to handle requests.ApiEndpoint *ApiEndpointHandler `json:"apiEndpoint,omitempty"`// AuthFailAction: Action to take when users access resources that// require authentication. Defaults to redirect.//// Possible values://   "AUTH_FAIL_ACTION_UNSPECIFIED" - Not specified.// AUTH_FAIL_ACTION_REDIRECT is assumed.//   "AUTH_FAIL_ACTION_REDIRECT" - Redirects user to// "accounts.google.com". The user is redirected back to the application// URL after signing in or creating an account.//   "AUTH_FAIL_ACTION_UNAUTHORIZED" - Rejects request with a 401 HTTP// status code and an error message.AuthFailActionstring `json:"authFailAction,omitempty"`// Login: Level of login required to access this resource.//// Possible values://   "LOGIN_UNSPECIFIED" - Not specified. LOGIN_OPTIONAL is assumed.//   "LOGIN_OPTIONAL" - Does not require that the user is signed in.//   "LOGIN_ADMIN" - If the user is not signed in, the auth_fail_action// is taken. In addition, if the user is not an administrator for the// application, they are given an error message regardless of// auth_fail_action. If the user is an administrator, the handler// proceeds.//   "LOGIN_REQUIRED" - If the user has signed in, the handler proceeds// normally. Otherwise, the auth_fail_action is taken.Loginstring `json:"login,omitempty"`// RedirectHttpResponseCode: 30x code to use when performing redirects// for the secure field. Defaults to 302.//// Possible values://   "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED" - Not specified. 302 is// assumed.//   "REDIRECT_HTTP_RESPONSE_CODE_301" - 301 Moved Permanently code.//   "REDIRECT_HTTP_RESPONSE_CODE_302" - 302 Moved Temporarily code.//   "REDIRECT_HTTP_RESPONSE_CODE_303" - 303 See Other code.//   "REDIRECT_HTTP_RESPONSE_CODE_307" - 307 Temporary Redirect code.RedirectHttpResponseCodestring `json:"redirectHttpResponseCode,omitempty"`// Script: Executes a script to handle the request that matches this URL// pattern.Script *ScriptHandler `json:"script,omitempty"`// SecurityLevel: Security (HTTPS) enforcement for this URL.//// Possible values://   "SECURE_UNSPECIFIED" - Not specified.//   "SECURE_DEFAULT" - Both HTTP and HTTPS requests with URLs that// match the handler succeed without redirects. The application can// examine the request to determine which protocol was used, and respond// accordingly.//   "SECURE_NEVER" - Requests for a URL that match this handler that// use HTTPS are automatically redirected to the HTTP equivalent URL.//   "SECURE_OPTIONAL" - Both HTTP and HTTPS requests with URLs that// match the handler succeed without redirects. The application can// examine the request to determine which protocol was used and respond// accordingly.//   "SECURE_ALWAYS" - Requests for a URL that match this handler that// do not use HTTPS are automatically redirected to the HTTPS URL with// the same path. Query parameters are reserved for the redirect.SecurityLevelstring `json:"securityLevel,omitempty"`// StaticDirectory: Serves the entire contents of a directory as static// files.This attribute is deprecated. You can mimic the behavior of// static directories using static files.StaticDirectory *StaticDirectoryHandler `json:"staticDirectory,omitempty"`// StaticFiles: Returns the contents of a file, such as an image, as the// response.StaticFiles *StaticFilesHandler `json:"staticFiles,omitempty"`// UrlRegex: A URL prefix. Uses regular expression syntax, which means// regexp special characters must be escaped, but should not contain// groupings. All URLs that begin with this prefix are handled by this// handler, using the portion of the URL after the prefix as part of the// file path.UrlRegexstring `json:"urlRegex,omitempty"`// ForceSendFields is a list of field names (e.g. "ApiEndpoint") 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. "ApiEndpoint") 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:"-"`}

UrlMap: URL pattern and description of how the URL should be handled.App Engine can handle URLs by executing application code, or byserving static files uploaded with the version, such as images, CSS,or JavaScript.

func (*UrlMap)MarshalJSON ¶

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

typeVersion ¶

type Version struct {// ApiConfig: Serving configuration for Google Cloud Endpoints// (https://cloud.google.com/appengine/docs/python/endpoints/).Only// returned in GET requests if view=FULL is set.ApiConfig *ApiConfigHandler `json:"apiConfig,omitempty"`// AutomaticScaling: Automatic scaling is based on request rate,// response latencies, and other application metrics.AutomaticScaling *AutomaticScaling `json:"automaticScaling,omitempty"`// BasicScaling: A module with basic scaling will create an instance// when the application receives a request. The instance will be turned// down when the app becomes idle. Basic scaling is ideal for work that// is intermittent or driven by user activity.BasicScaling *BasicScaling `json:"basicScaling,omitempty"`// BetaSettings: Metadata settings that are supplied to this version to// enable beta runtime features.BetaSettings map[string]string `json:"betaSettings,omitempty"`// CreationTime: Time that this version was created.@OutputOnlyCreationTimestring `json:"creationTime,omitempty"`// DefaultExpiration: Duration that static files should be cached by web// proxies and browsers. Only applicable if the corresponding// StaticFilesHandler// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler)// does not specify its own expiration time.Only returned in GET// requests if view=FULL is set.DefaultExpirationstring `json:"defaultExpiration,omitempty"`// Deployer: Email address of the user who created this// version.@OutputOnlyDeployerstring `json:"deployer,omitempty"`// Deployment: Code and application artifacts that make up this// version.Only returned in GET requests if view=FULL is set.Deployment *Deployment `json:"deployment,omitempty"`// EndpointsApiService: Cloud Endpoints configuration.If// endpoints_api_service is set, the Cloud Endpoints Extensible Service// Proxy will be provided to serve the API implemented by the app.EndpointsApiService *EndpointsApiService `json:"endpointsApiService,omitempty"`// Env: App Engine execution environment to use for this// version.Defaults to 1.Envstring `json:"env,omitempty"`// EnvVariables: Environment variables made available to the// application.Only returned in GET requests if view=FULL is set.EnvVariables map[string]string `json:"envVariables,omitempty"`// ErrorHandlers: Custom static error pages. Limited to 10KB per// page.Only returned in GET requests if view=FULL is set.ErrorHandlers []*ErrorHandler `json:"errorHandlers,omitempty"`// Handlers: An ordered list of URL-matching patterns that should be// applied to incoming requests. The first matching URL handles the// request and other request handlers are not attempted.Only returned in// GET requests if view=FULL is set.Handlers []*UrlMap `json:"handlers,omitempty"`// HealthCheck: Configures health checking for VM instances. Unhealthy// instances are stopped and replaced with new instances. Only// applicable for VM runtimes.Only returned in GET requests if view=FULL// is set.HealthCheck *HealthCheck `json:"healthCheck,omitempty"`// Id: Relative name of the version within the module. Example: v1.// Version names can contain only lowercase letters, numbers, or// hyphens. Reserved names: "default", "latest", and any name with the// prefix "ah-".Idstring `json:"id,omitempty"`// InboundServices: Before an application can receive email or XMPP// messages, the application must be configured to enable the service.//// Possible values://   "INBOUND_SERVICE_UNSPECIFIED" - Not specified.//   "INBOUND_SERVICE_MAIL" - Allows an application to receive mail.//   "INBOUND_SERVICE_MAIL_BOUNCE" - Allows an application to receive// email-bound notifications.//   "INBOUND_SERVICE_XMPP_ERROR" - Allows an application to receive// error stanzas.//   "INBOUND_SERVICE_XMPP_MESSAGE" - Allows an application to receive// instant messages.//   "INBOUND_SERVICE_XMPP_SUBSCRIBE" - Allows an application to receive// user subscription POSTs.//   "INBOUND_SERVICE_XMPP_PRESENCE" - Allows an application to receive// a user's chat presence.//   "INBOUND_SERVICE_CHANNEL_PRESENCE" - Registers an application for// notifications when a client connects or disconnects from a channel.//   "INBOUND_SERVICE_WARMUP" - Enables warmup requests.InboundServices []string `json:"inboundServices,omitempty"`// InstanceClass: Instance class that is used to run this version. Valid// values are:// AutomaticScaling: F1, F2, F4, F4_1G// ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1// for AutomaticScaling and B1 for ManualScaling or BasicScaling.InstanceClassstring `json:"instanceClass,omitempty"`// Libraries: Configuration for third-party Python runtime libraries// required by the application.Only returned in GET requests if// view=FULL is set.Libraries []*Library `json:"libraries,omitempty"`// ManualScaling: A module with manual scaling runs continuously,// allowing you to perform complex initialization and rely on the state// of its memory over time.ManualScaling *ManualScaling `json:"manualScaling,omitempty"`// Name: Full path to the Version resource in the API. Example:// apps/myapp/modules/default/versions/v1.@OutputOnlyNamestring `json:"name,omitempty"`// Network: Extra network settings. Only applicable for VM runtimes.Network *Network `json:"network,omitempty"`// NobuildFilesRegex: Files that match this pattern will not be built// into this version. Only applicable for Go runtimes.Only returned in// GET requests if view=FULL is set.NobuildFilesRegexstring `json:"nobuildFilesRegex,omitempty"`// Resources: Machine resources for this version. Only applicable for VM// runtimes.Resources *Resources `json:"resources,omitempty"`// Runtime: Desired runtime. Example: python27.Runtimestring `json:"runtime,omitempty"`// RuntimeApiVersion: The version of the API in the given runtime// environment. Please see the app.yaml reference for valid values at//https://cloud.google.com/appengine/docs/standard/<language>/config/apprefRuntimeApiVersionstring `json:"runtimeApiVersion,omitempty"`// RuntimeMainExecutablePath: The path or name of the app's main// executable.RuntimeMainExecutablePathstring `json:"runtimeMainExecutablePath,omitempty"`// ServingStatus: Current serving status of this version. Only the// versions with a SERVING status create instances and can be// billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to// SERVING.//// Possible values://   "SERVING_STATUS_UNSPECIFIED" - Not specified.//   "SERVING" - Currently serving. Instances are created according to// the scaling settings of the version.//   "STOPPED" - Disabled. No instances will be created and the scaling// settings are ignored until the state of the version changes to// SERVING.ServingStatusstring `json:"servingStatus,omitempty"`// Threadsafe: Whether multiple requests can be dispatched to this// version at once.Threadsafebool `json:"threadsafe,omitempty"`// Vm: Whether to deploy this version in a container on a virtual// machine.Vmbool `json:"vm,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ApiConfig") 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. "ApiConfig") 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:"-"`}

Version: A Version resource is a specific set of source code andconfiguration files that are deployed into a module.

func (*Version)MarshalJSON ¶

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

typeVolume ¶

type Volume struct {// Name: Unique name for the volume.Namestring `json:"name,omitempty"`// SizeGb: Volume size in gigabytes.SizeGbfloat64 `json:"sizeGb,omitempty"`// VolumeType: Underlying volume type, e.g. 'tmpfs'.VolumeTypestring `json:"volumeType,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:"-"`}

Volume: Volumes mounted within the app container. Only applicable forVM runtimes.

func (*Volume)MarshalJSON ¶

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

func (*Volume)UnmarshalJSON ¶

func (s *Volume) UnmarshalJSON(data []byte)error

Source Files¶

View all Source files

appengine-gen.go

?	: This menu
/	: Search site
f orF	: Jump to
y orY	: Canonical URL

Movatterモバイル変換

Details

Repository

Links

Documentation¶

Overview¶

Creating a client¶

Other authentication options¶

Index¶

Constants¶

Variables¶

Functions¶

Types¶

typeAPIService¶

funcNewdeprecated

funcNewService¶added inv0.5.0

typeApiConfigHandler¶

func (*ApiConfigHandler)MarshalJSON¶

typeApiEndpointHandler¶

func (*ApiEndpointHandler)MarshalJSON¶

typeApplication¶

func (*Application)MarshalJSON¶

typeAppsCreateCall¶

func (*AppsCreateCall)Context¶

func (*AppsCreateCall)Do¶

func (*AppsCreateCall)Fields¶

func (*AppsCreateCall)Header¶

typeAppsGetCall¶

func (*AppsGetCall)Context¶

func (*AppsGetCall)Do¶

func (*AppsGetCall)EnsureResourcesExist¶

func (*AppsGetCall)Fields¶

func (*AppsGetCall)Header¶

func (*AppsGetCall)IfNoneMatch¶

typeAppsLocationsGetCall¶

func (*AppsLocationsGetCall)Context¶

func (*AppsLocationsGetCall)Do¶

func (*AppsLocationsGetCall)Fields¶

func (*AppsLocationsGetCall)Header¶

func (*AppsLocationsGetCall)IfNoneMatch¶

typeAppsLocationsListCall¶

func (*AppsLocationsListCall)Context¶

func (*AppsLocationsListCall)Do¶

func (*AppsLocationsListCall)Fields¶

func (*AppsLocationsListCall)Filter¶

func (*AppsLocationsListCall)Header¶

func (*AppsLocationsListCall)IfNoneMatch¶

func (*AppsLocationsListCall)PageSize¶

func (*AppsLocationsListCall)PageToken¶

func (*AppsLocationsListCall)Pages¶

typeAppsLocationsService¶

funcNewAppsLocationsService¶

func (*AppsLocationsService)Get¶

func (*AppsLocationsService)List¶

typeAppsModulesDeleteCall¶

func (*AppsModulesDeleteCall)Context¶

func (*AppsModulesDeleteCall)Do¶

func (*AppsModulesDeleteCall)Fields¶

func (*AppsModulesDeleteCall)Header¶

typeAppsModulesGetCall¶

func (*AppsModulesGetCall)Context¶

func (*AppsModulesGetCall)Do¶

func (*AppsModulesGetCall)Fields¶

func (*AppsModulesGetCall)Header¶

func (*AppsModulesGetCall)IfNoneMatch¶

typeAppsModulesListCall¶

func (*AppsModulesListCall)Context¶

func (*AppsModulesListCall)Do¶

func (*AppsModulesListCall)Fields¶

func (*AppsModulesListCall)Header¶

func (*AppsModulesListCall)IfNoneMatch¶

func (*AppsModulesListCall)PageSize¶

func (*AppsModulesListCall)PageToken¶

func (*AppsModulesListCall)Pages¶

typeAppsModulesPatchCall¶

func (*AppsModulesPatchCall)Context¶

func (*AppsModulesPatchCall)Do¶

func (*AppsModulesPatchCall)Fields¶

func (*AppsModulesPatchCall)Header¶

func (*AppsModulesPatchCall)Mask¶

Documentation ¶

typeAPIService ¶

funcNewService ¶added inv0.5.0

typeApiConfigHandler ¶

func (*ApiConfigHandler)MarshalJSON ¶

typeApiEndpointHandler ¶

func (*ApiEndpointHandler)MarshalJSON ¶

typeApplication ¶

func (*Application)MarshalJSON ¶

typeAppsCreateCall ¶

func (*AppsCreateCall)Context ¶

func (*AppsCreateCall)Do ¶

func (*AppsCreateCall)Fields ¶

func (*AppsCreateCall)Header ¶

typeAppsGetCall ¶

func (*AppsGetCall)Context ¶

func (*AppsGetCall)Do ¶

func (*AppsGetCall)EnsureResourcesExist ¶

func (*AppsGetCall)Fields ¶

func (*AppsGetCall)Header ¶

func (*AppsGetCall)IfNoneMatch ¶

typeAppsLocationsGetCall ¶

func (*AppsLocationsGetCall)Context ¶

func (*AppsLocationsGetCall)Do ¶

func (*AppsLocationsGetCall)Fields ¶

func (*AppsLocationsGetCall)Header ¶

func (*AppsLocationsGetCall)IfNoneMatch ¶

typeAppsLocationsListCall ¶

func (*AppsLocationsListCall)Context ¶

func (*AppsLocationsListCall)Do ¶

func (*AppsLocationsListCall)Fields ¶

func (*AppsLocationsListCall)Filter ¶

func (*AppsLocationsListCall)Header ¶

func (*AppsLocationsListCall)IfNoneMatch ¶

func (*AppsLocationsListCall)PageSize ¶

func (*AppsLocationsListCall)PageToken ¶

func (*AppsLocationsListCall)Pages ¶

typeAppsLocationsService ¶

funcNewAppsLocationsService ¶

func (*AppsLocationsService)Get ¶

func (*AppsLocationsService)List ¶

typeAppsModulesDeleteCall ¶

func (*AppsModulesDeleteCall)Context ¶

func (*AppsModulesDeleteCall)Do ¶

func (*AppsModulesDeleteCall)Fields ¶

func (*AppsModulesDeleteCall)Header ¶

typeAppsModulesGetCall ¶

func (*AppsModulesGetCall)Context ¶

func (*AppsModulesGetCall)Do ¶

func (*AppsModulesGetCall)Fields ¶

func (*AppsModulesGetCall)Header ¶

func (*AppsModulesGetCall)IfNoneMatch ¶

typeAppsModulesListCall ¶

func (*AppsModulesListCall)Context ¶

func (*AppsModulesListCall)Do ¶

func (*AppsModulesListCall)Fields ¶

func (*AppsModulesListCall)Header ¶

func (*AppsModulesListCall)IfNoneMatch ¶

func (*AppsModulesListCall)PageSize ¶

func (*AppsModulesListCall)PageToken ¶

func (*AppsModulesListCall)Pages ¶

typeAppsModulesPatchCall ¶

func (*AppsModulesPatchCall)Context ¶

func (*AppsModulesPatchCall)Do ¶

func (*AppsModulesPatchCall)Fields ¶

func (*AppsModulesPatchCall)Header ¶

func (*AppsModulesPatchCall)Mask ¶

func (*AppsModulesPatchCall)MigrateTraffic ¶

typeAppsModulesService ¶

funcNewAppsModulesService ¶

func (*AppsModulesService)Delete ¶

func (*AppsModulesService)Get ¶

func (*AppsModulesService)List ¶

func (*AppsModulesService)Patch ¶

typeAppsModulesVersionsCreateCall ¶

func (*AppsModulesVersionsCreateCall)Context ¶

func (*AppsModulesVersionsCreateCall)Do ¶

func (*AppsModulesVersionsCreateCall)Fields ¶

func (*AppsModulesVersionsCreateCall)Header ¶

typeAppsModulesVersionsDeleteCall ¶