OsConfigServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-os-config/.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>)
OS Config API The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
OsConfigServiceTransport | The transport used by the client instance. |
Methods
OsConfigServiceAsyncClient
OsConfigServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-os-config/.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 os config service 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,
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
cancel_patch_job
cancel_patch_job(request: Optional[google.cloud.osconfig_v1.types.patch_jobs.CancelPatchJobRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.
Parameters | |
---|---|
Name | Description |
request |
CancelPatchJobRequest
The request object. Message for canceling a patch job. |
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.osconfig_v1.types.PatchJob | A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](\ https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
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_patch_deployment
create_patch_deployment(request: Optional[google.cloud.osconfig_v1.types.patch_deployments.CreatePatchDeploymentRequest] = None, *, parent: Optional[str] = None, patch_deployment: Optional[google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment] = None, patch_deployment_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create an OS Config patch deployment.
Parameters | |
---|---|
Name | Description |
request |
CreatePatchDeploymentRequest
The request object. A request message for creating a patch deployment. |
parent |
Required. The project to apply this patch deployment to in the form |
patch_deployment |
PatchDeployment
Required. The patch deployment to create. This corresponds to the |
patch_deployment_id |
Required. A name for the patch deployment in the project. When creating a name the following rules apply: - Must contain only lowercase letters, numbers, and hyphens. - Must start with a letter. - Must be between 1-63 characters. - Must end with a number or a letter. - Must be unique within the project. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.osconfig_v1.types.PatchDeployment | Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](\ https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). |
delete_patch_deployment
delete_patch_deployment(request: Optional[google.cloud.osconfig_v1.types.patch_deployments.DeletePatchDeploymentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Delete an OS Config patch deployment.
Parameters | |
---|---|
Name | Description |
request |
DeletePatchDeploymentRequest
The request object. A request message for deleting a patch deployment. |
name |
Required. The resource name of the patch deployment in the form |
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. |
execute_patch_job
execute_patch_job(request: Optional[google.cloud.osconfig_v1.types.patch_jobs.ExecutePatchJobRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Patch VM instances by creating and running a patch job.
Parameters | |
---|---|
Name | Description |
request |
ExecutePatchJobRequest
The request object. A request message to initiate patching across Compute Engine instances. |
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.osconfig_v1.types.PatchJob | A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](\ https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
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 |
OsConfigServiceAsyncClient | 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 |
OsConfigServiceAsyncClient | 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 |
OsConfigServiceAsyncClient | The constructed client. |
get_patch_deployment
get_patch_deployment(request: Optional[google.cloud.osconfig_v1.types.patch_deployments.GetPatchDeploymentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get an OS Config patch deployment.
Parameters | |
---|---|
Name | Description |
request |
GetPatchDeploymentRequest
The request object. A request message for retrieving a patch deployment. |
name |
Required. The resource name of the patch deployment in the form |
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.osconfig_v1.types.PatchDeployment | Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](\ https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). |
get_patch_job
get_patch_job(request: Optional[google.cloud.osconfig_v1.types.patch_jobs.GetPatchJobRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.
Parameters | |
---|---|
Name | Description |
request |
GetPatchJobRequest
The request object. Request to get an active or completed patch job. |
name |
Required. Name of the patch in the form |
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.osconfig_v1.types.PatchJob | A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](\ https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
instance_path
instance_path(project: str, zone: str, instance: str)
Returns a fully-qualified instance string.
list_patch_deployments
list_patch_deployments(request: Optional[google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get a page of OS Config patch deployments.
Parameters | |
---|---|
Name | Description |
request |
ListPatchDeploymentsRequest
The request object. A request message for listing patch deployments. |
parent |
Required. The resource name of the parent in the form |
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.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsAsyncPager | A response message for listing patch deployments. Iterating over this object will yield results and resolve additional pages automatically. |
list_patch_job_instance_details
list_patch_job_instance_details(request: Optional[google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get a list of instance details for a given patch job.
Parameters | |
---|---|
Name | Description |
request |
ListPatchJobInstanceDetailsRequest
The request object. Request to list details for all instances that are part of a patch job. |
parent |
Required. The parent for the instances are in the form of |
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.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsAsyncPager | A response message for listing the instances details for a patch job. Iterating over this object will yield results and resolve additional pages automatically. |
list_patch_jobs
list_patch_jobs(request: Optional[google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get a list of patch jobs.
Parameters | |
---|---|
Name | Description |
request |
ListPatchJobsRequest
The request object. A request message for listing patch jobs. |
parent |
Required. In the form of |
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.osconfig_v1.services.os_config_service.pagers.ListPatchJobsAsyncPager | A response message for listing patch jobs. 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.
parse_patch_deployment_path
parse_patch_deployment_path(path: str)
Parses a patch_deployment path into its component segments.
parse_patch_job_path
parse_patch_job_path(path: str)
Parses a patch_job path into its component segments.
patch_deployment_path
patch_deployment_path(project: str, patch_deployment: str)
Returns a fully-qualified patch_deployment string.
patch_job_path
patch_job_path(project: str, patch_job: str)
Returns a fully-qualified patch_job string.