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.

OsConfigZonalService

class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.base.OsConfigZonalServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Zonal OS Config API The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.

Instantiates the os config zonal service client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, OsConfigZonalServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

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

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_os_policy_assignment(request: Optional[google.cloud.osconfig_v1alpha.types.os_policy_assignments.CreateOSPolicyAssignmentRequest] = None, *, parent: Optional[str] = None, os_policy_assignment: Optional[google.cloud.osconfig_v1alpha.types.os_policy_assignments.OSPolicyAssignment] = None, os_policy_assignment_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Create an OS policy assignment.

This method also creates the first revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.CreateOSPolicyAssignmentRequest) – The request object. A request message to create an OS policy assignment

  • parent (str) –

    Required. The parent resource name in the form: projects/{project}/locations/{location}

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

  • os_policy_assignment (google.cloud.osconfig_v1alpha.types.OSPolicyAssignment) –

    Required. The OS policy assignment to be created.

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

  • os_policy_assignment_id (str) –

    Required. The logical name of the OS policy assignment in the project with the following restrictions:

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

An object representing a long-running operation.

The result type for the operation will be google.cloud.osconfig_v1alpha.types.OSPolicyAssignment OS policy assignment is an API resource that is used to

apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances.

An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script.

For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).

Return type

google.api_core.operation_async.AsyncOperation

