RegionAutoscalersClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.region_autoscalers.transports.base.RegionAutoscalersTransport]] = 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>)
The RegionAutoscalers API.
Properties
transport
Returns the transport used by the client instance.
Type | Description |
RegionAutoscalersTransport | The transport used by the client instance. |
Methods
RegionAutoscalersClient
RegionAutoscalersClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.region_autoscalers.transports.base.RegionAutoscalersTransport]] = 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 region autoscalers client.
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, RegionAutoscalersTransport]
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 |
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 |
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.
delete
delete(request: Optional[google.cloud.compute_v1.types.compute.DeleteRegionAutoscalerRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, autoscaler: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified autoscaler.
Name | Description |
request |
google.cloud.compute_v1.types.DeleteRegionAutoscalerRequest
The request object. A request message for RegionAutoscalers.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
autoscaler |
str
Name of the autoscaler to delete. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
RegionAutoscalersClient | 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
RegionAutoscalersClient | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
RegionAutoscalersClient | The constructed client. |
get
get(request: Optional[google.cloud.compute_v1.types.compute.GetRegionAutoscalerRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, autoscaler: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the specified autoscaler.
Name | Description |
request |
google.cloud.compute_v1.types.GetRegionAutoscalerRequest
The request object. A request message for RegionAutoscalers.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
autoscaler |
str
Name of the autoscaler to return. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Autoscaler | Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: - [Zonal](/compute/docs/reference/rest/{$api_version}/autoscalers) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionAutoscalers) Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==) |
insert
insert(request: Optional[google.cloud.compute_v1.types.compute.InsertRegionAutoscalerRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, autoscaler_resource: Optional[google.cloud.compute_v1.types.compute.Autoscaler] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates an autoscaler in the specified project using the data included in the request.
Name | Description |
request |
google.cloud.compute_v1.types.InsertRegionAutoscalerRequest
The request object. A request message for RegionAutoscalers.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
autoscaler_resource |
google.cloud.compute_v1.types.Autoscaler
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
list
list(request: Optional[google.cloud.compute_v1.types.compute.ListRegionAutoscalersRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves a list of autoscalers contained within the specified region.
Name | Description |
request |
google.cloud.compute_v1.types.ListRegionAutoscalersRequest
The request object. A request message for RegionAutoscalers.List. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.services.region_autoscalers.pagers.ListPager | Contains a list of autoscalers. 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.
patch
patch(request: Optional[google.cloud.compute_v1.types.compute.PatchRegionAutoscalerRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, autoscaler_resource: Optional[google.cloud.compute_v1.types.compute.Autoscaler] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Name | Description |
request |
google.cloud.compute_v1.types.PatchRegionAutoscalerRequest
The request object. A request message for RegionAutoscalers.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
autoscaler_resource |
google.cloud.compute_v1.types.Autoscaler
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
update
update(request: Optional[google.cloud.compute_v1.types.compute.UpdateRegionAutoscalerRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, autoscaler_resource: Optional[google.cloud.compute_v1.types.compute.Autoscaler] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates an autoscaler in the specified project using the data included in the request.
Name | Description |
request |
google.cloud.compute_v1.types.UpdateRegionAutoscalerRequest
The request object. A request message for RegionAutoscalers.Update. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
autoscaler_resource |
google.cloud.compute_v1.types.Autoscaler
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |