Class InstancesAsyncClient (1.1.5)

InstancesAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.appengine_admin_v1.services.instances.transports.base.InstancesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-appengine-admin/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Manages instances of a version.

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
`InstancesTransport`	The transport used by the client instance.

Methods

InstancesAsyncClient

InstancesAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.appengine_admin_v1.services.instances.transports.base.InstancesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-appengine-admin/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the instances client.

Parameters

Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .InstancesTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions

Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

debug_instance

debug_instance(request: Optional[google.cloud.appengine_admin_v1.types.appengine.DebugInstanceRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters

Name	Description
`request`	`DebugInstanceRequest` The request object. Request message for `Instances.DebugInstance`.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Instance An Instance resource is the computing unit that App Engine uses to automatically scale an application.

delete_instance

delete_instance(request: Optional[google.cloud.appengine_admin_v1.types.appengine.DeleteInstanceRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters

Name	Description
`request`	`DeleteInstanceRequest` The request object. Request message for `Instances.DeleteInstance`.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`InstancesAsyncClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
`info`	`dict` The service account private key info.

Returns

Type	Description
`InstancesAsyncClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`InstancesAsyncClient`	The constructed client.

get_instance

get_instance(request: Optional[google.cloud.appengine_admin_v1.types.appengine.GetInstanceRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets instance information.

Parameters

Name	Description
`request`	`GetInstanceRequest` The request object. Request message for `Instances.GetInstance`.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.appengine_admin_v1.types.Instance`	An Instance resource is the computing unit that App Engine uses to automatically scale an application.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

instance_path

instance_path(app: str, service: str, version: str, instance: str)

Returns a fully-qualified instance string.

list_instances

list_instances(request: Optional[google.cloud.appengine_admin_v1.types.appengine.ListInstancesRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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>__.

Parameters

Name	Description
`request`	`ListInstancesRequest` The request object. Request message for `Instances.ListInstances`.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.appengine_admin_v1.services.instances.pagers.ListInstancesAsyncPager`	Response message for Instances.ListInstances. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_instance_path

parse_instance_path(path: str)

Parses a instance path into its component segments.