async delete_os_policy_assignment(request: Optional[google.cloud.osconfig_v1alpha.types.os_policy_assignments.DeleteOSPolicyAssignmentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Delete the OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.DeleteOSPolicyAssignmentRequest) – The request object. A request message for deleting a OS policy assignment.

  • name (str) –

    Required. The name of the OS policy assignment to be deleted

    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

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {

rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation_async.AsyncOperation

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

OsConfigZonalServiceAsyncClient

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

OsConfigZonalServiceAsyncClient

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

OsConfigZonalServiceAsyncClient

async get_instance_os_policies_compliance(request: Optional[google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.InstanceOSPoliciesCompliance[source]

Get OS policies compliance data for the specified Compute Engine VM instance.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.GetInstanceOSPoliciesComplianceRequest) – The request object. A request message for getting OS policies compliance data for the given Compute Engine VM instance.

  • name (str) –

    Required. API resource name for instance OS policies compliance resource.

    Format: projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}

    For {project}, either Compute Engine project-number or project-id can be provided. For {instance}, either Compute Engine VM instance-id or instance-name can be provided.

    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

This API resource represents the OS policies compliance data for a Compute

Engine virtual machine (VM) instance at a given point in time.

A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM.

You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy.

For more information, see [View compliance](https://cloud.google.com/compute/docs/os-configuration-management/view-compliance).

Return type

google.cloud.osconfig_v1alpha.types.InstanceOSPoliciesCompliance

async get_inventory(request: Optional[google.cloud.osconfig_v1alpha.types.inventory.GetInventoryRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.types.inventory.Inventory[source]

Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND is returned.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.GetInventoryRequest) – The request object. A request message for getting inventory data for the specified VM.

  • name (str) –

    Required. API resource name for inventory resource.

    Format: projects/{project}/locations/{location}/instances/{instance}/inventory

    For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

    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

This API resource represents the available inventory data for a

Compute Engine virtual machine (VM) instance at a given point in time.

You can use this API resource to determine the inventory data of your VM.

For more information, see [Information provided by OS inventory management](https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected).

Return type

google.cloud.osconfig_v1alpha.types.Inventory

async get_os_policy_assignment(request: Optional[google.cloud.osconfig_v1alpha.types.os_policy_assignments.GetOSPolicyAssignmentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.types.os_policy_assignments.OSPolicyAssignment[source]

Retrieve an existing OS policy assignment.

This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.GetOSPolicyAssignmentRequest) – The request object. A request message to get an OS policy assignment

  • name (str) –

    Required. The resource name of OS policy assignment.

    Format: projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}

    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

OS policy assignment is an API resource that is used to

apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances.

An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script.

For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).

Return type

google.cloud.osconfig_v1alpha.types.OSPolicyAssignment

get_transport_class()Type[google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.base.OsConfigZonalServiceTransport]

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.

async get_vulnerability_report(request: Optional[google.cloud.osconfig_v1alpha.types.vulnerability.GetVulnerabilityReportRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.types.vulnerability.VulnerabilityReport[source]

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.GetVulnerabilityReportRequest) – The request object. A request message for getting the vulnerability report for the specified VM.

  • name (str) –

    Required. API resource name for vulnerability resource.

    Format: projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport

    For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

    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

This API resource represents the vulnerability report for a specified

Compute Engine virtual machine (VM) instance at a given point in time.

For more information, see [Vulnerability reports](https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports).

Return type

google.cloud.osconfig_v1alpha.types.VulnerabilityReport

static instance_os_policies_compliance_path(project: str, location: str, instance: str)str

Returns a fully-qualified instance_os_policies_compliance string.

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

Returns a fully-qualified instance string.

static inventory_path(project: str, location: str, instance: str)str

Returns a fully-qualified inventory string.

async list_instance_os_policies_compliances(request: Optional[google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInstanceOSPoliciesCompliancesAsyncPager[source]

List OS policies compliance data for all Compute Engine VM instances in the specified zone.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.ListInstanceOSPoliciesCompliancesRequest) – The request object. A request message for listing OS policies compliance data for all Compute Engine VMs in the given location.

  • parent (str) –

    Required. The parent resource name.

    Format: projects/{project}/locations/{location}

    For {project}, either Compute Engine project-number or project-id can be provided.

    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 OS policies compliance data for all Compute Engine VMs in the given location. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInstanceOSPoliciesCompliancesAsyncPager

async list_inventories(request: Optional[google.cloud.osconfig_v1alpha.types.inventory.ListInventoriesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInventoriesAsyncPager[source]

List inventory data for all VM instances in the specified zone.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.ListInventoriesRequest) – The request object. A request message for listing inventory data for all VMs in the specified location.

  • parent (str) –

    Required. The parent resource name.

    Format: projects/{project}/locations/{location}/instances/{instance}

    For {project}, either project-number or project-id can be provided. For {instance}, only hyphen or dash character is supported to list inventories across VMs.

    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 inventory data for all VMs in a specified location. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInventoriesAsyncPager

async list_os_policy_assignment_revisions(request: Optional[google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentRevisionsAsyncPager[source]

List the OS policy assignment revisions for a given OS policy assignment.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsRequest) – The request object. A request message to list revisions for a OS policy assignment

  • name (str) –

    Required. The name of the OS policy assignment to list revisions for.

    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 response message for listing all revisions for a OS policy assignment. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentRevisionsAsyncPager

async list_os_policy_assignments(request: Optional[google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentsAsyncPager[source]

List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsRequest) – The request object. A request message to list OS policy assignments for a parent resource

  • parent (str) – Required. The parent resource name. 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 all assignments under given parent. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentsAsyncPager

async list_vulnerability_reports(request: Optional[google.cloud.osconfig_v1alpha.types.vulnerability.ListVulnerabilityReportsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListVulnerabilityReportsAsyncPager[source]

List vulnerability reports for all VM instances in the specified zone.

Parameters
  • request (google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsRequest) – The request object. A request message for listing vulnerability reports for all VM instances in the specified location.

  • parent (str) –

    Required. The parent resource name.

    Format: projects/{project}/locations/{location}/instances/{instance}

    For {project}, either project-number or project-id can be provided. For {instance}, only - character is supported to list vulnerability reports across VMs.

    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 vulnerability reports for all VM instances in the specified location. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListVulnerabilityReportsAsyncPager

static os_policy_assignment_path(project: str, location: str, os_policy_assignment: str)str

Returns a fully-qualified os_policy_assignment string.

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_os_policies_compliance_path(path: str)Dict[str, str]

Parses a instance_os_policies_compliance path into its component segments.

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

Parses a instance path into its component segments.

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

Parses a inventory path into its component segments.

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

Parses a os_policy_assignment path into its component segments.

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

Parses a vulnerability_report path into its component segments.

property transport: google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.base.OsConfigZonalServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

OsConfigZonalServiceTransport

async update_os_policy_assignment(request: Optional[google.cloud.osconfig_v1alpha.types.os_policy_assignments.UpdateOSPolicyAssignmentRequest] = None, *, os_policy_assignment: Optional[google.cloud.osconfig_v1alpha.types.os_policy_assignments.OSPolicyAssignment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Update an existing OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.osconfig_v1alpha.types.OSPolicyAssignment OS policy assignment is an API resource that is used to

apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances.

An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script.

For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).

Return type

google.api_core.operation_async.AsyncOperation

static vulnerability_report_path(project: str, location: str, instance: str)str

Returns a fully-qualified vulnerability_report string.

class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.OsConfigZonalServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.base.OsConfigZonalServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Zonal OS Config API The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.

Instantiates the os config zonal service client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, OsConfigZonalServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

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

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

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

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_os_policy_assignment(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignments.CreateOSPolicyAssignmentRequest, dict]] = None, *, parent: Optional[str] = None, os_policy_assignment: Optional[google.cloud.osconfig_v1alpha.types.os_policy_assignments.OSPolicyAssignment] = None, os_policy_assignment_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Create an OS policy assignment.

This method also creates the first revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.CreateOSPolicyAssignmentRequest, dict]) – The request object. A request message to create an OS policy assignment

  • parent (str) –

    Required. The parent resource name in the form: projects/{project}/locations/{location}

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

  • os_policy_assignment (google.cloud.osconfig_v1alpha.types.OSPolicyAssignment) –

    Required. The OS policy assignment to be created.

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

  • os_policy_assignment_id (str) –

    Required. The logical name of the OS policy assignment in the project with the following restrictions:

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

An object representing a long-running operation.

The result type for the operation will be google.cloud.osconfig_v1alpha.types.OSPolicyAssignment OS policy assignment is an API resource that is used to

apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances.

An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script.

For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).

Return type

google.api_core.operation.Operation

delete_os_policy_assignment(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignments.DeleteOSPolicyAssignmentRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Delete the OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.DeleteOSPolicyAssignmentRequest, dict]) – The request object. A request message for deleting a OS policy assignment.

  • name (str) –

    Required. The name of the OS policy assignment to be deleted

    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

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {

rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation.Operation

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

OsConfigZonalServiceClient

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

OsConfigZonalServiceClient

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

OsConfigZonalServiceClient

get_instance_os_policies_compliance(request: Optional[Union[google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.InstanceOSPoliciesCompliance[source]

Get OS policies compliance data for the specified Compute Engine VM instance.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.GetInstanceOSPoliciesComplianceRequest, dict]) – The request object. A request message for getting OS policies compliance data for the given Compute Engine VM instance.

  • name (str) –

    Required. API resource name for instance OS policies compliance resource.

    Format: projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}

    For {project}, either Compute Engine project-number or project-id can be provided. For {instance}, either Compute Engine VM instance-id or instance-name can be provided.

    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

This API resource represents the OS policies compliance data for a Compute

Engine virtual machine (VM) instance at a given point in time.

A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM.

You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy.

For more information, see [View compliance](https://cloud.google.com/compute/docs/os-configuration-management/view-compliance).

Return type

google.cloud.osconfig_v1alpha.types.InstanceOSPoliciesCompliance

get_inventory(request: Optional[Union[google.cloud.osconfig_v1alpha.types.inventory.GetInventoryRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.types.inventory.Inventory[source]

Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND is returned.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.GetInventoryRequest, dict]) – The request object. A request message for getting inventory data for the specified VM.

  • name (str) –

    Required. API resource name for inventory resource.

    Format: projects/{project}/locations/{location}/instances/{instance}/inventory

    For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

    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

This API resource represents the available inventory data for a

Compute Engine virtual machine (VM) instance at a given point in time.

You can use this API resource to determine the inventory data of your VM.

For more information, see [Information provided by OS inventory management](https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected).

Return type

google.cloud.osconfig_v1alpha.types.Inventory

get_os_policy_assignment(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignments.GetOSPolicyAssignmentRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.types.os_policy_assignments.OSPolicyAssignment[source]

Retrieve an existing OS policy assignment.

This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.GetOSPolicyAssignmentRequest, dict]) – The request object. A request message to get an OS policy assignment

  • name (str) –

    Required. The resource name of OS policy assignment.

    Format: projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}

    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

OS policy assignment is an API resource that is used to

apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances.

An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script.

For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).

Return type

google.cloud.osconfig_v1alpha.types.OSPolicyAssignment

get_vulnerability_report(request: Optional[Union[google.cloud.osconfig_v1alpha.types.vulnerability.GetVulnerabilityReportRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.types.vulnerability.VulnerabilityReport[source]

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.GetVulnerabilityReportRequest, dict]) – The request object. A request message for getting the vulnerability report for the specified VM.

  • name (str) –

    Required. API resource name for vulnerability resource.

    Format: projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport

    For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

    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

This API resource represents the vulnerability report for a specified

Compute Engine virtual machine (VM) instance at a given point in time.

For more information, see [Vulnerability reports](https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports).

Return type

google.cloud.osconfig_v1alpha.types.VulnerabilityReport

static instance_os_policies_compliance_path(project: str, location: str, instance: str)str[source]

Returns a fully-qualified instance_os_policies_compliance string.

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

Returns a fully-qualified instance string.

static inventory_path(project: str, location: str, instance: str)str[source]

Returns a fully-qualified inventory string.

list_instance_os_policies_compliances(request: Optional[Union[google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInstanceOSPoliciesCompliancesPager[source]

List OS policies compliance data for all Compute Engine VM instances in the specified zone.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.ListInstanceOSPoliciesCompliancesRequest, dict]) – The request object. A request message for listing OS policies compliance data for all Compute Engine VMs in the given location.

  • parent (str) –

    Required. The parent resource name.

    Format: projects/{project}/locations/{location}

    For {project}, either Compute Engine project-number or project-id can be provided.

    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 OS policies compliance data for all Compute Engine VMs in the given location. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInstanceOSPoliciesCompliancesPager

list_inventories(request: Optional[Union[google.cloud.osconfig_v1alpha.types.inventory.ListInventoriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInventoriesPager[source]

List inventory data for all VM instances in the specified zone.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.ListInventoriesRequest, dict]) – The request object. A request message for listing inventory data for all VMs in the specified location.

  • parent (str) –

    Required. The parent resource name.

    Format: projects/{project}/locations/{location}/instances/{instance}

    For {project}, either project-number or project-id can be provided. For {instance}, only hyphen or dash character is supported to list inventories across VMs.

    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 inventory data for all VMs in a specified location. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInventoriesPager

list_os_policy_assignment_revisions(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentRevisionsPager[source]

List the OS policy assignment revisions for a given OS policy assignment.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsRequest, dict]) – The request object. A request message to list revisions for a OS policy assignment

  • name (str) –

    Required. The name of the OS policy assignment to list revisions for.

    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 response message for listing all revisions for a OS policy assignment. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentRevisionsPager

list_os_policy_assignments(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentsPager[source]

List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsRequest, dict]) – The request object. A request message to list OS policy assignments for a parent resource

  • parent (str) – Required. The parent resource name. 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 all assignments under given parent. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentsPager

list_vulnerability_reports(request: Optional[Union[google.cloud.osconfig_v1alpha.types.vulnerability.ListVulnerabilityReportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListVulnerabilityReportsPager[source]

List vulnerability reports for all VM instances in the specified zone.

Parameters
  • request (Union[google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsRequest, dict]) – The request object. A request message for listing vulnerability reports for all VM instances in the specified location.

  • parent (str) –

    Required. The parent resource name.

    Format: projects/{project}/locations/{location}/instances/{instance}

    For {project}, either project-number or project-id can be provided. For {instance}, only - character is supported to list vulnerability reports across VMs.

    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 vulnerability reports for all VM instances in the specified location. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListVulnerabilityReportsPager

static os_policy_assignment_path(project: str, location: str, os_policy_assignment: str)str[source]

Returns a fully-qualified os_policy_assignment string.

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_os_policies_compliance_path(path: str)Dict[str, str][source]

Parses a instance_os_policies_compliance 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_inventory_path(path: str)Dict[str, str][source]

Parses a inventory path into its component segments.

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

Parses a os_policy_assignment path into its component segments.

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

Parses a vulnerability_report path into its component segments.

property transport: google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.base.OsConfigZonalServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

OsConfigZonalServiceTransport

update_os_policy_assignment(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignments.UpdateOSPolicyAssignmentRequest, dict]] = None, *, os_policy_assignment: Optional[google.cloud.osconfig_v1alpha.types.os_policy_assignments.OSPolicyAssignment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Update an existing OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.osconfig_v1alpha.types.OSPolicyAssignment OS policy assignment is an API resource that is used to

apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances.

An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script.

For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).

Return type

google.api_core.operation.Operation

static vulnerability_report_path(project: str, location: str, instance: str)str[source]

Returns a fully-qualified vulnerability_report string.

class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInstanceOSPoliciesCompliancesAsyncPager(method: Callable[[...], Awaitable[google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse]], request: google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest, response: google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_instance_os_policies_compliances requests.

This class thinly wraps an initial google.cloud.osconfig_v1alpha.types.ListInstanceOSPoliciesCompliancesResponse object, and provides an __aiter__ method to iterate through its instance_os_policies_compliances field.

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

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

Instantiates the pager.

Parameters
class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInstanceOSPoliciesCompliancesPager(method: Callable[[...], google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse], request: google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest, response: google.cloud.osconfig_v1alpha.types.instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_instance_os_policies_compliances requests.

This class thinly wraps an initial google.cloud.osconfig_v1alpha.types.ListInstanceOSPoliciesCompliancesResponse object, and provides an __iter__ method to iterate through its instance_os_policies_compliances field.

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

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

Instantiate the pager.

Parameters
class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInventoriesAsyncPager(method: Callable[[...], Awaitable[google.cloud.osconfig_v1alpha.types.inventory.ListInventoriesResponse]], request: google.cloud.osconfig_v1alpha.types.inventory.ListInventoriesRequest, response: google.cloud.osconfig_v1alpha.types.inventory.ListInventoriesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_inventories requests.

This class thinly wraps an initial google.cloud.osconfig_v1alpha.types.ListInventoriesResponse object, and provides an __aiter__ method to iterate through its inventories field.

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

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

Instantiates the pager.

Parameters
class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInventoriesPager(method: Callable[[...], google.cloud.osconfig_v1alpha.types.inventory.ListInventoriesResponse], request: google.cloud.osconfig_v1alpha.types.inventory.ListInventoriesRequest, response: google.cloud.osconfig_v1alpha.types.inventory.ListInventoriesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_inventories requests.

This class thinly wraps an initial google.cloud.osconfig_v1alpha.types.ListInventoriesResponse object, and provides an __iter__ method to iterate through its inventories field.

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

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

Instantiate the pager.

Parameters
class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentRevisionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse]], request: google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest, response: google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_os_policy_assignment_revisions requests.

This class thinly wraps an initial google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsResponse object, and provides an __aiter__ method to iterate through its os_policy_assignments field.

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

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

Instantiates the pager.

Parameters
class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentRevisionsPager(method: Callable[[...], google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse], request: google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest, response: google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_os_policy_assignment_revisions requests.

This class thinly wraps an initial google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsResponse object, and provides an __iter__ method to iterate through its os_policy_assignments field.

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

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

Instantiate the pager.

Parameters
class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentsAsyncPager(method: Callable[[...], Awaitable[google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentsResponse]], request: google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentsRequest, response: google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_os_policy_assignments requests.

This class thinly wraps an initial google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsResponse object, and provides an __aiter__ method to iterate through its os_policy_assignments field.

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

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

Instantiates the pager.

Parameters
class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentsPager(method: Callable[[...], google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentsResponse], request: google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentsRequest, response: google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_os_policy_assignments requests.

This class thinly wraps an initial google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsResponse object, and provides an __iter__ method to iterate through its os_policy_assignments field.

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

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

Instantiate the pager.

Parameters
class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListVulnerabilityReportsAsyncPager(method: Callable[[...], Awaitable[google.cloud.osconfig_v1alpha.types.vulnerability.ListVulnerabilityReportsResponse]], request: google.cloud.osconfig_v1alpha.types.vulnerability.ListVulnerabilityReportsRequest, response: google.cloud.osconfig_v1alpha.types.vulnerability.ListVulnerabilityReportsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_vulnerability_reports requests.

This class thinly wraps an initial google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsResponse object, and provides an __aiter__ method to iterate through its vulnerability_reports field.

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

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

Instantiates the pager.

Parameters
class google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListVulnerabilityReportsPager(method: Callable[[...], google.cloud.osconfig_v1alpha.types.vulnerability.ListVulnerabilityReportsResponse], request: google.cloud.osconfig_v1alpha.types.vulnerability.ListVulnerabilityReportsRequest, response: google.cloud.osconfig_v1alpha.types.vulnerability.ListVulnerabilityReportsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_vulnerability_reports requests.

This class thinly wraps an initial google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsResponse object, and provides an __iter__ method to iterate through its vulnerability_reports field.

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

All the usual google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsResponse 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