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: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport, typing.Callable[[...], google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport]]] = 'grpc_asyncio', client_options: typing.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 async 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 (Optional[Union[str,OsConfigServiceTransport,Callable[..., OsConfigServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the OsConfigServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

async cancel_patch_job(request: Optional[Union[google.cloud.osconfig_v1.types.patch_jobs.CancelPatchJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_cancel_patch_job():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.CancelPatchJobRequest(
        name="name_value",
    )

    # Make the request
    response = await client.cancel_patch_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.osconfig_v1.types.CancelPatchJobRequest, dict]]) – The request object. Message for canceling a patch job.
retry (google.api_core.retry_async.AsyncRetry) – 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 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[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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]¶

Create an OS Config patch deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_create_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.CreatePatchDeploymentRequest(
        parent="parent_value",
        patch_deployment_id="patch_deployment_id_value",
    )

    # Make the request
    response = await client.create_patch_deployment(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[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_async.AsyncRetry) – 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[Union[google.cloud.osconfig_v1.types.patch_deployments.DeletePatchDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Delete an OS Config patch deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_delete_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.DeletePatchDeploymentRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_patch_deployment(request=request)

Parameters

request (Optional[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_async.AsyncRetry) – 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[Union[google.cloud.osconfig_v1.types.patch_jobs.ExecutePatchJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_jobs.PatchJob[source]¶

Patch VM instances by creating and running a patch job.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_execute_patch_job():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.ExecutePatchJobRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.execute_patch_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.osconfig_v1.types.ExecutePatchJobRequest, dict]]) – The request object. A request message to initiate patching across Compute Engine instances.
retry (google.api_core.retry_async.AsyncRetry) – 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

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

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.GetPatchDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]¶

Get an OS Config patch deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_get_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.GetPatchDeploymentRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_patch_deployment(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[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_async.AsyncRetry) – 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[Union[google.cloud.osconfig_v1.types.patch_jobs.GetPatchJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_get_patch_job():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.GetPatchJobRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_patch_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[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_async.AsyncRetry) – 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

classmethod get_transport_class(label: Optional[str] = None) → 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[Union[google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsAsyncPager[source]¶

Get a page of OS Config patch deployments.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_list_patch_deployments():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.ListPatchDeploymentsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_patch_deployments(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[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_async.AsyncRetry) – 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[Union[google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_list_patch_job_instance_details():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.ListPatchJobInstanceDetailsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_patch_job_instance_details(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[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_async.AsyncRetry) – 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[Union[google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsAsyncPager[source]¶

Get a list of patch jobs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_list_patch_jobs():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.ListPatchJobsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_patch_jobs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[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_async.AsyncRetry) – 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.

async pause_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.PausePatchDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]¶

Change state of patch deployment to “PAUSED”. Patch deployment in paused state doesn’t generate patch jobs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_pause_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.PausePatchDeploymentRequest(
        name="name_value",
    )

    # Make the request
    response = await client.pause_patch_deployment(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.osconfig_v1.types.PausePatchDeploymentRequest, dict]]) – The request object. A request message for pausing 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_async.AsyncRetry) – 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 resume_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.ResumePatchDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]¶

Change state of patch deployment back to “ACTIVE”. Patch deployment in active state continues to generate patch jobs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_resume_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.ResumePatchDeploymentRequest(
        name="name_value",
    )

    # Make the request
    response = await client.resume_patch_deployment(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.osconfig_v1.types.ResumePatchDeploymentRequest, dict]]) – The request object. A request message for resuming 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_async.AsyncRetry) – 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

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

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.UpdatePatchDeploymentRequest, dict]] = None, *, patch_deployment: Optional[google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]¶

Update an OS Config patch deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

async def sample_update_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceAsyncClient()

    # Initialize request argument(s)
    request = osconfig_v1.UpdatePatchDeploymentRequest(
    )

    # Make the request
    response = await client.update_patch_deployment(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.osconfig_v1.types.UpdatePatchDeploymentRequest, dict]]) – The request object. A request message for updating a patch deployment.
patch_deployment (google.cloud.osconfig_v1.types.PatchDeployment) –
Required. The patch deployment to Update.

This corresponds to the patch_deployment field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Optional. Field mask that controls which fields of the patch deployment should be updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

class google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport, typing.Callable[[...], google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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 (Optional[Union[str,OsConfigServiceTransport,Callable[..., OsConfigServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the OsConfigServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

cancel_patch_job(request: Optional[Union[google.cloud.osconfig_v1.types.patch_jobs.CancelPatchJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_cancel_patch_job():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.CancelPatchJobRequest(
        name="name_value",
    )

    # Make the request
    response = client.cancel_patch_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.osconfig_v1.types.CancelPatchJobRequest, dict]) – 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

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]¶

Create an OS Config patch deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_create_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.CreatePatchDeploymentRequest(
        parent="parent_value",
        patch_deployment_id="patch_deployment_id_value",
    )

    # Make the request
    response = client.create_patch_deployment(request=request)

    # Handle the response
    print(response)

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Delete an OS Config patch deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_delete_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.DeletePatchDeploymentRequest(
        name="name_value",
    )

    # Make the request
    client.delete_patch_deployment(request=request)

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_jobs.PatchJob[source]¶

Patch VM instances by creating and running a patch job.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_execute_patch_job():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.ExecutePatchJobRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.execute_patch_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.osconfig_v1.types.ExecutePatchJobRequest, dict]) – 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

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

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.GetPatchDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]¶

Get an OS Config patch deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_get_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.GetPatchDeploymentRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_patch_deployment(request=request)

    # Handle the response
    print(response)

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_get_patch_job():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.GetPatchJobRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_patch_job(request=request)

    # Handle the response
    print(response)

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsPager[source]¶

Get a page of OS Config patch deployments.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_list_patch_deployments():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.ListPatchDeploymentsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_patch_deployments(request=request)

    # Handle the response
    for response in page_result:
        print(response)

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_list_patch_job_instance_details():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.ListPatchJobInstanceDetailsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_patch_job_instance_details(request=request)

    # Handle the response
    for response in page_result:
        print(response)

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsPager[source]¶

Get a list of patch jobs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_list_patch_jobs():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.ListPatchJobsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_patch_jobs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

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.

pause_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.PausePatchDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]¶

Change state of patch deployment to “PAUSED”. Patch deployment in paused state doesn’t generate patch jobs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_pause_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.PausePatchDeploymentRequest(
        name="name_value",
    )

    # Make the request
    response = client.pause_patch_deployment(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.osconfig_v1.types.PausePatchDeploymentRequest, dict]) – The request object. A request message for pausing 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

resume_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.ResumePatchDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]¶

Change state of patch deployment back to “ACTIVE”. Patch deployment in active state continues to generate patch jobs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_resume_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.ResumePatchDeploymentRequest(
        name="name_value",
    )

    # Make the request
    response = client.resume_patch_deployment(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.osconfig_v1.types.ResumePatchDeploymentRequest, dict]) – The request object. A request message for resuming 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

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

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_patch_deployment(request: Optional[Union[google.cloud.osconfig_v1.types.patch_deployments.UpdatePatchDeploymentRequest, dict]] = None, *, patch_deployment: Optional[google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment[source]¶

Update an OS Config patch deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import osconfig_v1

def sample_update_patch_deployment():
    # Create a client
    client = osconfig_v1.OsConfigServiceClient()

    # Initialize request argument(s)
    request = osconfig_v1.UpdatePatchDeploymentRequest(
    )

    # Make the request
    response = client.update_patch_deployment(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.osconfig_v1.types.UpdatePatchDeploymentRequest, dict]) – The request object. A request message for updating a patch deployment.
patch_deployment (google.cloud.osconfig_v1.types.PatchDeployment) –
Required. The patch deployment to Update.

This corresponds to the patch_deployment field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Optional. Field mask that controls which fields of the patch deployment should be updated.

This corresponds to the update_mask 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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.osconfig_v1.types.ListPatchDeploymentsRequest) – The initial request object.
response (google.cloud.osconfig_v1.types.ListPatchDeploymentsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.osconfig_v1.types.ListPatchDeploymentsRequest) – The initial request object.
response (google.cloud.osconfig_v1.types.ListPatchDeploymentsResponse) – The initial response object.
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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.osconfig_v1.types.ListPatchJobInstanceDetailsRequest) – The initial request object.
response (google.cloud.osconfig_v1.types.ListPatchJobInstanceDetailsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.osconfig_v1.types.ListPatchJobInstanceDetailsRequest) – The initial request object.
response (google.cloud.osconfig_v1.types.ListPatchJobInstanceDetailsResponse) – The initial response object.
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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.osconfig_v1.types.ListPatchJobsRequest) – The initial request object.
response (google.cloud.osconfig_v1.types.ListPatchJobsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.osconfig_v1.types.ListPatchJobsRequest) – The initial request object.
response (google.cloud.osconfig_v1.types.ListPatchJobsResponse) – The initial response object.
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.

OsConfigService¶

google-cloud-os-config

Navigation

Related Topics