Class OsConfigServiceClient (1.6.0)

Stay organized with collections Save and categorize content based on your preferences.
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>)

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.

Inheritance

builtins.object > OsConfigServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
OsConfigServiceTransportThe transport used by the client instance.

Methods

OsConfigServiceClient

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

Instantiates the os config service client.

Parameters
NameDescription
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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

cancel_patch_job

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

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

Parameters
NameDescription
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
TypeDescription
google.cloud.osconfig_v1.types.PatchJobA high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](\ https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_patch_deployment

create_patch_deployment(request: Optional[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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create an OS Config patch deployment.

Parameters
NameDescription
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
TypeDescription
google.cloud.osconfig_v1.types.PatchDeploymentPatch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](\ https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).

delete_patch_deployment

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

Delete an OS Config patch deployment.

Parameters
NameDescription
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

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

Patch VM instances by creating and running a patch job.

Parameters
NameDescription
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
TypeDescription
google.cloud.osconfig_v1.types.PatchJobA high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](\ https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
OsConfigServiceClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
OsConfigServiceClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
OsConfigServiceClientThe constructed client.

get_patch_deployment

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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Get an OS Config patch deployment.

Parameters
NameDescription
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
TypeDescription
google.cloud.osconfig_v1.types.PatchDeploymentPatch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](\ https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).

get_patch_job

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

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Parameters
NameDescription
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
TypeDescription
google.cloud.osconfig_v1.types.PatchJobA 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).

instance_path

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

Returns a fully-qualified instance string.

list_patch_deployments

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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Get a page of OS Config patch deployments.

Parameters
NameDescription
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
TypeDescription
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsPagerA response message for listing patch deployments. Iterating over this object will yield results and resolve additional pages automatically.

list_patch_job_instance_details

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

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

Parameters
NameDescription
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
TypeDescription
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsPagerA response message for listing the instances details for a patch job. Iterating over this object will yield results and resolve additional pages automatically.

list_patch_jobs

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

Get a list of patch jobs.

Parameters
NameDescription
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
TypeDescription
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsPagerA response message for listing patch jobs. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_instance_path

parse_instance_path(path: str)

Parses a instance path into its component segments.

parse_patch_deployment_path

parse_patch_deployment_path(path: str)

Parses a patch_deployment path into its component segments.

parse_patch_job_path

parse_patch_job_path(path: str)

Parses a patch_job path into its component segments.

patch_deployment_path

patch_deployment_path(project: str, patch_deployment: str)

Returns a fully-qualified patch_deployment string.

patch_job_path

patch_job_path(project: str, patch_job: str)

Returns a fully-qualified patch_job string.