Class VersionsClient (1.1.5)

Version 1.1.5

• 1.12.1 (latest)
• 1.12.0
• 1.11.5
• 1.10.0
• 1.9.4
• 1.8.1
• 1.7.1
• 1.6.0
• 1.5.3
• 1.4.1
• 1.3.3
• 1.2.1
• 1.1.5
• 1.0.2
• 0.2.0
• 0.1.0

VersionsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.appengine_admin_v1.services.versions.transports.base.VersionsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Manages versions of a service.

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
VersionsTransport	The transport used by the client instance.

Methods

VersionsClient

VersionsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.appengine_admin_v1.services.versions.transports.base.VersionsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the versions 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, VersionsTransport] The transport to use. If set to None, a transport is chosen automatically.
client_options	google.api_core.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.
client_info	google.api_core.gapic_v1.client_info.ClientInfo The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

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.

create_version

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

Deploys code and resource files to a new version.

Parameters

Name	Description
request	Union[google.cloud.appengine_admin_v1.types.CreateVersionRequest, dict] The request object. Request message for Versions.CreateVersion.
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.Operation	An object representing a long-running operation. The result type for the operation will be Version A Version resource is a specific set of source code and configuration files that are deployed into a service.

delete_version

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

Deletes an existing Version resource.

Parameters

Name	Description
request	Union[google.cloud.appengine_admin_v1.types.DeleteVersionRequest, dict] The request object. Request message for Versions.DeleteVersion.
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.Operation

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
VersionsClient	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
VersionsClient	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
VersionsClient	The constructed client.

get_version

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

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

Parameters

Name	Description
request	Union[google.cloud.appengine_admin_v1.types.GetVersionRequest, dict] The request object. Request message for Versions.GetVersion.
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.Version	A Version resource is a specific set of source code and configuration files that are deployed into a service.

list_versions

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

Lists the versions of a service.

Parameters

Name	Description
request	Union[google.cloud.appengine_admin_v1.types.ListVersionsRequest, dict] The request object. Request message for Versions.ListVersions.
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.versions.pagers.ListVersionsPager	Response message for Versions.ListVersions. 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.

update_version

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

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:

Standard environment

• `instance_class https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class`__

automatic scaling in the standard environment:

• `automatic_scaling.min_idle_instances https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling`__
• `automatic_scaling.max_idle_instances https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling`__
• `automaticScaling.standard_scheduler_settings.max_instances https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings`__
• `automaticScaling.standard_scheduler_settings.min_instances https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings`__
• `automaticScaling.standard_scheduler_settings.target_cpu_utilization https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings`__
• `automaticScaling.standard_scheduler_settings.target_throughput_utilization https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings`__

basic scaling or manual scaling in the standard environment:

• `serving_status https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status`__
• `manual_scaling.instances https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling`__

Flexible environment

• `serving_status https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status`__

automatic scaling in the flexible environment:

• `automatic_scaling.min_total_instances https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling`__
• `automatic_scaling.max_total_instances https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling`__
• `automatic_scaling.cool_down_period_sec https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling`__
• `automatic_scaling.cpu_utilization.target_utilization https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling`__

manual scaling in the flexible environment:

• `manual_scaling.instances https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling`__

Parameters

Name	Description
request	Union[google.cloud.appengine_admin_v1.types.UpdateVersionRequest, dict] The request object. Request message for Versions.UpdateVersion.
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.Operation	An object representing a long-running operation. The result type for the operation will be Version A Version resource is a specific set of source code and configuration files that are deployed into a service.