Documentation ¶
Overview ¶
Package appengine provides access to the Google App Engine Admin API.
See https://cloud.google.com/appengine/docs/admin-api/
Usage example:
import "google.golang.org/api/appengine/v1" ... appengineService, err := appengine.New(oauthHttpClient)
Index ¶
- Constants
- type ApiConfigHandler
- type ApiEndpointHandler
- type Application
- type AppsGetCall
- type AppsOperationsGetCall
- func (c *AppsOperationsGetCall) Context(ctx context.Context) *AppsOperationsGetCall
- func (c *AppsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *AppsOperationsGetCall) Fields(s ...googleapi.Field) *AppsOperationsGetCall
- func (c *AppsOperationsGetCall) IfNoneMatch(entityTag string) *AppsOperationsGetCall
- type AppsOperationsListCall
- func (c *AppsOperationsListCall) Context(ctx context.Context) *AppsOperationsListCall
- func (c *AppsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
- func (c *AppsOperationsListCall) Fields(s ...googleapi.Field) *AppsOperationsListCall
- func (c *AppsOperationsListCall) Filter(filter string) *AppsOperationsListCall
- func (c *AppsOperationsListCall) IfNoneMatch(entityTag string) *AppsOperationsListCall
- func (c *AppsOperationsListCall) PageSize(pageSize int64) *AppsOperationsListCall
- func (c *AppsOperationsListCall) PageToken(pageToken string) *AppsOperationsListCall
- func (c *AppsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
- type AppsOperationsService
- type AppsRepairCall
- type AppsService
- type AppsServicesDeleteCall
- type AppsServicesGetCall
- func (c *AppsServicesGetCall) Context(ctx context.Context) *AppsServicesGetCall
- func (c *AppsServicesGetCall) Do(opts ...googleapi.CallOption) (*Module, error)
- func (c *AppsServicesGetCall) Fields(s ...googleapi.Field) *AppsServicesGetCall
- func (c *AppsServicesGetCall) IfNoneMatch(entityTag string) *AppsServicesGetCall
- type AppsServicesListCall
- func (c *AppsServicesListCall) Context(ctx context.Context) *AppsServicesListCall
- func (c *AppsServicesListCall) Do(opts ...googleapi.CallOption) (*ListServicesResponse, error)
- func (c *AppsServicesListCall) Fields(s ...googleapi.Field) *AppsServicesListCall
- func (c *AppsServicesListCall) IfNoneMatch(entityTag string) *AppsServicesListCall
- func (c *AppsServicesListCall) PageSize(pageSize int64) *AppsServicesListCall
- func (c *AppsServicesListCall) PageToken(pageToken string) *AppsServicesListCall
- func (c *AppsServicesListCall) Pages(ctx context.Context, f func(*ListServicesResponse) error) error
- type AppsServicesPatchCall
- func (c *AppsServicesPatchCall) Context(ctx context.Context) *AppsServicesPatchCall
- func (c *AppsServicesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *AppsServicesPatchCall) Fields(s ...googleapi.Field) *AppsServicesPatchCall
- func (c *AppsServicesPatchCall) MigrateTraffic(migrateTraffic bool) *AppsServicesPatchCall
- func (c *AppsServicesPatchCall) UpdateMask(updateMask string) *AppsServicesPatchCall
- type AppsServicesService
- func (r *AppsServicesService) Delete(appsId string, servicesId string) *AppsServicesDeleteCall
- func (r *AppsServicesService) Get(appsId string, servicesId string) *AppsServicesGetCall
- func (r *AppsServicesService) List(appsId string) *AppsServicesListCall
- func (r *AppsServicesService) Patch(appsId string, servicesId string, service *Service) *AppsServicesPatchCall
- type AppsServicesVersionsCreateCall
- type AppsServicesVersionsDeleteCall
- type AppsServicesVersionsGetCall
- func (c *AppsServicesVersionsGetCall) Context(ctx context.Context) *AppsServicesVersionsGetCall
- func (c *AppsServicesVersionsGetCall) Do(opts ...googleapi.CallOption) (*Version, error)
- func (c *AppsServicesVersionsGetCall) Fields(s ...googleapi.Field) *AppsServicesVersionsGetCall
- func (c *AppsServicesVersionsGetCall) IfNoneMatch(entityTag string) *AppsServicesVersionsGetCall
- func (c *AppsServicesVersionsGetCall) View(view string) *AppsServicesVersionsGetCall
- type AppsServicesVersionsInstancesListCall
- func (c *AppsServicesVersionsInstancesListCall) Context(ctx context.Context) *AppsServicesVersionsInstancesListCall
- func (c *AppsServicesVersionsInstancesListCall) Do(opts ...googleapi.CallOption) (*ListInstancesResponse, error)
- func (c *AppsServicesVersionsInstancesListCall) Fields(s ...googleapi.Field) *AppsServicesVersionsInstancesListCall
- func (c *AppsServicesVersionsInstancesListCall) IfNoneMatch(entityTag string) *AppsServicesVersionsInstancesListCall
- func (c *AppsServicesVersionsInstancesListCall) PageSize(pageSize int64) *AppsServicesVersionsInstancesListCall
- func (c *AppsServicesVersionsInstancesListCall) PageToken(pageToken string) *AppsServicesVersionsInstancesListCall
- func (c *AppsServicesVersionsInstancesListCall) Pages(ctx context.Context, f func(*ListInstancesResponse) error) error
- type AppsServicesVersionsInstancesService
- type AppsServicesVersionsListCall
- func (c *AppsServicesVersionsListCall) Context(ctx context.Context) *AppsServicesVersionsListCall
- func (c *AppsServicesVersionsListCall) Do(opts ...googleapi.CallOption) (*ListVersionsResponse, error)
- func (c *AppsServicesVersionsListCall) Fields(s ...googleapi.Field) *AppsServicesVersionsListCall
- func (c *AppsServicesVersionsListCall) IfNoneMatch(entityTag string) *AppsServicesVersionsListCall
- func (c *AppsServicesVersionsListCall) PageSize(pageSize int64) *AppsServicesVersionsListCall
- func (c *AppsServicesVersionsListCall) PageToken(pageToken string) *AppsServicesVersionsListCall
- func (c *AppsServicesVersionsListCall) Pages(ctx context.Context, f func(*ListVersionsResponse) error) error
- func (c *AppsServicesVersionsListCall) View(view string) *AppsServicesVersionsListCall
- type AppsServicesVersionsPatchCall
- func (c *AppsServicesVersionsPatchCall) Context(ctx context.Context) *AppsServicesVersionsPatchCall
- func (c *AppsServicesVersionsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *AppsServicesVersionsPatchCall) Fields(s ...googleapi.Field) *AppsServicesVersionsPatchCall
- func (c *AppsServicesVersionsPatchCall) UpdateMask(updateMask string) *AppsServicesVersionsPatchCall
- type AppsServicesVersionsService
- func (r *AppsServicesVersionsService) Create(appsId string, servicesId string, version *Version) *AppsServicesVersionsCreateCall
- func (r *AppsServicesVersionsService) Delete(appsId string, servicesId string, versionsId string) *AppsServicesVersionsDeleteCall
- func (r *AppsServicesVersionsService) Get(appsId string, servicesId string, versionsId string) *AppsServicesVersionsGetCall
- func (r *AppsServicesVersionsService) List(appsId string, servicesId string) *AppsServicesVersionsListCall
- func (r *AppsServicesVersionsService) Patch(appsId string, servicesId string, versionsId string, version *Version) *AppsServicesVersionsPatchCall
- type AutomaticScaling
- type BasicScaling
- type ContainerInfo
- type CpuUtilization
- type Deployment
- type DiskUtilization
- type ErrorHandler
- type FileInfo
- type HealthCheck
- type Instance
- type Library
- type ListInstancesResponse
- type ListOperationsResponse
- type ListServicesResponse
- type ListVersionsResponse
- type LocationMetadata
- type ManualScaling
- type Module
- type Network
- type NetworkUtilization
- type Operation
- type OperationMetadata
- type OperationMetadata1
- type OperationMetadataV1
- type OperationMetadataV1Beta5
- type OperationResponse
- type RepairApplicationRequest
- type RequestUtilization
- type Resources
- type ScriptHandler
- type Service
- type StaticFilesHandler
- type Status
- type StatusDetails
- type TrafficSplit
- type TrafficSplitAllocations
- type UrlDispatchRule
- type UrlMap
- type Version
Constants ¶
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiConfigHandler ¶
type ApiConfigHandler struct { // AuthFailAction: For users not logged in, how to handle access to // resources with required login. Defaults to "redirect". // // Possible values: // "AUTH_FAIL_ACTION_UNSPECIFIED" // "AUTH_FAIL_ACTION_REDIRECT" // "AUTH_FAIL_ACTION_UNAUTHORIZED" AuthFailAction string `json:"authFailAction,omitempty"` // Login: What level of login is required to access this resource. // Default is "optional". // // Possible values: // "LOGIN_UNSPECIFIED" // "LOGIN_OPTIONAL" // "LOGIN_ADMIN" // "LOGIN_REQUIRED" Login string `json:"login,omitempty"` // Script: Specifies the path to the script from the application root // directory. Script string `json:"script,omitempty"` // SecurityLevel: Configures whether security (HTTPS) should be enforced // for this URL. // // Possible values: // "SECURE_UNSPECIFIED" // "SECURE_DEFAULT" // "SECURE_NEVER" // "SECURE_OPTIONAL" // "SECURE_ALWAYS" SecurityLevel string `json:"securityLevel,omitempty"` // Url: URL to serve the endpoint at. Url string `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:"-"` }
ApiConfigHandler: Google Cloud Endpoints configuration for API handlers. Used to tune behavior of optional Cloud Endpoints integration.
func (*ApiConfigHandler) MarshalJSON ¶
func (s *ApiConfigHandler) MarshalJSON() ([]byte, error)
type ApiEndpointHandler ¶
type ApiEndpointHandler struct { // ScriptPath: Specifies the path to the script from the application // root directory. ScriptPath string `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:"-"` }
ApiEndpointHandler: Use Google Cloud Endpoints to handle requests.
func (*ApiEndpointHandler) MarshalJSON ¶
func (s *ApiEndpointHandler) MarshalJSON() ([]byte, error)
type Application ¶
type Application struct { // AuthDomain: If set, only users from the specified Google Apps // authentication domain may access the application. If not set, any // Google Account may access the application. AuthDomain string `json:"authDomain,omitempty"` // CodeBucket: A Google Cloud Storage bucket which can be used for // storing files associated with an application. This bucket is // associated with the application and can be used by the gcloud // deployment commands. @OutputOnly CodeBucket string `json:"codeBucket,omitempty"` // DefaultBucket: A Google Cloud Storage bucket which can be used by the // application to store content. @OutputOnly DefaultBucket string `json:"defaultBucket,omitempty"` // DefaultCookieExpiration: Determines the cookie expiration policy for // the application. @OutputOnly DefaultCookieExpiration string `json:"defaultCookieExpiration,omitempty"` // DefaultHostname: The hostname used to reach the application, as // resolved by App Engine. @OutputOnly DefaultHostname string `json:"defaultHostname,omitempty"` // DispatchRules: HTTP path dispatch rules for requests to the app that // do not explicitly target a service or version. The rules are // order-dependent. @OutputOnly DispatchRules []*UrlDispatchRule `json:"dispatchRules,omitempty"` // Id: The relative name of the application. Example: "myapp". Id string `json:"id,omitempty"` // LocationId: The location from which the application will be run. // Application instances will run out of data centers in the chosen // location and all of the application's End User Content will be stored // at rest. The default is "us-central". Choices are: "us-central" - // Central US "europe-west" - Western Europe "us-east1" - Eastern US LocationId string `json:"locationId,omitempty"` // Name: The full path to the application in the API. Example: // "apps/myapp". @OutputOnly Name string `json:"name,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "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:"-"` }
Application: An Application contains the top-level configuration of an App Engine application.
func (*Application) MarshalJSON ¶
func (s *Application) MarshalJSON() ([]byte, error)
type AppsGetCall ¶
type AppsGetCall struct {
// contains filtered or unexported fields
}
func (*AppsGetCall) Context ¶
func (c *AppsGetCall) Context(ctx context.Context) *AppsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*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-2xx status code is an error. Response headers are in either *Application.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsGetCall) Fields ¶
func (c *AppsGetCall) Fields(s ...googleapi.Field) *AppsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AppsGetCall) IfNoneMatch ¶
func (c *AppsGetCall) IfNoneMatch(entityTag string) *AppsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type AppsOperationsGetCall ¶
type AppsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*AppsOperationsGetCall) Context ¶
func (c *AppsOperationsGetCall) Context(ctx context.Context) *AppsOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*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-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsOperationsGetCall) Fields ¶
func (c *AppsOperationsGetCall) Fields(s ...googleapi.Field) *AppsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AppsOperationsGetCall) IfNoneMatch ¶
func (c *AppsOperationsGetCall) IfNoneMatch(entityTag string) *AppsOperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type AppsOperationsListCall ¶
type AppsOperationsListCall struct {
// contains filtered or unexported fields
}
func (*AppsOperationsListCall) Context ¶
func (c *AppsOperationsListCall) Context(ctx context.Context) *AppsOperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*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. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsOperationsListCall) Fields ¶
func (c *AppsOperationsListCall) Fields(s ...googleapi.Field) *AppsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AppsOperationsListCall) Filter ¶
func (c *AppsOperationsListCall) Filter(filter string) *AppsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*AppsOperationsListCall) IfNoneMatch ¶
func (c *AppsOperationsListCall) IfNoneMatch(entityTag string) *AppsOperationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*AppsOperationsListCall) PageSize ¶
func (c *AppsOperationsListCall) PageSize(pageSize int64) *AppsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*AppsOperationsListCall) PageToken ¶
func (c *AppsOperationsListCall) PageToken(pageToken string) *AppsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*AppsOperationsListCall) Pages ¶
func (c *AppsOperationsListCall) Pages(ctx context.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.
type AppsOperationsService ¶
type AppsOperationsService struct {
// contains filtered or unexported fields
}
func NewAppsOperationsService ¶
func NewAppsOperationsService(s *Service) *AppsOperationsService
func (*AppsOperationsService) Get ¶
func (r *AppsOperationsService) Get(appsId string, operationsId string) *AppsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
func (*AppsOperationsService) List ¶
func (r *AppsOperationsService) List(appsId string) *AppsOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.
type AppsRepairCall ¶
type AppsRepairCall struct {
// contains filtered or unexported fields
}
func (*AppsRepairCall) Context ¶
func (c *AppsRepairCall) Context(ctx context.Context) *AppsRepairCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsRepairCall) Do ¶
func (c *AppsRepairCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "appengine.apps.repair" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsRepairCall) Fields ¶
func (c *AppsRepairCall) Fields(s ...googleapi.Field) *AppsRepairCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type AppsService ¶
type AppsService struct { Operations *AppsOperationsService Services *AppsServicesService // contains filtered or unexported fields }
func NewAppsService ¶
func NewAppsService(s *Service) *AppsService
func (*AppsService) Get ¶
func (r *AppsService) Get(appsId string) *AppsGetCall
Get: Gets information about an application.
func (*AppsService) Repair ¶
func (r *AppsService) Repair(appsId string, repairapplicationrequest *RepairApplicationRequest) *AppsRepairCall
Repair: Ensures that all special features required for App Engine, such as the appspot bucket and appengine robot, exist for this project.
type AppsServicesDeleteCall ¶
type AppsServicesDeleteCall struct {
// contains filtered or unexported fields
}
func (*AppsServicesDeleteCall) Context ¶
func (c *AppsServicesDeleteCall) Context(ctx context.Context) *AppsServicesDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsServicesDeleteCall) Do ¶
func (c *AppsServicesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "appengine.apps.services.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsServicesDeleteCall) Fields ¶
func (c *AppsServicesDeleteCall) Fields(s ...googleapi.Field) *AppsServicesDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type AppsServicesGetCall ¶
type AppsServicesGetCall struct {
// contains filtered or unexported fields
}
func (*AppsServicesGetCall) Context ¶
func (c *AppsServicesGetCall) Context(ctx context.Context) *AppsServicesGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsServicesGetCall) Do ¶
func (c *AppsServicesGetCall) Do(opts ...googleapi.CallOption) (*Module, error)
Do executes the "appengine.apps.services.get" call. Exactly one of *Module or error will be non-nil. Any non-2xx status code 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 to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsServicesGetCall) Fields ¶
func (c *AppsServicesGetCall) Fields(s ...googleapi.Field) *AppsServicesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AppsServicesGetCall) IfNoneMatch ¶
func (c *AppsServicesGetCall) IfNoneMatch(entityTag string) *AppsServicesGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type AppsServicesListCall ¶
type AppsServicesListCall struct {
// contains filtered or unexported fields
}
func (*AppsServicesListCall) Context ¶
func (c *AppsServicesListCall) Context(ctx context.Context) *AppsServicesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsServicesListCall) Do ¶
func (c *AppsServicesListCall) Do(opts ...googleapi.CallOption) (*ListServicesResponse, error)
Do executes the "appengine.apps.services.list" call. Exactly one of *ListServicesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListServicesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsServicesListCall) Fields ¶
func (c *AppsServicesListCall) Fields(s ...googleapi.Field) *AppsServicesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AppsServicesListCall) IfNoneMatch ¶
func (c *AppsServicesListCall) IfNoneMatch(entityTag string) *AppsServicesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*AppsServicesListCall) PageSize ¶
func (c *AppsServicesListCall) PageSize(pageSize int64) *AppsServicesListCall
PageSize sets the optional parameter "pageSize": Maximum results to return per page.
func (*AppsServicesListCall) PageToken ¶
func (c *AppsServicesListCall) PageToken(pageToken string) *AppsServicesListCall
PageToken sets the optional parameter "pageToken": Continuation token for fetching the next page of results.
func (*AppsServicesListCall) Pages ¶
func (c *AppsServicesListCall) Pages(ctx context.Context, f func(*ListServicesResponse) 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.
type AppsServicesPatchCall ¶
type AppsServicesPatchCall struct {
// contains filtered or unexported fields
}
func (*AppsServicesPatchCall) Context ¶
func (c *AppsServicesPatchCall) Context(ctx context.Context) *AppsServicesPatchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsServicesPatchCall) Do ¶
func (c *AppsServicesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "appengine.apps.services.patch" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsServicesPatchCall) Fields ¶
func (c *AppsServicesPatchCall) Fields(s ...googleapi.Field) *AppsServicesPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AppsServicesPatchCall) MigrateTraffic ¶
func (c *AppsServicesPatchCall) MigrateTraffic(migrateTraffic bool) *AppsServicesPatchCall
MigrateTraffic sets the optional parameter "migrateTraffic": Whether to use traffic migration to shift traffic gradually. Traffic can only be migrated from a single version to another single version. More information is available in the documentation for traffic migration: https://cloud.google.com/appengine/docs/python/migrating-traffic
func (*AppsServicesPatchCall) UpdateMask ¶
func (c *AppsServicesPatchCall) UpdateMask(updateMask string) *AppsServicesPatchCall
UpdateMask sets the optional parameter "updateMask": Standard field mask for the set of fields to be updated.
type AppsServicesService ¶
type AppsServicesService struct { Versions *AppsServicesVersionsService // contains filtered or unexported fields }
func NewAppsServicesService ¶
func NewAppsServicesService(s *Service) *AppsServicesService
func (*AppsServicesService) Delete ¶
func (r *AppsServicesService) Delete(appsId string, servicesId string) *AppsServicesDeleteCall
Delete: Deletes the specified service and all enclosed versions.
func (*AppsServicesService) Get ¶
func (r *AppsServicesService) Get(appsId string, servicesId string) *AppsServicesGetCall
Get: Gets the current configuration of the specified service.
func (*AppsServicesService) List ¶
func (r *AppsServicesService) List(appsId string) *AppsServicesListCall
List: Lists all the services in the application.
func (*AppsServicesService) Patch ¶
func (r *AppsServicesService) Patch(appsId string, servicesId string, service *Service) *AppsServicesPatchCall
Patch: Updates the configuration of the specified service.
type AppsServicesVersionsCreateCall ¶
type AppsServicesVersionsCreateCall struct {
// contains filtered or unexported fields
}
func (*AppsServicesVersionsCreateCall) Context ¶
func (c *AppsServicesVersionsCreateCall) Context(ctx context.Context) *AppsServicesVersionsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsServicesVersionsCreateCall) Do ¶
func (c *AppsServicesVersionsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "appengine.apps.services.versions.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsServicesVersionsCreateCall) Fields ¶
func (c *AppsServicesVersionsCreateCall) Fields(s ...googleapi.Field) *AppsServicesVersionsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type AppsServicesVersionsDeleteCall ¶
type AppsServicesVersionsDeleteCall struct {
// contains filtered or unexported fields
}
func (*AppsServicesVersionsDeleteCall) Context ¶
func (c *AppsServicesVersionsDeleteCall) Context(ctx context.Context) *AppsServicesVersionsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsServicesVersionsDeleteCall) Do ¶
func (c *AppsServicesVersionsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "appengine.apps.services.versions.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsServicesVersionsDeleteCall) Fields ¶
func (c *AppsServicesVersionsDeleteCall) Fields(s ...googleapi.Field) *AppsServicesVersionsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type AppsServicesVersionsGetCall ¶
type AppsServicesVersionsGetCall struct {
// contains filtered or unexported fields
}
func (*AppsServicesVersionsGetCall) Context ¶
func (c *AppsServicesVersionsGetCall) Context(ctx context.Context) *AppsServicesVersionsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsServicesVersionsGetCall) Do ¶
func (c *AppsServicesVersionsGetCall) Do(opts ...googleapi.CallOption) (*Version, error)
Do executes the "appengine.apps.services.versions.get" call. Exactly one of *Version or error will be non-nil. Any non-2xx status code 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 to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsServicesVersionsGetCall) Fields ¶
func (c *AppsServicesVersionsGetCall) Fields(s ...googleapi.Field) *AppsServicesVersionsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AppsServicesVersionsGetCall) IfNoneMatch ¶
func (c *AppsServicesVersionsGetCall) IfNoneMatch(entityTag string) *AppsServicesVersionsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*AppsServicesVersionsGetCall) View ¶
func (c *AppsServicesVersionsGetCall) View(view string) *AppsServicesVersionsGetCall
View sets the optional parameter "view": Controls the set of fields returned in the `Get` response.
Possible values:
"BASIC" "FULL"
type AppsServicesVersionsInstancesListCall ¶
type AppsServicesVersionsInstancesListCall struct {
// contains filtered or unexported fields
}
func (*AppsServicesVersionsInstancesListCall) Context ¶
func (c *AppsServicesVersionsInstancesListCall) Context(ctx context.Context) *AppsServicesVersionsInstancesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsServicesVersionsInstancesListCall) Do ¶
func (c *AppsServicesVersionsInstancesListCall) Do(opts ...googleapi.CallOption) (*ListInstancesResponse, error)
Do executes the "appengine.apps.services.versions.instances.list" call. Exactly one of *ListInstancesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListInstancesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsServicesVersionsInstancesListCall) Fields ¶
func (c *AppsServicesVersionsInstancesListCall) Fields(s ...googleapi.Field) *AppsServicesVersionsInstancesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AppsServicesVersionsInstancesListCall) IfNoneMatch ¶
func (c *AppsServicesVersionsInstancesListCall) IfNoneMatch(entityTag string) *AppsServicesVersionsInstancesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*AppsServicesVersionsInstancesListCall) PageSize ¶
func (c *AppsServicesVersionsInstancesListCall) PageSize(pageSize int64) *AppsServicesVersionsInstancesListCall
PageSize sets the optional parameter "pageSize": Maximum results to return per page.
func (*AppsServicesVersionsInstancesListCall) PageToken ¶
func (c *AppsServicesVersionsInstancesListCall) PageToken(pageToken string) *AppsServicesVersionsInstancesListCall
PageToken sets the optional parameter "pageToken": Continuation token for fetching the next page of results.
func (*AppsServicesVersionsInstancesListCall) Pages ¶
func (c *AppsServicesVersionsInstancesListCall) Pages(ctx context.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.
type AppsServicesVersionsInstancesService ¶
type AppsServicesVersionsInstancesService struct {
// contains filtered or unexported fields
}
func NewAppsServicesVersionsInstancesService ¶
func NewAppsServicesVersionsInstancesService(s *Service) *AppsServicesVersionsInstancesService
func (*AppsServicesVersionsInstancesService) List ¶
func (r *AppsServicesVersionsInstancesService) List(appsId string, servicesId string, versionsId string) *AppsServicesVersionsInstancesListCall
List: Lists the instances of a version.
type AppsServicesVersionsListCall ¶
type AppsServicesVersionsListCall struct {
// contains filtered or unexported fields
}
func (*AppsServicesVersionsListCall) Context ¶
func (c *AppsServicesVersionsListCall) Context(ctx context.Context) *AppsServicesVersionsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsServicesVersionsListCall) Do ¶
func (c *AppsServicesVersionsListCall) Do(opts ...googleapi.CallOption) (*ListVersionsResponse, error)
Do executes the "appengine.apps.services.versions.list" call. Exactly one of *ListVersionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListVersionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsServicesVersionsListCall) Fields ¶
func (c *AppsServicesVersionsListCall) Fields(s ...googleapi.Field) *AppsServicesVersionsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AppsServicesVersionsListCall) IfNoneMatch ¶
func (c *AppsServicesVersionsListCall) IfNoneMatch(entityTag string) *AppsServicesVersionsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*AppsServicesVersionsListCall) PageSize ¶
func (c *AppsServicesVersionsListCall) PageSize(pageSize int64) *AppsServicesVersionsListCall
PageSize sets the optional parameter "pageSize": Maximum results to return per page.
func (*AppsServicesVersionsListCall) PageToken ¶
func (c *AppsServicesVersionsListCall) PageToken(pageToken string) *AppsServicesVersionsListCall
PageToken sets the optional parameter "pageToken": Continuation token for fetching the next page of results.
func (*AppsServicesVersionsListCall) Pages ¶
func (c *AppsServicesVersionsListCall) Pages(ctx context.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 (*AppsServicesVersionsListCall) View ¶
func (c *AppsServicesVersionsListCall) View(view string) *AppsServicesVersionsListCall
View sets the optional parameter "view": Controls the set of fields returned in the `List` response.
Possible values:
"BASIC" "FULL"
type AppsServicesVersionsPatchCall ¶
type AppsServicesVersionsPatchCall struct {
// contains filtered or unexported fields
}
func (*AppsServicesVersionsPatchCall) Context ¶
func (c *AppsServicesVersionsPatchCall) Context(ctx context.Context) *AppsServicesVersionsPatchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AppsServicesVersionsPatchCall) Do ¶
func (c *AppsServicesVersionsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "appengine.apps.services.versions.patch" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AppsServicesVersionsPatchCall) Fields ¶
func (c *AppsServicesVersionsPatchCall) Fields(s ...googleapi.Field) *AppsServicesVersionsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AppsServicesVersionsPatchCall) UpdateMask ¶
func (c *AppsServicesVersionsPatchCall) UpdateMask(updateMask string) *AppsServicesVersionsPatchCall
UpdateMask sets the optional parameter "updateMask": Standard field mask for the set of fields to be updated.
type AppsServicesVersionsService ¶
type AppsServicesVersionsService struct { Instances *AppsServicesVersionsInstancesService // contains filtered or unexported fields }
func NewAppsServicesVersionsService ¶
func NewAppsServicesVersionsService(s *Service) *AppsServicesVersionsService
func (*AppsServicesVersionsService) Create ¶
func (r *AppsServicesVersionsService) Create(appsId string, servicesId string, version *Version) *AppsServicesVersionsCreateCall
Create: Deploys code and resource files to a new version.
func (*AppsServicesVersionsService) Delete ¶
func (r *AppsServicesVersionsService) Delete(appsId string, servicesId string, versionsId string) *AppsServicesVersionsDeleteCall
Delete: Deletes an existing Version resource.
func (*AppsServicesVersionsService) Get ¶
func (r *AppsServicesVersionsService) Get(appsId string, servicesId string, versionsId string) *AppsServicesVersionsGetCall
Get: Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Please specify the FULL_VIEW parameter to get the full resource.
func (*AppsServicesVersionsService) List ¶
func (r *AppsServicesVersionsService) List(appsId string, servicesId string) *AppsServicesVersionsListCall
List: Lists the versions of a service.
func (*AppsServicesVersionsService) Patch ¶
func (r *AppsServicesVersionsService) Patch(appsId string, servicesId string, versionsId string, version *Version) *AppsServicesVersionsPatchCall
Patch: Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](/appengine/docs/admin-api/reference/rest/v1/apps.se rvices.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](/appengine/docs/admin-api/reference/rest/v1/apps.se rvices.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](/appengine/docs/admin-api/ref erence/rest/v1/apps.services.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`](/appengine/docs/admin-api/ref erence/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling ): For Version resources that use automatic scaling and run in the App Engine standard environment.
type AutomaticScaling ¶
type AutomaticScaling struct { // CoolDownPeriod: The amount of time that the // [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) // should wait between changes to the number of virtual machines. // Applies only to the VM runtime. CoolDownPeriod string `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: The number of concurrent requests an automatic // scaling instance can accept before the scheduler spawns a new // instance. Default value is chosen based on the runtime. MaxConcurrentRequests int64 `json:"maxConcurrentRequests,omitempty"` // MaxIdleInstances: The maximum number of idle instances that App // Engine should maintain for this version. MaxIdleInstances int64 `json:"maxIdleInstances,omitempty"` // MaxPendingLatency: The maximum amount of time that App Engine should // allow a request to wait in the pending queue before starting a new // instance to handle it. MaxPendingLatency string `json:"maxPendingLatency,omitempty"` // MaxTotalInstances: Max number of instances that App Engine should // start to handle requests. MaxTotalInstances int64 `json:"maxTotalInstances,omitempty"` // MinIdleInstances: The minimum number of idle instances that App // Engine should maintain for this version. Only applies to the default // version of a service, since other versions are not expected to // receive significant traffic. MinIdleInstances int64 `json:"minIdleInstances,omitempty"` // MinPendingLatency: The minimum amount of time that App Engine should // allow a request to wait in the pending queue before starting a new // instance to handle it. MinPendingLatency string `json:"minPendingLatency,omitempty"` // MinTotalInstances: Minimum number of instances that App Engine should // maintain. MinTotalInstances int64 `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:"-"` }
AutomaticScaling: Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
func (*AutomaticScaling) MarshalJSON ¶
func (s *AutomaticScaling) MarshalJSON() ([]byte, error)
type BasicScaling ¶
type BasicScaling struct { // IdleTimeout: The instance will be shut down this amount of time after // receiving its last request. IdleTimeout string `json:"idleTimeout,omitempty"` // MaxInstances: The maximum number of instances for App Engine to // create for this version. MaxInstances int64 `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:"-"` }
BasicScaling: A service 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.
func (*BasicScaling) MarshalJSON ¶
func (s *BasicScaling) MarshalJSON() ([]byte, error)
type ContainerInfo ¶
type ContainerInfo struct { // Image: Reference to a hosted container image. Must be a URI to a // resource in a Docker repository. Must be fully qualified, including // tag or digest. e.g. gcr.io/my-project/image:tag or // gcr.io/my-project/image@digest Image string `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:"-"` }
ContainerInfo: A Docker (container) image which should be used to start the application.
func (*ContainerInfo) MarshalJSON ¶
func (s *ContainerInfo) MarshalJSON() ([]byte, error)
type CpuUtilization ¶
type CpuUtilization struct { // AggregationWindowLength: The period of time over which CPU // utilization is calculated. AggregationWindowLength string `json:"aggregationWindowLength,omitempty"` // TargetUtilization: Target (0-1) CPU utilization ratio to maintain // when scaling. TargetUtilization float64 `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:"-"` }
CpuUtilization: Target scaling by CPU usage.
func (*CpuUtilization) MarshalJSON ¶
func (s *CpuUtilization) MarshalJSON() ([]byte, error)
type Deployment ¶
type Deployment struct { // Container: If supplied, a docker (container) image which should be // used to start the application. Only applicable to the 'vm' runtime. Container *ContainerInfo `json:"container,omitempty"` // Files: A manifest of files stored in Google Cloud Storage which // should be included as part of this application. All files must be // readable using the credentials supplied with this call. Files map[string]FileInfo `json:"files,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:"-"` }
Deployment: Code and application artifacts used to deploy a version to App Engine.
func (*Deployment) MarshalJSON ¶
func (s *Deployment) MarshalJSON() ([]byte, error)
type DiskUtilization ¶
type DiskUtilization struct { // TargetReadBytesPerSecond: Target bytes per second read. TargetReadBytesPerSecond int64 `json:"targetReadBytesPerSecond,omitempty"` // TargetReadOpsPerSecond: Target ops per second read. TargetReadOpsPerSecond int64 `json:"targetReadOpsPerSecond,omitempty"` // TargetWriteBytesPerSecond: Target bytes per second written. TargetWriteBytesPerSecond int64 `json:"targetWriteBytesPerSecond,omitempty"` // TargetWriteOpsPerSecond: Target ops per second written. TargetWriteOpsPerSecond int64 `json:"targetWriteOpsPerSecond,omitempty"` // ForceSendFields is a list of field names (e.g. // "TargetReadBytesPerSecond") 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:"-"` }
DiskUtilization: Target scaling by disk usage (for VM runtimes only).
func (*DiskUtilization) MarshalJSON ¶
func (s *DiskUtilization) MarshalJSON() ([]byte, error)
type ErrorHandler ¶
type ErrorHandler struct { // ErrorCode: The error condition this handler applies to. // // Possible values: // "ERROR_CODE_UNSPECIFIED" // "ERROR_CODE_DEFAULT" // "ERROR_CODE_OVER_QUOTA" // "ERROR_CODE_DOS_API_DENIAL" // "ERROR_CODE_TIMEOUT" ErrorCode string `json:"errorCode,omitempty"` // MimeType: MIME type of file. If unspecified, "text/html" is assumed. MimeType string `json:"mimeType,omitempty"` // StaticFile: Static file content to be served for this error. StaticFile string `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:"-"` }
ErrorHandler: A custom static error page to be served when an error occurs.
func (*ErrorHandler) MarshalJSON ¶
func (s *ErrorHandler) MarshalJSON() ([]byte, error)
type FileInfo ¶
type FileInfo struct { // MimeType: The MIME type of the file; if unspecified, the value from // Google Cloud Storage will be used. MimeType string `json:"mimeType,omitempty"` // Sha1Sum: The SHA1 (160 bits) hash of the file in hex. Sha1Sum string `json:"sha1Sum,omitempty"` // SourceUrl: The 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/\/\'. SourceUrl string `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:"-"` }
FileInfo: A single source file which is part of the application to be deployed.
func (*FileInfo) MarshalJSON ¶
type HealthCheck ¶
type HealthCheck struct { // CheckInterval: The interval between health checks. CheckInterval string `json:"checkInterval,omitempty"` // DisableHealthCheck: Whether to explicitly disable health checks for // this instance. DisableHealthCheck bool `json:"disableHealthCheck,omitempty"` // HealthyThreshold: The number of consecutive successful health checks // before receiving traffic. HealthyThreshold int64 `json:"healthyThreshold,omitempty"` // Host: The host header to send when performing an HTTP health check // (e.g. myapp.appspot.com) Host string `json:"host,omitempty"` // RestartThreshold: The number of consecutive failed health checks // before an instance is restarted. RestartThreshold int64 `json:"restartThreshold,omitempty"` // Timeout: The amount of time before the health check is considered // failed. Timeout string `json:"timeout,omitempty"` // UnhealthyThreshold: The number of consecutive failed health checks // before removing traffic. UnhealthyThreshold int64 `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:"-"` }
HealthCheck: Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances.
func (*HealthCheck) MarshalJSON ¶
func (s *HealthCheck) MarshalJSON() ([]byte, error)
type Instance ¶
type Instance struct { // AppEngineRelease: The App Engine release the instance is running on. // @OutputOnly AppEngineRelease string `json:"appEngineRelease,omitempty"` // Availability: Availability of instance. @OutputOnly // // Possible values: // "UNSPECIFIED" // "RESIDENT" // "DYNAMIC" Availability string `json:"availability,omitempty"` // AverageLatency: Latency in milliseconds (averaged over the last // minute). @OutputOnly AverageLatency int64 `json:"averageLatency,omitempty"` // Errors: Number of errors since the instance was started. @OutputOnly Errors int64 `json:"errors,omitempty"` // Id: The relative name of the instance within the version. Example: // "instance-1" @OutputOnly Id string `json:"id,omitempty"` // MemoryUsage: Memory usage (in bytes). @OutputOnly MemoryUsage int64 `json:"memoryUsage,omitempty,string"` // Name: The resource name of an Instance. Example: // "apps/myapp/services/default/versions/v1/instances/instance-1" // @OutputOnly Name string `json:"name,omitempty"` // Qps: QPS for this instance (averaged over the last minute). // @OutputOnly Qps float64 `json:"qps,omitempty"` // Requests: Number of requests (since the clone was started). // @OutputOnly Requests int64 `json:"requests,omitempty"` // StartTime: Time when instance was started. @OutputOnly StartTime string `json:"startTime,omitempty"` // VmId: For VMEngines instances, the Compute Engine VM ID of the // instance. @OutputOnly VmId string `json:"vmId,omitempty"` // VmName: For VMEngines instances, the name of the Compute Engine VM // where the instance lives. @OutputOnly VmName string `json:"vmName,omitempty"` // VmStatus: For VMEngines instances, the status of the Compute Engine // VM where the instance lives. @OutputOnly VmStatus string `json:"vmStatus,omitempty"` // VmUnlocked: For VMEngines instances, whether the instance has been // unlocked. @OutputOnly VmUnlocked bool `json:"vmUnlocked,omitempty"` // VmZoneName: For VMEngines instances, the zone where the Compute // Engine VM is located. @OutputOnly VmZoneName string `json:"vmZoneName,omitempty"` // 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:"-"` }
Instance: Instances are the computing units that App Engine uses to automatically scale an application.
func (*Instance) MarshalJSON ¶
type Library ¶
type Library struct { // Name: The name of the library, e.g. "PIL" or "django". Name string `json:"name,omitempty"` // Version: The version of the library to select, or "latest". Version string `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:"-"` }
Library: A Python runtime third-party library required by the application.
func (*Library) MarshalJSON ¶
type ListInstancesResponse ¶
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. NextPageToken string `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:"-"` }
ListInstancesResponse: Response message for `Instances.ListInstances`.
func (*ListInstancesResponse) MarshalJSON ¶
func (s *ListInstancesResponse) MarshalJSON() ([]byte, error)
type ListOperationsResponse ¶
type ListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `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:"-"` }
ListOperationsResponse: The response message for Operations.ListOperations.
func (*ListOperationsResponse) MarshalJSON ¶
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
type ListServicesResponse ¶
type ListServicesResponse struct { // NextPageToken: Continuation token for fetching the next page of // results. NextPageToken string `json:"nextPageToken,omitempty"` // Services: The services belonging to the requested application. Services []*Module `json:"services,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:"-"` }
ListServicesResponse: Response message for `Services.ListServices`.
func (*ListServicesResponse) MarshalJSON ¶
func (s *ListServicesResponse) MarshalJSON() ([]byte, error)
type ListVersionsResponse ¶
type ListVersionsResponse struct { // NextPageToken: Continuation token for fetching the next page of // results. NextPageToken string `json:"nextPageToken,omitempty"` // Versions: The versions belonging to the requested application // service. 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:"-"` }
ListVersionsResponse: Response message for `Versions.ListVersions`.
func (*ListVersionsResponse) MarshalJSON ¶
func (s *ListVersionsResponse) MarshalJSON() ([]byte, error)
type LocationMetadata ¶
type LocationMetadata struct { }
LocationMetadata: Metadata for the given google.cloud.location.Location.
type ManualScaling ¶
type ManualScaling struct { // Instances: The number of instances to assign to the service 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. Instances int64 `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:"-"` }
ManualScaling: A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
func (*ManualScaling) MarshalJSON ¶
func (s *ManualScaling) MarshalJSON() ([]byte, error)
type Module ¶
type Module struct { // Id: The relative name of the service within the application. Example: // "default" @OutputOnly Id string `json:"id,omitempty"` // Name: The full path to the Service resource in the API. Example: // "apps/myapp/services/default" @OutputOnly Name string `json:"name,omitempty"` // Split: A mapping that defines fractional HTTP traffic diversion to // different versions within the service. 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:"-"` }
Module: A service is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
func (*Module) MarshalJSON ¶
type Network ¶
type Network struct { // ForwardedPorts: A list of ports (or port pairs) to forward from the // VM into the app container. ForwardedPorts []string `json:"forwardedPorts,omitempty"` // InstanceTag: A tag to apply to the VM instance during creation. InstanceTag string `json:"instanceTag,omitempty"` // Name: The Google Compute Engine network where the VMs will be // created. If not specified, or empty, the network named "default" will // be used. (The short name should be specified, not the resource path.) Name string `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:"-"` }
Network: Used to specify extra network settings (for VM runtimes only).
func (*Network) MarshalJSON ¶
type NetworkUtilization ¶
type NetworkUtilization struct { // TargetReceivedBytesPerSecond: Target bytes per second received. TargetReceivedBytesPerSecond int64 `json:"targetReceivedBytesPerSecond,omitempty"` // TargetReceivedPacketsPerSecond: Target packets per second received. TargetReceivedPacketsPerSecond int64 `json:"targetReceivedPacketsPerSecond,omitempty"` // TargetSentBytesPerSecond: Target bytes per second sent. TargetSentBytesPerSecond int64 `json:"targetSentBytesPerSecond,omitempty"` // TargetSentPacketsPerSecond: Target packets per second sent. TargetSentPacketsPerSecond int64 `json:"targetSentPacketsPerSecond,omitempty"` // ForceSendFields is a list of field names (e.g. // "TargetReceivedBytesPerSecond") 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:"-"` }
NetworkUtilization: Target scaling by network usage (for VM runtimes only).
func (*NetworkUtilization) MarshalJSON ¶
func (s *NetworkUtilization) MarshalJSON() ([]byte, error)
type Operation ¶
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. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure. 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. Metadata OperationMetadata `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`. Name string `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`. Response OperationResponse `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:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶
type OperationMetadata ¶
type OperationMetadata interface{}
type OperationMetadata1 ¶
type OperationMetadata1 struct { // EndTime: Timestamp that this operation was completed. (Not present if // the operation is still in progress.) @OutputOnly EndTime string `json:"endTime,omitempty"` // InsertTime: Timestamp that this operation was received. @OutputOnly InsertTime string `json:"insertTime,omitempty"` // Method: API method name that initiated the operation. Example: // "google.appengine.v1beta4.Version.CreateVersion". @OutputOnly Method string `json:"method,omitempty"` // OperationType: The type of the operation (deprecated, use method // field instead). Example: "create_version". @OutputOnly OperationType string `json:"operationType,omitempty"` // Target: Resource that this operation is acting on. Example: // "apps/myapp/modules/default". @OutputOnly Target string `json:"target,omitempty"` // User: The user who requested this operation. @OutputOnly User string `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:"-"` }
OperationMetadata1: Metadata for the given google.longrunning.Operation.
func (*OperationMetadata1) MarshalJSON ¶
func (s *OperationMetadata1) MarshalJSON() ([]byte, error)
type OperationMetadataV1 ¶
type OperationMetadataV1 struct { // EndTime: Timestamp that this operation was completed. (Not present if // the operation is still in progress.) @OutputOnly EndTime string `json:"endTime,omitempty"` // InsertTime: Timestamp that this operation was received. @OutputOnly InsertTime string `json:"insertTime,omitempty"` // Method: API method name that initiated the operation. Example: // "google.appengine.v1.Version.CreateVersion". @OutputOnly Method string `json:"method,omitempty"` // Target: Resource that this operation is acting on. Example: // "apps/myapp/services/default". @OutputOnly Target string `json:"target,omitempty"` // User: The user who requested this operation. @OutputOnly User string `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:"-"` }
OperationMetadataV1: Metadata for the given google.longrunning.Operation.
func (*OperationMetadataV1) MarshalJSON ¶
func (s *OperationMetadataV1) MarshalJSON() ([]byte, error)
type OperationMetadataV1Beta5 ¶
type OperationMetadataV1Beta5 struct { // EndTime: Timestamp that this operation was completed. (Not present if // the operation is still in progress.) @OutputOnly EndTime string `json:"endTime,omitempty"` // InsertTime: Timestamp that this operation was received. @OutputOnly InsertTime string `json:"insertTime,omitempty"` // Method: API method name that initiated the operation. Example: // "google.appengine.v1beta5.Version.CreateVersion". @OutputOnly Method string `json:"method,omitempty"` // Target: Resource that this operation is acting on. Example: // "apps/myapp/services/default". @OutputOnly Target string `json:"target,omitempty"` // User: The user who requested this operation. @OutputOnly User string `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:"-"` }
OperationMetadataV1Beta5: Metadata for the given google.longrunning.Operation.
func (*OperationMetadataV1Beta5) MarshalJSON ¶
func (s *OperationMetadataV1Beta5) MarshalJSON() ([]byte, error)
type OperationResponse ¶
type OperationResponse interface{}
type RepairApplicationRequest ¶
type RepairApplicationRequest struct { }
RepairApplicationRequest: Request message for 'Applications.RepairApplication'.
type RequestUtilization ¶
type RequestUtilization struct { // TargetConcurrentRequests: Target number of concurrent requests. TargetConcurrentRequests int64 `json:"targetConcurrentRequests,omitempty"` // TargetRequestCountPerSecond: Target requests per second. TargetRequestCountPerSecond int64 `json:"targetRequestCountPerSecond,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:"-"` }
RequestUtilization: Target scaling by request utilization (for VM runtimes only).
func (*RequestUtilization) MarshalJSON ¶
func (s *RequestUtilization) MarshalJSON() ([]byte, error)
type Resources ¶
type Resources struct { // Cpu: How many CPU cores an app version needs. Cpu float64 `json:"cpu,omitempty"` // DiskGb: How much disk size, in GB, an app version needs. DiskGb float64 `json:"diskGb,omitempty"` // MemoryGb: How much memory, in GB, an app version needs. MemoryGb float64 `json:"memoryGb,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:"-"` }
Resources: Used to specify how many machine resources an app version needs.
func (*Resources) MarshalJSON ¶
type ScriptHandler ¶
type ScriptHandler struct { // ScriptPath: Specifies the path to the script from the application // root directory. ScriptPath string `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:"-"` }
ScriptHandler: Executes a script to handle the request that matches the URL pattern.
func (*ScriptHandler) MarshalJSON ¶
func (s *ScriptHandler) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Apps *AppsService // contains filtered or unexported fields }
type StaticFilesHandler ¶
type StaticFilesHandler struct { // ApplicationReadable: 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 an application. If this field is set to // true, the files are also uploaded as code data so your application // can read them. Both uploads are charged against your code and static // data storage resource quotas. ApplicationReadable bool `json:"applicationReadable,omitempty"` // Expiration: The length of time a static file served by this handler // ought to be cached by web proxies and browsers. Expiration string `json:"expiration,omitempty"` // HttpHeaders: HTTP headers to use for all responses from these URLs. HttpHeaders map[string]string `json:"httpHeaders,omitempty"` // MimeType: If specified, all files served by this handler will be // served using the specified MIME type. If not specified, the MIME type // for a file will be derived from the file's filename extension. MimeType string `json:"mimeType,omitempty"` // Path: The 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. Path string `json:"path,omitempty"` // RequireMatchingFile: If true, this UrlMap entry does not match the // request unless the file referenced by the handler also exists. If no // such file exists, processing will continue with the next UrlMap that // matches the requested URL. RequireMatchingFile bool `json:"requireMatchingFile,omitempty"` // UploadPathRegex: A regular expression that matches the file paths for // all files that will be referenced by this handler. UploadPathRegex string `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:"-"` }
StaticFilesHandler: Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.
func (*StaticFilesHandler) MarshalJSON ¶
func (s *StaticFilesHandler) MarshalJSON() ([]byte, error)
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There will // be a common set of message types for APIs to use. Details []StatusDetails `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. Message string `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:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
func (*Status) MarshalJSON ¶
type StatusDetails ¶
type StatusDetails interface{}
type TrafficSplit ¶
type TrafficSplit struct { // Allocations: Mapping from service version IDs within the service to // fractional (0.000, 1] allocations of traffic for that version. Each // version may only be specified once, but some versions in the service // may not have any traffic allocation. Services that have traffic // allocated in this field may not be deleted until the service is // deleted, or their traffic allocation is removed. Allocations must sum // to 1. Supports precision up to two decimal places for IP-based splits // and up to three decimal places for cookie-based splits. Allocations *TrafficSplitAllocations `json:"allocations,omitempty"` // ShardBy: Which mechanism should be used as a selector when choosing a // version to send a request to. The traffic selection algorithm will be // stable for either type until allocations are changed. // // Possible values: // "UNSPECIFIED" // "COOKIE" // "IP" ShardBy string `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:"-"` }
TrafficSplit: Configuration for traffic splitting for versions within a single service. Traffic splitting allows traffic directed to the service to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example.
func (*TrafficSplit) MarshalJSON ¶
func (s *TrafficSplit) MarshalJSON() ([]byte, error)
type TrafficSplitAllocations ¶
type TrafficSplitAllocations struct { }
TrafficSplitAllocations: Mapping from service version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated in this field may not be deleted until the service is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
type UrlDispatchRule ¶
type UrlDispatchRule struct { // Domain: The domain name to match on. Supports '*' (glob) wildcarding // on the left-hand side of a '.'. If empty, all domains will be matched // (the same as '*'). Domain string `json:"domain,omitempty"` // Path: The pathname within the host. This must start with a '/'. A // single '*' (glob) can be included at the end of the path. The sum of // the lengths of the domain and path may not exceed 100 characters. Path string `json:"path,omitempty"` // Service: The resource id of a Service in this application that should // service the matched request. The Service must already exist. Example: // "default". Service string `json:"service,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:"-"` }
UrlDispatchRule: Rules to match an HTTP request and dispatch that request to a service.
func (*UrlDispatchRule) MarshalJSON ¶
func (s *UrlDispatchRule) MarshalJSON() ([]byte, error)
type UrlMap ¶
type UrlMap struct { // ApiEndpoint: Use API Endpoints to handle requests. ApiEndpoint *ApiEndpointHandler `json:"apiEndpoint,omitempty"` // AuthFailAction: For users not logged in, how to handle access to // resources with required login. Defaults to "redirect". // // Possible values: // "AUTH_FAIL_ACTION_UNSPECIFIED" // "AUTH_FAIL_ACTION_REDIRECT" // "AUTH_FAIL_ACTION_UNAUTHORIZED" AuthFailAction string `json:"authFailAction,omitempty"` // Login: What level of login is required to access this resource. // // Possible values: // "LOGIN_UNSPECIFIED" // "LOGIN_OPTIONAL" // "LOGIN_ADMIN" // "LOGIN_REQUIRED" Login string `json:"login,omitempty"` // RedirectHttpResponseCode: `30x` code to use when performing redirects // for the `secure` field. A `302` is used by default. // // Possible values: // "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED" // "REDIRECT_HTTP_RESPONSE_CODE_301" // "REDIRECT_HTTP_RESPONSE_CODE_302" // "REDIRECT_HTTP_RESPONSE_CODE_303" // "REDIRECT_HTTP_RESPONSE_CODE_307" RedirectHttpResponseCode string `json:"redirectHttpResponseCode,omitempty"` // Script: Executes a script to handle the request that matches the URL // pattern. Script *ScriptHandler `json:"script,omitempty"` // SecurityLevel: Configures whether security (HTTPS) should be enforced // for this URL. // // Possible values: // "SECURE_UNSPECIFIED" // "SECURE_DEFAULT" // "SECURE_NEVER" // "SECURE_OPTIONAL" // "SECURE_ALWAYS" SecurityLevel string `json:"securityLevel,omitempty"` // StaticFiles: Returns the contents of a file, such as an image, as the // response. StaticFiles *StaticFilesHandler `json:"staticFiles,omitempty"` // UrlRegex: A URL prefix. This value uses regular expression syntax // (and so regexp special characters must be escaped), but it 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. This is always required. UrlRegex string `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:"-"` }
UrlMap: A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
func (*UrlMap) MarshalJSON ¶
type Version ¶
type Version struct { // ApiConfig: Serving configuration for Google Cloud Endpoints. Only // returned in `GET` requests if `view=FULL` is set. May only be set on // create requests; once created, is immutable. ApiConfig *ApiConfigHandler `json:"apiConfig,omitempty"` // AutomaticScaling: Automatic scaling is the scaling policy that App // Engine has used since its inception. It is based on request rate, // response latencies, and other application metrics. AutomaticScaling *AutomaticScaling `json:"automaticScaling,omitempty"` // BasicScaling: A service 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: Beta settings supplied to the application via metadata. BetaSettings map[string]string `json:"betaSettings,omitempty"` // CreateTime: Creation time of this version. This will be between the // start and end times of the operation that creates this version. // @OutputOnly CreateTime string `json:"createTime,omitempty"` // CreatedBy: The email address of the user who created this version. // @OutputOnly CreatedBy string `json:"createdBy,omitempty"` // DefaultExpiration: The length of time a static file served by a // static file handler ought to be cached by web proxies and browsers, // if the handler does not specify its own expiration. Only returned in // `GET` requests if `view=FULL` is set. May only be set on create // requests; once created, is immutable. DefaultExpiration string `json:"defaultExpiration,omitempty"` // Deployment: Code and application artifacts that make up this version. // Only returned in `GET` requests if `view=FULL` is set. May only be // set on create requests; once created, is immutable. Deployment *Deployment `json:"deployment,omitempty"` // DiskUsageBytes: Total size of version files hosted on App Engine disk // in bytes. @OutputOnly DiskUsageBytes int64 `json:"diskUsageBytes,omitempty,string"` // Env: The App Engine execution environment to use for this version. // Default: "standard" Env string `json:"env,omitempty"` // EnvVariables: Environment variables made available to the // application. Only returned in `GET` requests if `view=FULL` is set. // May only be set on create requests; once created, is immutable. EnvVariables map[string]string `json:"envVariables,omitempty"` // ErrorHandlers: Custom static error pages instead of these generic // error pages, (limit 10 KB/page) Only returned in `GET` requests if // `view=FULL` is set. May only be set on create requests; once created, // is immutable. ErrorHandlers []*ErrorHandler `json:"errorHandlers,omitempty"` // Handlers: An ordered list of URL Matching patterns that should be // applied to incoming requests. The first matching URL consumes the // request, and subsequent handlers are not attempted. Only returned in // `GET` requests if `view=FULL` is set. May only be set on create // requests; once created, is immutable. Handlers []*UrlMap `json:"handlers,omitempty"` // HealthCheck: Configure health checking for the VM instances. // Unhealthy VM instances will be stopped and replaced with new // instances. Only returned in `GET` requests if `view=FULL` is set. May // only be set on create requests; once created, is immutable. HealthCheck *HealthCheck `json:"healthCheck,omitempty"` // Id: The relative name of the Version within the service. Example: // "v1". Version specifiers can contain lowercase letters, digits, and // hyphens. It cannot begin with the prefix `ah-` and the names // `default` and `latest` are reserved and cannot be used. Id string `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 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: The instance class to use to run this app. Valid // values for AutomaticScaling are `[F1, F2, F4, F4_1G]`. Valid values // for ManualScaling and BasicScaling are `[B1, B2, B4, B8, B4_1G]`. // Default: "F1" for AutomaticScaling, "B1" for ManualScaling and // BasicScaling InstanceClass string `json:"instanceClass,omitempty"` // Libraries: Configuration for Python runtime third-party libraries // required by the application. Only returned in `GET` requests if // `view=FULL` is set. May only be set on create requests; once created, // is immutable. Libraries []*Library `json:"libraries,omitempty"` // ManualScaling: A service 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: The full path to the Version resource in the API. Example: // "apps/myapp/services/default/versions/v1". @OutputOnly Name string `json:"name,omitempty"` // Network: Used to specify extra network settings (for VM runtimes // only). Network *Network `json:"network,omitempty"` // NobuildFilesRegex: Go only. Files that match this pattern will not be // built into the app. May only be set on create requests. NobuildFilesRegex string `json:"nobuildFilesRegex,omitempty"` // Resources: Used to specify how many machine resources an app version // needs (for VM runtimes only). Resources *Resources `json:"resources,omitempty"` // Runtime: The desired runtime. Values can include python27, java7, go, // etc. Runtime string `json:"runtime,omitempty"` // ServingStatus: The current serving status of this version. Only // `SERVING` versions will have instances created or billed for. If this // field is unset when a version is created, `SERVING` status will be // assumed. It is an error to explicitly set this field to // `SERVING_STATUS_UNSPECIFIED`. // // Possible values: // "SERVING_STATUS_UNSPECIFIED" // "SERVING" // "STOPPED" ServingStatus string `json:"servingStatus,omitempty"` // Threadsafe: If true, multiple requests can be dispatched to the app // at once. Threadsafe bool `json:"threadsafe,omitempty"` // VersionUrl: The version's URL, which is of the form: // https://service_version_id-dot-service_id-dot-app_id.appspot.com // @OutputOnly VersionUrl string `json:"versionUrl,omitempty"` // Vm: Whether to deploy this app in a VM container. Vm bool `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:"-"` }
Version: A Version is a specific set of source code and configuration files deployed to a service.