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[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>)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.
Properties
transport
Returns the transport used by the client instance.
| Type | Description |
OsConfigZonalServiceTransport | The transport used by the client instance. |
Methods
OsConfigZonalServiceClient
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[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>)Instantiates the os config zonal service client.
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, OsConfigZonalServiceTransport]
The transport to use. 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. It won't take effect if a |
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 |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
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_os_policy_assignment
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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 <https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel>__.
# 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_v1alpha
def sample_create_os_policy_assignment():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
os_policy_assignment = osconfig_v1alpha.OSPolicyAssignment()
os_policy_assignment.os_policies.id = "id_value"
os_policy_assignment.os_policies.mode = "ENFORCEMENT"
os_policy_assignment.os_policies.resource_groups.resources.pkg.apt.name = "name_value"
os_policy_assignment.os_policies.resource_groups.resources.pkg.desired_state = "REMOVED"
os_policy_assignment.os_policies.resource_groups.resources.id = "id_value"
os_policy_assignment.rollout.disruption_budget.fixed = 528
request = osconfig_v1alpha.CreateOSPolicyAssignmentRequest(
parent="parent_value",
os_policy_assignment=os_policy_assignment,
os_policy_assignment_id="os_policy_assignment_id_value",
)
# Make the request
operation = client.create_os_policy_assignment(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
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 |
os_policy_assignment |
google.cloud.osconfig_v1alpha.types.OSPolicyAssignment
Required. The OS policy assignment to be created. This corresponds to the |
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 |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be 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). |
delete_os_policy_assignment
delete_os_policy_assignment(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignments.DeleteOSPolicyAssignmentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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 <https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel>__.
# 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_v1alpha
def sample_delete_os_policy_assignment():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.DeleteOSPolicyAssignmentRequest(
name="name_value",
)
# Make the request
operation = client.delete_os_policy_assignment(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
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 |
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. |
| Type | Description |
google.api_core.operation.Operation | 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); } |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
OsConfigZonalServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Name | Description |
info |
dict
The service account private key info. |
| Type | Description |
OsConfigZonalServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
OsConfigZonalServiceClient | The constructed client. |
get_instance_os_policies_compliance
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Get OS policies compliance data for the specified Compute Engine VM instance.
# 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_v1alpha
def sample_get_instance_os_policies_compliance():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.GetInstanceOSPoliciesComplianceRequest(
name="name_value",
)
# Make the request
response = client.get_instance_os_policies_compliance(request=request)
# Handle the response
print(response)
| Name | Description |
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: |
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. |
| Type | Description |
google.cloud.osconfig_v1alpha.types.InstanceOSPoliciesCompliance | 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). |
get_inventory
get_inventory(request: Optional[Union[google.cloud.osconfig_v1alpha.types.inventory.GetInventoryRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Get inventory data for the specified VM instance. If the VM has
no associated inventory, the message NOT_FOUND is returned.
# 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_v1alpha
def sample_get_inventory():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.GetInventoryRequest(
name="name_value",
)
# Make the request
response = client.get_inventory(request=request)
# Handle the response
print(response)
| Name | Description |
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: |
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. |
| Type | Description |
google.cloud.osconfig_v1alpha.types.Inventory | 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). |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)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.
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_os_policy_assignment
get_os_policy_assignment(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignments.GetOSPolicyAssignmentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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.
# 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_v1alpha
def sample_get_os_policy_assignment():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.GetOSPolicyAssignmentRequest(
name="name_value",
)
# Make the request
response = client.get_os_policy_assignment(request=request)
# Handle the response
print(response)
| Name | Description |
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: |
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. |
| Type | Description |
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). |
get_os_policy_assignment_report
get_os_policy_assignment_report(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignment_reports.GetOSPolicyAssignmentReportRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Get the OS policy asssignment report for the specified Compute Engine VM instance.
# 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_v1alpha
def sample_get_os_policy_assignment_report():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.GetOSPolicyAssignmentReportRequest(
name="name_value",
)
# Make the request
response = client.get_os_policy_assignment_report(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.osconfig_v1alpha.types.GetOSPolicyAssignmentReportRequest, dict]
The request object. Get a report of the OS policy assignment for a VM instance. |
name |
str
Required. API resource name for OS policy assignment report. Format: |
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. |
| Type | Description |
google.cloud.osconfig_v1alpha.types.OSPolicyAssignmentReport | A report of the OS policy assignment status for a given instance. |
get_vulnerability_report
get_vulnerability_report(request: Optional[Union[google.cloud.osconfig_v1alpha.types.vulnerability.GetVulnerabilityReportRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.
# 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_v1alpha
def sample_get_vulnerability_report():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.GetVulnerabilityReportRequest(
name="name_value",
)
# Make the request
response = client.get_vulnerability_report(request=request)
# Handle the response
print(response)
| Name | Description |
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: |
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. |
| Type | Description |
google.cloud.osconfig_v1alpha.types.VulnerabilityReport | 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). |
instance_os_policies_compliance_path
instance_os_policies_compliance_path(project: str, location: str, instance: str)Returns a fully-qualified instance_os_policies_compliance string.
instance_os_policy_assignment_path
instance_os_policy_assignment_path(
project: str, location: str, instance: str, assignment: str
)Returns a fully-qualified instance_os_policy_assignment string.
instance_path
instance_path(project: str, location: str, instance: str)Returns a fully-qualified instance string.
inventory_path
inventory_path(project: str, location: str, instance: str)Returns a fully-qualified inventory string.
list_instance_os_policies_compliances
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())List OS policies compliance data for all Compute Engine VM instances in the specified zone.
# 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_v1alpha
def sample_list_instance_os_policies_compliances():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.ListInstanceOSPoliciesCompliancesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_instance_os_policies_compliances(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
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: |
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. |
| Type | Description |
google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInstanceOSPoliciesCompliancesPager | 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. |
list_inventories
list_inventories(request: Optional[Union[google.cloud.osconfig_v1alpha.types.inventory.ListInventoriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())List inventory data for all VM instances in the specified zone.
# 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_v1alpha
def sample_list_inventories():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.ListInventoriesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_inventories(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
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: |
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. |
| Type | Description |
google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInventoriesPager | 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. |
list_os_policy_assignment_reports
list_os_policy_assignment_reports(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignment_reports.ListOSPolicyAssignmentReportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())List OS policy asssignment reports for all Compute Engine VM instances in the specified zone.
# 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_v1alpha
def sample_list_os_policy_assignment_reports():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.ListOSPolicyAssignmentReportsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_os_policy_assignment_reports(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
request |
Union[google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentReportsRequest, dict]
The request object. List the OS policy assignment reports for VM instances. |
parent |
str
Required. The parent resource name. Format: |
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. |
| Type | Description |
google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentReportsPager | A response message for listing OS Policy assignment reports including the page of results and page token. Iterating over this object will yield results and resolve additional pages automatically. |
list_os_policy_assignment_revisions
list_os_policy_assignment_revisions(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())List the OS policy assignment revisions for a given OS policy assignment.
# 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_v1alpha
def sample_list_os_policy_assignment_revisions():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.ListOSPolicyAssignmentRevisionsRequest(
name="name_value",
)
# Make the request
page_result = client.list_os_policy_assignment_revisions(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
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 |
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. |
| Type | Description |
google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentRevisionsPager | A response message for listing all revisions for a OS policy assignment. Iterating over this object will yield results and resolve additional pages automatically. |
list_os_policy_assignments
list_os_policy_assignments(request: Optional[Union[google.cloud.osconfig_v1alpha.types.os_policy_assignments.ListOSPolicyAssignmentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.
# 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_v1alpha
def sample_list_os_policy_assignments():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.ListOSPolicyAssignmentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_os_policy_assignments(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
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 |
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. |
| Type | Description |
google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentsPager | A response message for listing all assignments under given parent. Iterating over this object will yield results and resolve additional pages automatically. |
list_vulnerability_reports
list_vulnerability_reports(request: Optional[Union[google.cloud.osconfig_v1alpha.types.vulnerability.ListVulnerabilityReportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())List vulnerability reports for all VM instances in the specified zone.
# 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_v1alpha
def sample_list_vulnerability_reports():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
request = osconfig_v1alpha.ListVulnerabilityReportsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_vulnerability_reports(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
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: |
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. |
| Type | Description |
google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListVulnerabilityReportsPager | 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. |
os_policy_assignment_path
os_policy_assignment_path(project: str, location: str, os_policy_assignment: str)Returns a fully-qualified os_policy_assignment string.
os_policy_assignment_report_path
os_policy_assignment_report_path(
project: str, location: str, instance: str, assignment: str
)Returns a fully-qualified os_policy_assignment_report string.
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_os_policies_compliance_path
parse_instance_os_policies_compliance_path(path: str)Parses a instance_os_policies_compliance path into its component segments.
parse_instance_os_policy_assignment_path
parse_instance_os_policy_assignment_path(path: str)Parses a instance_os_policy_assignment path into its component segments.
parse_instance_path
parse_instance_path(path: str)Parses a instance path into its component segments.
parse_inventory_path
parse_inventory_path(path: str)Parses a inventory path into its component segments.
parse_os_policy_assignment_path
parse_os_policy_assignment_path(path: str)Parses a os_policy_assignment path into its component segments.
parse_os_policy_assignment_report_path
parse_os_policy_assignment_report_path(path: str)Parses a os_policy_assignment_report path into its component segments.
parse_vulnerability_report_path
parse_vulnerability_report_path(path: str)Parses a vulnerability_report path into its component segments.
update_os_policy_assignment
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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 <https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel>__.
# 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_v1alpha
def sample_update_os_policy_assignment():
# Create a client
client = osconfig_v1alpha.OsConfigZonalServiceClient()
# Initialize request argument(s)
os_policy_assignment = osconfig_v1alpha.OSPolicyAssignment()
os_policy_assignment.os_policies.id = "id_value"
os_policy_assignment.os_policies.mode = "ENFORCEMENT"
os_policy_assignment.os_policies.resource_groups.resources.pkg.apt.name = "name_value"
os_policy_assignment.os_policies.resource_groups.resources.pkg.desired_state = "REMOVED"
os_policy_assignment.os_policies.resource_groups.resources.id = "id_value"
os_policy_assignment.rollout.disruption_budget.fixed = 528
request = osconfig_v1alpha.UpdateOSPolicyAssignmentRequest(
os_policy_assignment=os_policy_assignment,
)
# Make the request
operation = client.update_os_policy_assignment(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.osconfig_v1alpha.types.UpdateOSPolicyAssignmentRequest, dict]
The request object. A request message to update an OS policy assignment |
os_policy_assignment |
google.cloud.osconfig_v1alpha.types.OSPolicyAssignment
Required. The updated OS policy assignment. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Optional. Field mask that controls which fields of the assignment should be updated. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be 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). |
vulnerability_report_path
vulnerability_report_path(project: str, location: str, instance: str)Returns a fully-qualified vulnerability_report string.