target.apidocs.com.google.api.services.appengine.v1.Appengine.Apps.Services.Versions.Instances.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-appengine Show documentation

There is a newer version: v1-rev20240906-2.0.0

Show newest version







Appengine.Apps.Services.Versions.Instances (App Engine Admin API v1-rev20240722-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.appengine.v1
Class Appengine.Apps.Services.Versions.Instances



java.lang.Object


com.google.api.services.appengine.v1.Appengine.Apps.Services.Versions.Instances







Enclosing class:
Appengine.Apps.Services.Versions




public class Appengine.Apps.Services.Versions.Instances
extends Object
The "instances" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Appengine.Apps.Services.Versions.Instances.Debug 


class 
Appengine.Apps.Services.Versions.Instances.Delete 


class 
Appengine.Apps.Services.Versions.Instances.Get 


class 
Appengine.Apps.Services.Versions.Instances.List 









Constructor Summary

Constructors 

Constructor and Description


Instances() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Appengine.Apps.Services.Versions.Instances.Debug
debug(String appsId,
     String servicesId,
     String versionsId,
     String instancesId,
     DebugInstanceRequest content)
Enables debugging on a VM instance.



Appengine.Apps.Services.Versions.Instances.Delete
delete(String appsId,
      String servicesId,
      String versionsId,
      String instancesId)
Stops a running instance.The instance might be automatically recreated based on the scaling
 settings of the version.



Appengine.Apps.Services.Versions.Instances.Get
get(String appsId,
   String servicesId,
   String versionsId,
   String instancesId)
Gets instance information.



Appengine.Apps.Services.Versions.Instances.List
list(String appsId,
    String servicesId,
    String versionsId)
Lists the instances of a version.Tip: To aggregate details about instances over time, see the
 Stackdriver Monitoring API
 (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Instances
public Instances()









Method Detail





debug
public Appengine.Apps.Services.Versions.Instances.Debug debug(String appsId,
                                                              String servicesId,
                                                              String versionsId,
                                                              String instancesId,
                                                              DebugInstanceRequest content)
                                                       throws IOException
Enables debugging on a VM instance. This allows you to use the SSH command to connect to the
 virtual machine where the instance lives. While in "debug mode", the instance continues to serve
 live traffic. You should delete the instance when you are done debugging and then allow the
 system to take over and determine if another instance should be started.Only applicable for
 instances in App Engine flexible environment.

 Create a request for the method "instances.debug".

 This request holds the parameters needed by the appengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
appsId - Part of `name`. Name of the resource requested. Example:
        apps/myapp/services/default/versions/v1/instances/instance-1.
servicesId - Part of `name`. See documentation of `appsId`.
versionsId - Part of `name`. See documentation of `appsId`.
instancesId - Part of `name`. See documentation of `appsId`.
content - the DebugInstanceRequest
Returns:
the request
Throws:
IOException








delete
public Appengine.Apps.Services.Versions.Instances.Delete delete(String appsId,
                                                                String servicesId,
                                                                String versionsId,
                                                                String instancesId)
                                                         throws IOException
Stops a running instance.The instance might be automatically recreated based on the scaling
 settings of the version. For more information, see "How Instances are Managed" (standard
 environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) |
 flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-
 managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all
 instances within the target version by changing the serving status of the version to STOPPED with
 the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-
 api/reference/rest/v1/apps.services.versions/patch) method.

 Create a request for the method "instances.delete".

 This request holds the parameters needed by the appengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
appsId - Part of `name`. Name of the resource requested. Example:
        apps/myapp/services/default/versions/v1/instances/instance-1.
servicesId - Part of `name`. See documentation of `appsId`.
versionsId - Part of `name`. See documentation of `appsId`.
instancesId - Part of `name`. See documentation of `appsId`.
Returns:
the request
Throws:
IOException








get
public Appengine.Apps.Services.Versions.Instances.Get get(String appsId,
                                                          String servicesId,
                                                          String versionsId,
                                                          String instancesId)
                                                   throws IOException
Gets instance information.

 Create a request for the method "instances.get".

 This request holds the parameters needed by the appengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
appsId - Part of `name`. Name of the resource requested. Example:
        apps/myapp/services/default/versions/v1/instances/instance-1.
servicesId - Part of `name`. See documentation of `appsId`.
versionsId - Part of `name`. See documentation of `appsId`.
instancesId - Part of `name`. See documentation of `appsId`.
Returns:
the request
Throws:
IOException








list
public Appengine.Apps.Services.Versions.Instances.List list(String appsId,
                                                            String servicesId,
                                                            String versionsId)
                                                     throws IOException
Lists the instances of a version.Tip: To aggregate details about instances over time, see the
 Stackdriver Monitoring API
 (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).

 Create a request for the method "instances.list".

 This request holds the parameters needed by the appengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
appsId - Part of `parent`. Name of the parent Version resource. Example:
        apps/myapp/services/default/versions/v1.
servicesId - Part of `parent`. See documentation of `appsId`.
versionsId - Part of `parent`. See documentation of `appsId`.
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Appengine.Apps.Services.Versions.Instances.Debug`
`class`	`Appengine.Apps.Services.Versions.Instances.Delete`
`class`	`Appengine.Apps.Services.Versions.Instances.Get`
`class`	`Appengine.Apps.Services.Versions.Instances.List`

Modifier and Type	Method and Description
`Appengine.Apps.Services.Versions.Instances.Debug`	`debug(String appsId, String servicesId, String versionsId, String instancesId, DebugInstanceRequest content)` Enables debugging on a VM instance.
`Appengine.Apps.Services.Versions.Instances.Delete`	`delete(String appsId, String servicesId, String versionsId, String instancesId)` Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version.
`Appengine.Apps.Services.Versions.Instances.Get`	`get(String appsId, String servicesId, String versionsId, String instancesId)` Gets instance information.
`Appengine.Apps.Services.Versions.Instances.List`	`list(String appsId, String servicesId, String versionsId)` Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).