As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

OsConfigService

class google.cloud.osconfig_v1.services.os_config_service.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/.nox/docs/lib/python3.8/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>)[source]

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.

Instantiates the os config service client.

Parameters
  • 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, OsConfigServiceTransport]) – 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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async cancel_patch_job(request: Optional[google.cloud.osconfig_v1.types.patch_jobs.CancelPatchJobRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.types.patch_jobs.PatchJob[source]

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

Parameters
Returns

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

Return type

google.cloud.osconfig_v1.types.PatchJob

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]

Create an OS Config patch deployment.

Parameters
  • request (google.cloud.osconfig_v1.types.CreatePatchDeploymentRequest) – The request object. A request message for creating a patch deployment.

  • parent (str) –

    Required. The project to apply this patch deployment to in the form projects/*.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • patch_deployment (google.cloud.osconfig_v1.types.PatchDeployment) –

    Required. The patch deployment to create.

    This corresponds to the patch_deployment field on the request instance; if request is provided, this should not be set.

  • patch_deployment_id (str) –

    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 patch_deployment_id field on the request instance; if request is provided, this should not be set.

  • 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

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

Return type

google.cloud.osconfig_v1.types.PatchDeployment

async delete_patch_deployment(request: Optional[google.cloud.osconfig_v1.types.patch_deployments.DeletePatchDeploymentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Delete an OS Config patch deployment.

Parameters
  • request (google.cloud.osconfig_v1.types.DeletePatchDeploymentRequest) – The request object. A request message for deleting a patch deployment.

  • name (str) –

    Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

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

async execute_patch_job(request: Optional[google.cloud.osconfig_v1.types.patch_jobs.ExecutePatchJobRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.types.patch_jobs.PatchJob[source]

Patch VM instances by creating and running a patch job.

Parameters
Returns

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

Return type

google.cloud.osconfig_v1.types.PatchJob

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OsConfigServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OsConfigServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OsConfigServiceAsyncClient

async get_patch_deployment(request: Optional[google.cloud.osconfig_v1.types.patch_deployments.GetPatchDeploymentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]

Get an OS Config patch deployment.

Parameters
  • request (google.cloud.osconfig_v1.types.GetPatchDeploymentRequest) – The request object. A request message for retrieving a patch deployment.

  • name (str) –

    Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

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

Return type

google.cloud.osconfig_v1.types.PatchDeployment

async get_patch_job(request: Optional[google.cloud.osconfig_v1.types.patch_jobs.GetPatchJobRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.types.patch_jobs.PatchJob[source]

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
  • request (google.cloud.osconfig_v1.types.GetPatchJobRequest) – The request object. Request to get an active or completed patch job.

  • name (str) –

    Required. Name of the patch in the form projects/*/patchJobs/*

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

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

Return type

google.cloud.osconfig_v1.types.PatchJob

get_transport_class()Type[google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

static instance_path(project: str, zone: str, instance: str)str

Returns a fully-qualified instance string.

async list_patch_deployments(request: Optional[google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsAsyncPager[source]

Get a page of OS Config patch deployments.

Parameters
  • request (google.cloud.osconfig_v1.types.ListPatchDeploymentsRequest) – The request object. A request message for listing patch deployments.

  • parent (str) –

    Required. The resource name of the parent in the form projects/*.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

A response message for listing patch deployments. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsAsyncPager

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsAsyncPager[source]

Get a list of instance details for a given patch job.

Parameters
  • request (google.cloud.osconfig_v1.types.ListPatchJobInstanceDetailsRequest) – The request object. Request to list details for all instances that are part of a patch job.

  • parent (str) –

    Required. The parent for the instances are in the form of projects/*/patchJobs/*.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

A response message for listing the instances details for a patch job. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsAsyncPager

async list_patch_jobs(request: Optional[google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsAsyncPager[source]

Get a list of patch jobs.

Parameters
  • request (google.cloud.osconfig_v1.types.ListPatchJobsRequest) – The request object. A request message for listing patch jobs.

  • parent (str) – Required. In the form of projects/* This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

A response message for listing patch jobs. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsAsyncPager

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_instance_path(path: str)Dict[str, str]

Parses a instance path into its component segments.

static parse_patch_deployment_path(path: str)Dict[str, str]

Parses a patch_deployment path into its component segments.

static parse_patch_job_path(path: str)Dict[str, str]

Parses a patch_job path into its component segments.

static patch_deployment_path(project: str, patch_deployment: str)str

Returns a fully-qualified patch_deployment string.

static patch_job_path(project: str, patch_job: str)str

Returns a fully-qualified patch_job string.

property transport: google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

OsConfigServiceTransport

class google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport]] = 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>)[source]

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.

Instantiates the os config service client.

Parameters
  • 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, OsConfigServiceTransport]) – 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

cancel_patch_job(request: Optional[Union[google.cloud.osconfig_v1.types.patch_jobs.CancelPatchJobRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.types.patch_jobs.PatchJob[source]

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

Parameters
Returns

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

Return type

google.cloud.osconfig_v1.types.PatchJob

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

create_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.CreatePatchDeploymentRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]

Create an OS Config patch deployment.

Parameters
  • request (Union[google.cloud.osconfig_v1.types.CreatePatchDeploymentRequest, dict]) – The request object. A request message for creating a patch deployment.

  • parent (str) –

    Required. The project to apply this patch deployment to in the form projects/*.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • patch_deployment (google.cloud.osconfig_v1.types.PatchDeployment) –

    Required. The patch deployment to create.

    This corresponds to the patch_deployment field on the request instance; if request is provided, this should not be set.

  • patch_deployment_id (str) –

    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 patch_deployment_id field on the request instance; if request is provided, this should not be set.

  • 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

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

Return type

google.cloud.osconfig_v1.types.PatchDeployment

delete_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.DeletePatchDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Delete an OS Config patch deployment.

Parameters
  • request (Union[google.cloud.osconfig_v1.types.DeletePatchDeploymentRequest, dict]) – The request object. A request message for deleting a patch deployment.

  • name (str) –

    Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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(request: Optional[Union[google.cloud.osconfig_v1.types.patch_jobs.ExecutePatchJobRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.types.patch_jobs.PatchJob[source]

Patch VM instances by creating and running a patch job.

Parameters
Returns

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

Return type

google.cloud.osconfig_v1.types.PatchJob

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OsConfigServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OsConfigServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OsConfigServiceClient

get_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.GetPatchDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]

Get an OS Config patch deployment.

Parameters
  • request (Union[google.cloud.osconfig_v1.types.GetPatchDeploymentRequest, dict]) – The request object. A request message for retrieving a patch deployment.

  • name (str) –

    Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

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

Return type

google.cloud.osconfig_v1.types.PatchDeployment

get_patch_job(request: Optional[Union[google.cloud.osconfig_v1.types.patch_jobs.GetPatchJobRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.types.patch_jobs.PatchJob[source]

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
  • request (Union[google.cloud.osconfig_v1.types.GetPatchJobRequest, dict]) – The request object. Request to get an active or completed patch job.

  • name (str) –

    Required. Name of the patch in the form projects/*/patchJobs/*

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

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

Return type

google.cloud.osconfig_v1.types.PatchJob

static instance_path(project: str, zone: str, instance: str)str[source]

Returns a fully-qualified instance string.

list_patch_deployments(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsPager[source]

Get a page of OS Config patch deployments.

Parameters
  • request (Union[google.cloud.osconfig_v1.types.ListPatchDeploymentsRequest, dict]) – The request object. A request message for listing patch deployments.

  • parent (str) –

    Required. The resource name of the parent in the form projects/*.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

A response message for listing patch deployments. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsPager

list_patch_job_instance_details(request: Optional[Union[google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsPager[source]

Get a list of instance details for a given patch job.

Parameters
  • request (Union[google.cloud.osconfig_v1.types.ListPatchJobInstanceDetailsRequest, dict]) – The request object. Request to list details for all instances that are part of a patch job.

  • parent (str) –

    Required. The parent for the instances are in the form of projects/*/patchJobs/*.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

A response message for listing the instances details for a patch job. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsPager

list_patch_jobs(request: Optional[Union[google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsPager[source]

Get a list of patch jobs.

Parameters
  • request (Union[google.cloud.osconfig_v1.types.ListPatchJobsRequest, dict]) – The request object. A request message for listing patch jobs.

  • parent (str) – Required. In the form of projects/* This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

A response message for listing patch jobs. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsPager

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_instance_path(path: str)Dict[str, str][source]

Parses a instance path into its component segments.

static parse_patch_deployment_path(path: str)Dict[str, str][source]

Parses a patch_deployment path into its component segments.

static parse_patch_job_path(path: str)Dict[str, str][source]

Parses a patch_job path into its component segments.

static patch_deployment_path(project: str, patch_deployment: str)str[source]

Returns a fully-qualified patch_deployment string.

static patch_job_path(project: str, patch_job: str)str[source]

Returns a fully-qualified patch_job string.

property transport: google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

OsConfigServiceTransport

class google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsAsyncPager(method: Callable[[...], Awaitable[google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsResponse]], request: google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsRequest, response: google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_patch_deployments requests.

This class thinly wraps an initial google.cloud.osconfig_v1.types.ListPatchDeploymentsResponse object, and provides an __aiter__ method to iterate through its patch_deployments field.

If there are more pages, the __aiter__ method will make additional ListPatchDeployments requests and continue to iterate through the patch_deployments field on the corresponding responses.

All the usual google.cloud.osconfig_v1.types.ListPatchDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsPager(method: Callable[[...], google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsResponse], request: google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsRequest, response: google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_patch_deployments requests.

This class thinly wraps an initial google.cloud.osconfig_v1.types.ListPatchDeploymentsResponse object, and provides an __iter__ method to iterate through its patch_deployments field.

If there are more pages, the __iter__ method will make additional ListPatchDeployments requests and continue to iterate through the patch_deployments field on the corresponding responses.

All the usual google.cloud.osconfig_v1.types.ListPatchDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsAsyncPager(method: Callable[[...], Awaitable[google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsResponse]], request: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsRequest, response: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_patch_job_instance_details requests.

This class thinly wraps an initial google.cloud.osconfig_v1.types.ListPatchJobInstanceDetailsResponse object, and provides an __aiter__ method to iterate through its patch_job_instance_details field.

If there are more pages, the __aiter__ method will make additional ListPatchJobInstanceDetails requests and continue to iterate through the patch_job_instance_details field on the corresponding responses.

All the usual google.cloud.osconfig_v1.types.ListPatchJobInstanceDetailsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsPager(method: Callable[[...], google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsResponse], request: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsRequest, response: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_patch_job_instance_details requests.

This class thinly wraps an initial google.cloud.osconfig_v1.types.ListPatchJobInstanceDetailsResponse object, and provides an __iter__ method to iterate through its patch_job_instance_details field.

If there are more pages, the __iter__ method will make additional ListPatchJobInstanceDetails requests and continue to iterate through the patch_job_instance_details field on the corresponding responses.

All the usual google.cloud.osconfig_v1.types.ListPatchJobInstanceDetailsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsAsyncPager(method: Callable[[...], Awaitable[google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsResponse]], request: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsRequest, response: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_patch_jobs requests.

This class thinly wraps an initial google.cloud.osconfig_v1.types.ListPatchJobsResponse object, and provides an __aiter__ method to iterate through its patch_jobs field.

If there are more pages, the __aiter__ method will make additional ListPatchJobs requests and continue to iterate through the patch_jobs field on the corresponding responses.

All the usual google.cloud.osconfig_v1.types.ListPatchJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsPager(method: Callable[[...], google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsResponse], request: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsRequest, response: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_patch_jobs requests.

This class thinly wraps an initial google.cloud.osconfig_v1.types.ListPatchJobsResponse object, and provides an __iter__ method to iterate through its patch_jobs field.

If there are more pages, the __iter__ method will make additional ListPatchJobs requests and continue to iterate through the patch_jobs field on the corresponding responses.

All the usual google.cloud.osconfig_v1.types.ListPatchJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters