From 23862dc803169b5233aa007a1030cd75d3bacc7e Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Wed, 9 Jun 2021 11:36:02 -0400 Subject: [PATCH] feat: add v1alpha (#80) Googlers see b/186567237 --- packages/google-cloud-os-config/.coveragerc | 1 - .../.github/.OwlBot.yaml | 1 - .../google-cloud-os-config/docs/index.rst | 21 +- .../os_config_zonal_service.rst | 10 + .../docs/osconfig_v1alpha/services.rst | 6 + .../docs/osconfig_v1alpha/types.rst | 7 + .../google/cloud/osconfig_v1alpha/__init__.py | 88 + .../osconfig_v1alpha/gapic_metadata.json | 143 + .../google/cloud/osconfig_v1alpha/py.typed | 2 + .../osconfig_v1alpha/services/__init__.py | 15 + .../os_config_zonal_service/__init__.py | 22 + .../os_config_zonal_service/async_client.py | 1341 +++++ .../os_config_zonal_service/client.py | 1611 ++++++ .../os_config_zonal_service/pagers.py | 715 +++ .../transports/__init__.py | 35 + .../transports/base.py | 370 ++ .../transports/grpc.py | 646 +++ .../transports/grpc_asyncio.py | 654 +++ .../cloud/osconfig_v1alpha/types/__init__.py | 86 + .../osconfig_v1alpha/types/config_common.py | 106 + .../types/instance_os_policies_compliance.py | 212 + .../cloud/osconfig_v1alpha/types/inventory.py | 466 ++ .../cloud/osconfig_v1alpha/types/os_policy.py | 722 +++ .../types/os_policy_assignments.py | 426 ++ .../osconfig_v1alpha/types/osconfig_common.py | 41 + .../types/osconfig_zonal_service.py | 21 + .../osconfig_v1alpha/types/vulnerability.py | 353 ++ .../fixup_osconfig_v1alpha_keywords.py | 187 + .../unit/gapic/osconfig_v1alpha/__init__.py | 15 + .../test_os_config_zonal_service.py | 5040 +++++++++++++++++ 30 files changed, 13358 insertions(+), 5 deletions(-) create mode 100644 packages/google-cloud-os-config/docs/osconfig_v1alpha/os_config_zonal_service.rst create mode 100644 packages/google-cloud-os-config/docs/osconfig_v1alpha/services.rst create mode 100644 packages/google-cloud-os-config/docs/osconfig_v1alpha/types.rst create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/__init__.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/gapic_metadata.json create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/py.typed create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/__init__.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/__init__.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/async_client.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/client.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/pagers.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/__init__.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/base.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/grpc.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/grpc_asyncio.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/__init__.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/config_common.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/instance_os_policies_compliance.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/inventory.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy_assignments.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/osconfig_common.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/osconfig_zonal_service.py create mode 100644 packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/vulnerability.py create mode 100644 packages/google-cloud-os-config/scripts/fixup_osconfig_v1alpha_keywords.py create mode 100644 packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1alpha/__init__.py create mode 100644 packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1alpha/test_os_config_zonal_service.py diff --git a/packages/google-cloud-os-config/.coveragerc b/packages/google-cloud-os-config/.coveragerc index d7914ac4aff5..d146ff08956a 100644 --- a/packages/google-cloud-os-config/.coveragerc +++ b/packages/google-cloud-os-config/.coveragerc @@ -2,7 +2,6 @@ branch = True [report] -fail_under = 100 show_missing = True omit = google/cloud/osconfig/__init__.py diff --git a/packages/google-cloud-os-config/.github/.OwlBot.yaml b/packages/google-cloud-os-config/.github/.OwlBot.yaml index 674d60f31302..8b8c1b624a45 100644 --- a/packages/google-cloud-os-config/.github/.OwlBot.yaml +++ b/packages/google-cloud-os-config/.github/.OwlBot.yaml @@ -19,7 +19,6 @@ deep-remove-regex: - /owl-bot-staging deep-preserve-regex: - - /owl-bot-staging/v1alpha - /owl-bot-staging/v1beta deep-copy-regex: diff --git a/packages/google-cloud-os-config/docs/index.rst b/packages/google-cloud-os-config/docs/index.rst index 53af354dbb91..46b8c4ea9c55 100644 --- a/packages/google-cloud-os-config/docs/index.rst +++ b/packages/google-cloud-os-config/docs/index.rst @@ -1,15 +1,30 @@ .. include:: README.rst -.. include:: multiprocessing.rst +.. include:: multiprocessing.rst + +This package includes clients for multiple versions of the osconfig +API. By default, you will get ``v1``, the latest GA version. + +osconfig_v1 API Reference +------------------------- -API Reference -------------- .. toctree:: :maxdepth: 2 osconfig_v1/services osconfig_v1/types + +osconfig_v1alpha API Reference +------------------------------ + +.. toctree:: + :maxdepth: 2 + + osconfig_v1alpha/services + osconfig_v1alpha/types + + Changelog --------- diff --git a/packages/google-cloud-os-config/docs/osconfig_v1alpha/os_config_zonal_service.rst b/packages/google-cloud-os-config/docs/osconfig_v1alpha/os_config_zonal_service.rst new file mode 100644 index 000000000000..c4cbbeec7f4d --- /dev/null +++ b/packages/google-cloud-os-config/docs/osconfig_v1alpha/os_config_zonal_service.rst @@ -0,0 +1,10 @@ +OsConfigZonalService +-------------------------------------- + +.. automodule:: google.cloud.osconfig_v1alpha.services.os_config_zonal_service + :members: + :inherited-members: + +.. automodule:: google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers + :members: + :inherited-members: diff --git a/packages/google-cloud-os-config/docs/osconfig_v1alpha/services.rst b/packages/google-cloud-os-config/docs/osconfig_v1alpha/services.rst new file mode 100644 index 000000000000..2f77a4cfedda --- /dev/null +++ b/packages/google-cloud-os-config/docs/osconfig_v1alpha/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Osconfig v1alpha API +============================================== +.. toctree:: + :maxdepth: 2 + + os_config_zonal_service diff --git a/packages/google-cloud-os-config/docs/osconfig_v1alpha/types.rst b/packages/google-cloud-os-config/docs/osconfig_v1alpha/types.rst new file mode 100644 index 000000000000..84add7ed96c7 --- /dev/null +++ b/packages/google-cloud-os-config/docs/osconfig_v1alpha/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Osconfig v1alpha API +=========================================== + +.. automodule:: google.cloud.osconfig_v1alpha.types + :members: + :undoc-members: + :show-inheritance: diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/__init__.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/__init__.py new file mode 100644 index 000000000000..a51d1bff158d --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/__init__.py @@ -0,0 +1,88 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .services.os_config_zonal_service import OsConfigZonalServiceClient +from .services.os_config_zonal_service import OsConfigZonalServiceAsyncClient + +from .types.config_common import OSPolicyResourceCompliance +from .types.config_common import OSPolicyResourceConfigStep +from .types.config_common import OSPolicyComplianceState +from .types.instance_os_policies_compliance import ( + GetInstanceOSPoliciesComplianceRequest, +) +from .types.instance_os_policies_compliance import InstanceOSPoliciesCompliance +from .types.instance_os_policies_compliance import ( + ListInstanceOSPoliciesCompliancesRequest, +) +from .types.instance_os_policies_compliance import ( + ListInstanceOSPoliciesCompliancesResponse, +) +from .types.inventory import GetInventoryRequest +from .types.inventory import Inventory +from .types.inventory import ListInventoriesRequest +from .types.inventory import ListInventoriesResponse +from .types.inventory import InventoryView +from .types.os_policy import OSPolicy +from .types.os_policy_assignments import CreateOSPolicyAssignmentRequest +from .types.os_policy_assignments import DeleteOSPolicyAssignmentRequest +from .types.os_policy_assignments import GetOSPolicyAssignmentRequest +from .types.os_policy_assignments import ListOSPolicyAssignmentRevisionsRequest +from .types.os_policy_assignments import ListOSPolicyAssignmentRevisionsResponse +from .types.os_policy_assignments import ListOSPolicyAssignmentsRequest +from .types.os_policy_assignments import ListOSPolicyAssignmentsResponse +from .types.os_policy_assignments import OSPolicyAssignment +from .types.os_policy_assignments import OSPolicyAssignmentOperationMetadata +from .types.os_policy_assignments import UpdateOSPolicyAssignmentRequest +from .types.osconfig_common import FixedOrPercent +from .types.vulnerability import CVSSv3 +from .types.vulnerability import GetVulnerabilityReportRequest +from .types.vulnerability import ListVulnerabilityReportsRequest +from .types.vulnerability import ListVulnerabilityReportsResponse +from .types.vulnerability import VulnerabilityReport + +__all__ = ( + "OsConfigZonalServiceAsyncClient", + "CVSSv3", + "CreateOSPolicyAssignmentRequest", + "DeleteOSPolicyAssignmentRequest", + "FixedOrPercent", + "GetInstanceOSPoliciesComplianceRequest", + "GetInventoryRequest", + "GetOSPolicyAssignmentRequest", + "GetVulnerabilityReportRequest", + "InstanceOSPoliciesCompliance", + "Inventory", + "InventoryView", + "ListInstanceOSPoliciesCompliancesRequest", + "ListInstanceOSPoliciesCompliancesResponse", + "ListInventoriesRequest", + "ListInventoriesResponse", + "ListOSPolicyAssignmentRevisionsRequest", + "ListOSPolicyAssignmentRevisionsResponse", + "ListOSPolicyAssignmentsRequest", + "ListOSPolicyAssignmentsResponse", + "ListVulnerabilityReportsRequest", + "ListVulnerabilityReportsResponse", + "OSPolicy", + "OSPolicyAssignment", + "OSPolicyAssignmentOperationMetadata", + "OSPolicyComplianceState", + "OSPolicyResourceCompliance", + "OSPolicyResourceConfigStep", + "OsConfigZonalServiceClient", + "UpdateOSPolicyAssignmentRequest", + "VulnerabilityReport", +) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/gapic_metadata.json b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/gapic_metadata.json new file mode 100644 index 000000000000..74295757cc48 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/gapic_metadata.json @@ -0,0 +1,143 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.osconfig_v1alpha", + "protoPackage": "google.cloud.osconfig.v1alpha", + "schema": "1.0", + "services": { + "OsConfigZonalService": { + "clients": { + "grpc": { + "libraryClient": "OsConfigZonalServiceClient", + "rpcs": { + "CreateOSPolicyAssignment": { + "methods": [ + "create_os_policy_assignment" + ] + }, + "DeleteOSPolicyAssignment": { + "methods": [ + "delete_os_policy_assignment" + ] + }, + "GetInstanceOSPoliciesCompliance": { + "methods": [ + "get_instance_os_policies_compliance" + ] + }, + "GetInventory": { + "methods": [ + "get_inventory" + ] + }, + "GetOSPolicyAssignment": { + "methods": [ + "get_os_policy_assignment" + ] + }, + "GetVulnerabilityReport": { + "methods": [ + "get_vulnerability_report" + ] + }, + "ListInstanceOSPoliciesCompliances": { + "methods": [ + "list_instance_os_policies_compliances" + ] + }, + "ListInventories": { + "methods": [ + "list_inventories" + ] + }, + "ListOSPolicyAssignmentRevisions": { + "methods": [ + "list_os_policy_assignment_revisions" + ] + }, + "ListOSPolicyAssignments": { + "methods": [ + "list_os_policy_assignments" + ] + }, + "ListVulnerabilityReports": { + "methods": [ + "list_vulnerability_reports" + ] + }, + "UpdateOSPolicyAssignment": { + "methods": [ + "update_os_policy_assignment" + ] + } + } + }, + "grpc-async": { + "libraryClient": "OsConfigZonalServiceAsyncClient", + "rpcs": { + "CreateOSPolicyAssignment": { + "methods": [ + "create_os_policy_assignment" + ] + }, + "DeleteOSPolicyAssignment": { + "methods": [ + "delete_os_policy_assignment" + ] + }, + "GetInstanceOSPoliciesCompliance": { + "methods": [ + "get_instance_os_policies_compliance" + ] + }, + "GetInventory": { + "methods": [ + "get_inventory" + ] + }, + "GetOSPolicyAssignment": { + "methods": [ + "get_os_policy_assignment" + ] + }, + "GetVulnerabilityReport": { + "methods": [ + "get_vulnerability_report" + ] + }, + "ListInstanceOSPoliciesCompliances": { + "methods": [ + "list_instance_os_policies_compliances" + ] + }, + "ListInventories": { + "methods": [ + "list_inventories" + ] + }, + "ListOSPolicyAssignmentRevisions": { + "methods": [ + "list_os_policy_assignment_revisions" + ] + }, + "ListOSPolicyAssignments": { + "methods": [ + "list_os_policy_assignments" + ] + }, + "ListVulnerabilityReports": { + "methods": [ + "list_vulnerability_reports" + ] + }, + "UpdateOSPolicyAssignment": { + "methods": [ + "update_os_policy_assignment" + ] + } + } + } + } + } + } +} diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/py.typed b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/py.typed new file mode 100644 index 000000000000..e2df01b1f33b --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-osconfig package uses inline types. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/__init__.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/__init__.py new file mode 100644 index 000000000000..4de65971c238 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/__init__.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/__init__.py new file mode 100644 index 000000000000..0948ebea2db7 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import OsConfigZonalServiceClient +from .async_client import OsConfigZonalServiceAsyncClient + +__all__ = ( + "OsConfigZonalServiceClient", + "OsConfigZonalServiceAsyncClient", +) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/async_client.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/async_client.py new file mode 100644 index 000000000000..89431d0b14e6 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/async_client.py @@ -0,0 +1,1341 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.osconfig_v1alpha.services.os_config_zonal_service import pagers +from google.cloud.osconfig_v1alpha.types import config_common +from google.cloud.osconfig_v1alpha.types import instance_os_policies_compliance +from google.cloud.osconfig_v1alpha.types import inventory +from google.cloud.osconfig_v1alpha.types import os_policy +from google.cloud.osconfig_v1alpha.types import os_policy_assignments +from google.cloud.osconfig_v1alpha.types import vulnerability +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import OsConfigZonalServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import OsConfigZonalServiceGrpcAsyncIOTransport +from .client import OsConfigZonalServiceClient + + +class OsConfigZonalServiceAsyncClient: + """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. + """ + + _client: OsConfigZonalServiceClient + + DEFAULT_ENDPOINT = OsConfigZonalServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = OsConfigZonalServiceClient.DEFAULT_MTLS_ENDPOINT + + instance_path = staticmethod(OsConfigZonalServiceClient.instance_path) + parse_instance_path = staticmethod(OsConfigZonalServiceClient.parse_instance_path) + instance_os_policies_compliance_path = staticmethod( + OsConfigZonalServiceClient.instance_os_policies_compliance_path + ) + parse_instance_os_policies_compliance_path = staticmethod( + OsConfigZonalServiceClient.parse_instance_os_policies_compliance_path + ) + inventory_path = staticmethod(OsConfigZonalServiceClient.inventory_path) + parse_inventory_path = staticmethod(OsConfigZonalServiceClient.parse_inventory_path) + os_policy_assignment_path = staticmethod( + OsConfigZonalServiceClient.os_policy_assignment_path + ) + parse_os_policy_assignment_path = staticmethod( + OsConfigZonalServiceClient.parse_os_policy_assignment_path + ) + vulnerability_report_path = staticmethod( + OsConfigZonalServiceClient.vulnerability_report_path + ) + parse_vulnerability_report_path = staticmethod( + OsConfigZonalServiceClient.parse_vulnerability_report_path + ) + common_billing_account_path = staticmethod( + OsConfigZonalServiceClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + OsConfigZonalServiceClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod(OsConfigZonalServiceClient.common_folder_path) + parse_common_folder_path = staticmethod( + OsConfigZonalServiceClient.parse_common_folder_path + ) + common_organization_path = staticmethod( + OsConfigZonalServiceClient.common_organization_path + ) + parse_common_organization_path = staticmethod( + OsConfigZonalServiceClient.parse_common_organization_path + ) + common_project_path = staticmethod(OsConfigZonalServiceClient.common_project_path) + parse_common_project_path = staticmethod( + OsConfigZonalServiceClient.parse_common_project_path + ) + common_location_path = staticmethod(OsConfigZonalServiceClient.common_location_path) + parse_common_location_path = staticmethod( + OsConfigZonalServiceClient.parse_common_location_path + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + 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: + OsConfigZonalServiceAsyncClient: The constructed client. + """ + return OsConfigZonalServiceClient.from_service_account_info.__func__(OsConfigZonalServiceAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + 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: + OsConfigZonalServiceAsyncClient: The constructed client. + """ + return OsConfigZonalServiceClient.from_service_account_file.__func__(OsConfigZonalServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> OsConfigZonalServiceTransport: + """Returns the transport used by the client instance. + + Returns: + OsConfigZonalServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial( + type(OsConfigZonalServiceClient).get_transport_class, + type(OsConfigZonalServiceClient), + ) + + def __init__( + self, + *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, OsConfigZonalServiceTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the os config zonal service client. + + Args: + 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. + """ + self._client = OsConfigZonalServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + ) + + async def create_os_policy_assignment( + self, + request: os_policy_assignments.CreateOSPolicyAssignmentRequest = None, + *, + parent: str = None, + os_policy_assignment: os_policy_assignments.OSPolicyAssignment = None, + os_policy_assignment_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""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 `__. + + Args: + request (:class:`google.cloud.osconfig_v1alpha.types.CreateOSPolicyAssignmentRequest`): + The request object. A request message to create an OS + policy assignment + parent (:class:`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 (:class:`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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any( + [parent, os_policy_assignment, os_policy_assignment_id] + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = os_policy_assignments.CreateOSPolicyAssignmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if os_policy_assignment is not None: + request.os_policy_assignment = os_policy_assignment + if os_policy_assignment_id is not None: + request.os_policy_assignment_id = os_policy_assignment_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_os_policy_assignment, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + os_policy_assignments.OSPolicyAssignment, + metadata_type=os_policy_assignments.OSPolicyAssignmentOperationMetadata, + ) + + # Done; return the response. + return response + + async def update_os_policy_assignment( + self, + request: os_policy_assignments.UpdateOSPolicyAssignmentRequest = None, + *, + os_policy_assignment: os_policy_assignments.OSPolicyAssignment = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""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 `__. + + Args: + request (:class:`google.cloud.osconfig_v1alpha.types.UpdateOSPolicyAssignmentRequest`): + The request object. A request message to update an OS + policy assignment + os_policy_assignment (:class:`google.cloud.osconfig_v1alpha.types.OSPolicyAssignment`): + Required. The updated OS policy + assignment. + + This corresponds to the ``os_policy_assignment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Optional. Field mask that controls + which fields of the assignment should be + updated. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([os_policy_assignment, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = os_policy_assignments.UpdateOSPolicyAssignmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if os_policy_assignment is not None: + request.os_policy_assignment = os_policy_assignment + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_os_policy_assignment, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("os_policy_assignment.name", request.os_policy_assignment.name),) + ), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + os_policy_assignments.OSPolicyAssignment, + metadata_type=os_policy_assignments.OSPolicyAssignmentOperationMetadata, + ) + + # Done; return the response. + return response + + async def get_os_policy_assignment( + self, + request: os_policy_assignments.GetOSPolicyAssignmentRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> os_policy_assignments.OSPolicyAssignment: + r"""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. + + Args: + request (:class:`google.cloud.osconfig_v1alpha.types.GetOSPolicyAssignmentRequest`): + The request object. A request message to get an OS + policy assignment + name (:class:`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: + 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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = os_policy_assignments.GetOSPolicyAssignmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_os_policy_assignment, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def list_os_policy_assignments( + self, + request: os_policy_assignments.ListOSPolicyAssignmentsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListOSPolicyAssignmentsAsyncPager: + r"""List the OS policy assignments under the parent + resource. + For each OS policy assignment, the latest revision is + returned. + + Args: + request (:class:`google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsRequest`): + The request object. A request message to list OS policy + assignments for a parent resource + parent (:class:`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: + google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentsAsyncPager: + A response message for listing all + assignments under given parent. + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = os_policy_assignments.ListOSPolicyAssignmentsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_os_policy_assignments, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListOSPolicyAssignmentsAsyncPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_os_policy_assignment_revisions( + self, + request: os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListOSPolicyAssignmentRevisionsAsyncPager: + r"""List the OS policy assignment revisions for a given + OS policy assignment. + + Args: + request (:class:`google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsRequest`): + The request object. A request message to list revisions + for a OS policy assignment + name (:class:`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: + google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListOSPolicyAssignmentRevisionsAsyncPager: + A response message for listing all + revisions for a OS policy assignment. + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_os_policy_assignment_revisions, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListOSPolicyAssignmentRevisionsAsyncPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_os_policy_assignment( + self, + request: os_policy_assignments.DeleteOSPolicyAssignmentRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""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 `__. + + Args: + request (:class:`google.cloud.osconfig_v1alpha.types.DeleteOSPolicyAssignmentRequest`): + The request object. A request message for deleting a OS + policy assignment. + name (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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 {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = os_policy_assignments.DeleteOSPolicyAssignmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_os_policy_assignment, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + empty_pb2.Empty, + metadata_type=os_policy_assignments.OSPolicyAssignmentOperationMetadata, + ) + + # Done; return the response. + return response + + async def get_instance_os_policies_compliance( + self, + request: instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> instance_os_policies_compliance.InstanceOSPoliciesCompliance: + r"""Get OS policies compliance data for the specified + Compute Engine VM instance. + + Args: + request (:class:`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 (:class:`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: + 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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest( + request + ) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_instance_os_policies_compliance, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def list_instance_os_policies_compliances( + self, + request: instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListInstanceOSPoliciesCompliancesAsyncPager: + r"""List OS policies compliance data for all Compute + Engine VM instances in the specified zone. + + Args: + request (:class:`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 (:class:`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: + google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInstanceOSPoliciesCompliancesAsyncPager: + 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. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest( + request + ) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_instance_os_policies_compliances, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListInstanceOSPoliciesCompliancesAsyncPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_inventory( + self, + request: inventory.GetInventoryRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> inventory.Inventory: + r"""Get inventory data for the specified VM instance. If the VM has + no associated inventory, the message ``NOT_FOUND`` is returned. + + Args: + request (:class:`google.cloud.osconfig_v1alpha.types.GetInventoryRequest`): + The request object. A request message for getting + inventory data for the specified VM. + name (:class:`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: + 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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = inventory.GetInventoryRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_inventory, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def list_inventories( + self, + request: inventory.ListInventoriesRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListInventoriesAsyncPager: + r"""List inventory data for all VM instances in the + specified zone. + + Args: + request (:class:`google.cloud.osconfig_v1alpha.types.ListInventoriesRequest`): + The request object. A request message for listing + inventory data for all VMs in the specified location. + parent (:class:`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: + google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListInventoriesAsyncPager: + 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. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = inventory.ListInventoriesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_inventories, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListInventoriesAsyncPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_vulnerability_report( + self, + request: vulnerability.GetVulnerabilityReportRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> vulnerability.VulnerabilityReport: + r"""Gets the vulnerability report for the specified VM + instance. Only VMs with inventory data have + vulnerability reports associated with them. + + Args: + request (:class:`google.cloud.osconfig_v1alpha.types.GetVulnerabilityReportRequest`): + The request object. A request message for getting the + vulnerability report for the specified VM. + name (:class:`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: + 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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = vulnerability.GetVulnerabilityReportRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_vulnerability_report, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def list_vulnerability_reports( + self, + request: vulnerability.ListVulnerabilityReportsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListVulnerabilityReportsAsyncPager: + r"""List vulnerability reports for all VM instances in + the specified zone. + + Args: + request (:class:`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 (:class:`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: + google.cloud.osconfig_v1alpha.services.os_config_zonal_service.pagers.ListVulnerabilityReportsAsyncPager: + 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. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = vulnerability.ListVulnerabilityReportsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_vulnerability_reports, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListVulnerabilityReportsAsyncPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution("google-cloud-os-config",).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ("OsConfigZonalServiceAsyncClient",) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/client.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/client.py new file mode 100644 index 000000000000..0075a02e9898 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/client.py @@ -0,0 +1,1611 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from distutils import util +import os +import re +from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.osconfig_v1alpha.services.os_config_zonal_service import pagers +from google.cloud.osconfig_v1alpha.types import config_common +from google.cloud.osconfig_v1alpha.types import instance_os_policies_compliance +from google.cloud.osconfig_v1alpha.types import inventory +from google.cloud.osconfig_v1alpha.types import os_policy +from google.cloud.osconfig_v1alpha.types import os_policy_assignments +from google.cloud.osconfig_v1alpha.types import vulnerability +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import OsConfigZonalServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import OsConfigZonalServiceGrpcTransport +from .transports.grpc_asyncio import OsConfigZonalServiceGrpcAsyncIOTransport + + +class OsConfigZonalServiceClientMeta(type): + """Metaclass for the OsConfigZonalService client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + + _transport_registry = ( + OrderedDict() + ) # type: Dict[str, Type[OsConfigZonalServiceTransport]] + _transport_registry["grpc"] = OsConfigZonalServiceGrpcTransport + _transport_registry["grpc_asyncio"] = OsConfigZonalServiceGrpcAsyncIOTransport + + def get_transport_class( + cls, label: str = None, + ) -> Type[OsConfigZonalServiceTransport]: + """Returns an appropriate transport class. + + Args: + 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. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class OsConfigZonalServiceClient(metaclass=OsConfigZonalServiceClientMeta): + """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. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "osconfig.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + 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: + OsConfigZonalServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + 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: + OsConfigZonalServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file(filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> OsConfigZonalServiceTransport: + """Returns the transport used by the client instance. + + Returns: + OsConfigZonalServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def instance_path(project: str, location: str, instance: str,) -> str: + """Returns a fully-qualified instance string.""" + return "projects/{project}/locations/{location}/instances/{instance}".format( + project=project, location=location, instance=instance, + ) + + @staticmethod + def parse_instance_path(path: str) -> Dict[str, str]: + """Parses a instance path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/instances/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def instance_os_policies_compliance_path( + project: str, location: str, instance: str, + ) -> str: + """Returns a fully-qualified instance_os_policies_compliance string.""" + return "projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}".format( + project=project, location=location, instance=instance, + ) + + @staticmethod + def parse_instance_os_policies_compliance_path(path: str) -> Dict[str, str]: + """Parses a instance_os_policies_compliance path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/instanceOSPoliciesCompliances/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def inventory_path(project: str, location: str, instance: str,) -> str: + """Returns a fully-qualified inventory string.""" + return "projects/{project}/locations/{location}/instances/{instance}/inventory".format( + project=project, location=location, instance=instance, + ) + + @staticmethod + def parse_inventory_path(path: str) -> Dict[str, str]: + """Parses a inventory path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/instances/(?P.+?)/inventory$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def os_policy_assignment_path( + project: str, location: str, os_policy_assignment: str, + ) -> str: + """Returns a fully-qualified os_policy_assignment string.""" + return "projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}".format( + project=project, + location=location, + os_policy_assignment=os_policy_assignment, + ) + + @staticmethod + def parse_os_policy_assignment_path(path: str) -> Dict[str, str]: + """Parses a os_policy_assignment path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/osPolicyAssignments/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def vulnerability_report_path(project: str, location: str, instance: str,) -> str: + """Returns a fully-qualified vulnerability_report string.""" + return "projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport".format( + project=project, location=location, instance=instance, + ) + + @staticmethod + def parse_vulnerability_report_path(path: str) -> Dict[str, str]: + """Parses a vulnerability_report path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/instances/(?P.+?)/vulnerabilityReport$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str,) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str, str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str,) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder,) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str, str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str,) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization,) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str, str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str,) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project,) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str, str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str,) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format( + project=project, location=location, + ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str, str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, OsConfigZonalServiceTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the os config zonal service client. + + Args: + 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. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool( + util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false")) + ) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " + "values: never, auto, always" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, OsConfigZonalServiceTransport): + # transport is a OsConfigZonalServiceTransport instance. + if credentials or client_options.credentials_file: + raise ValueError( + "When providing a transport instance, " + "provide its credentials directly." + ) + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + ) + + def create_os_policy_assignment( + self, + request: os_policy_assignments.CreateOSPolicyAssignmentRequest = None, + *, + parent: str = None, + os_policy_assignment: os_policy_assignments.OSPolicyAssignment = None, + os_policy_assignment_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""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 `__. + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any( + [parent, os_policy_assignment, os_policy_assignment_id] + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a os_policy_assignments.CreateOSPolicyAssignmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance( + request, os_policy_assignments.CreateOSPolicyAssignmentRequest + ): + request = os_policy_assignments.CreateOSPolicyAssignmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if os_policy_assignment is not None: + request.os_policy_assignment = os_policy_assignment + if os_policy_assignment_id is not None: + request.os_policy_assignment_id = os_policy_assignment_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.create_os_policy_assignment + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + os_policy_assignments.OSPolicyAssignment, + metadata_type=os_policy_assignments.OSPolicyAssignmentOperationMetadata, + ) + + # Done; return the response. + return response + + def update_os_policy_assignment( + self, + request: os_policy_assignments.UpdateOSPolicyAssignmentRequest = None, + *, + os_policy_assignment: os_policy_assignments.OSPolicyAssignment = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""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 `__. + + Args: + request (google.cloud.osconfig_v1alpha.types.UpdateOSPolicyAssignmentRequest): + 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 ``os_policy_assignment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. Field mask that controls + which fields of the assignment should be + updated. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([os_policy_assignment, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a os_policy_assignments.UpdateOSPolicyAssignmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance( + request, os_policy_assignments.UpdateOSPolicyAssignmentRequest + ): + request = os_policy_assignments.UpdateOSPolicyAssignmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if os_policy_assignment is not None: + request.os_policy_assignment = os_policy_assignment + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.update_os_policy_assignment + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("os_policy_assignment.name", request.os_policy_assignment.name),) + ), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + os_policy_assignments.OSPolicyAssignment, + metadata_type=os_policy_assignments.OSPolicyAssignmentOperationMetadata, + ) + + # Done; return the response. + return response + + def get_os_policy_assignment( + self, + request: os_policy_assignments.GetOSPolicyAssignmentRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> os_policy_assignments.OSPolicyAssignment: + r"""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. + + Args: + 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: + 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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a os_policy_assignments.GetOSPolicyAssignmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, os_policy_assignments.GetOSPolicyAssignmentRequest): + request = os_policy_assignments.GetOSPolicyAssignmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_os_policy_assignment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def list_os_policy_assignments( + self, + request: os_policy_assignments.ListOSPolicyAssignmentsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListOSPolicyAssignmentsPager: + r"""List the OS policy assignments under the parent + resource. + For each OS policy assignment, the latest revision is + returned. + + Args: + 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: + 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. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a os_policy_assignments.ListOSPolicyAssignmentsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance( + request, os_policy_assignments.ListOSPolicyAssignmentsRequest + ): + request = os_policy_assignments.ListOSPolicyAssignmentsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.list_os_policy_assignments + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListOSPolicyAssignmentsPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + def list_os_policy_assignment_revisions( + self, + request: os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListOSPolicyAssignmentRevisionsPager: + r"""List the OS policy assignment revisions for a given + OS policy assignment. + + Args: + 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: + 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. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance( + request, os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest + ): + request = os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest( + request + ) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.list_os_policy_assignment_revisions + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListOSPolicyAssignmentRevisionsPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_os_policy_assignment( + self, + request: os_policy_assignments.DeleteOSPolicyAssignmentRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""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 `__. + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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 {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a os_policy_assignments.DeleteOSPolicyAssignmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance( + request, os_policy_assignments.DeleteOSPolicyAssignmentRequest + ): + request = os_policy_assignments.DeleteOSPolicyAssignmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.delete_os_policy_assignment + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + empty_pb2.Empty, + metadata_type=os_policy_assignments.OSPolicyAssignmentOperationMetadata, + ) + + # Done; return the response. + return response + + def get_instance_os_policies_compliance( + self, + request: instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> instance_os_policies_compliance.InstanceOSPoliciesCompliance: + r"""Get OS policies compliance data for the specified + Compute Engine VM instance. + + Args: + 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: + 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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance( + request, + instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest, + ): + request = instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest( + request + ) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.get_instance_os_policies_compliance + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def list_instance_os_policies_compliances( + self, + request: instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListInstanceOSPoliciesCompliancesPager: + r"""List OS policies compliance data for all Compute + Engine VM instances in the specified zone. + + Args: + 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: + 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. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance( + request, + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest, + ): + request = instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest( + request + ) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.list_instance_os_policies_compliances + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListInstanceOSPoliciesCompliancesPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + def get_inventory( + self, + request: inventory.GetInventoryRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> inventory.Inventory: + r"""Get inventory data for the specified VM instance. If the VM has + no associated inventory, the message ``NOT_FOUND`` is returned. + + Args: + 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: + 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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a inventory.GetInventoryRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, inventory.GetInventoryRequest): + request = inventory.GetInventoryRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_inventory] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def list_inventories( + self, + request: inventory.ListInventoriesRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListInventoriesPager: + r"""List inventory data for all VM instances in the + specified zone. + + Args: + 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: + 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. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a inventory.ListInventoriesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, inventory.ListInventoriesRequest): + request = inventory.ListInventoriesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_inventories] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListInventoriesPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + def get_vulnerability_report( + self, + request: vulnerability.GetVulnerabilityReportRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> vulnerability.VulnerabilityReport: + r"""Gets the vulnerability report for the specified VM + instance. Only VMs with inventory data have + vulnerability reports associated with them. + + Args: + 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: + 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). + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a vulnerability.GetVulnerabilityReportRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, vulnerability.GetVulnerabilityReportRequest): + request = vulnerability.GetVulnerabilityReportRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_vulnerability_report] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def list_vulnerability_reports( + self, + request: vulnerability.ListVulnerabilityReportsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListVulnerabilityReportsPager: + r"""List vulnerability reports for all VM instances in + the specified zone. + + Args: + 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: + 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. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a vulnerability.ListVulnerabilityReportsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, vulnerability.ListVulnerabilityReportsRequest): + request = vulnerability.ListVulnerabilityReportsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.list_vulnerability_reports + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListVulnerabilityReportsPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution("google-cloud-os-config",).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ("OsConfigZonalServiceClient",) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/pagers.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/pagers.py new file mode 100644 index 000000000000..c4febb073981 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/pagers.py @@ -0,0 +1,715 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import ( + Any, + AsyncIterable, + Awaitable, + Callable, + Iterable, + Sequence, + Tuple, + Optional, +) + +from google.cloud.osconfig_v1alpha.types import instance_os_policies_compliance +from google.cloud.osconfig_v1alpha.types import inventory +from google.cloud.osconfig_v1alpha.types import os_policy_assignments +from google.cloud.osconfig_v1alpha.types import vulnerability + + +class ListOSPolicyAssignmentsPager: + """A pager for iterating through ``list_os_policy_assignments`` requests. + + This class thinly wraps an initial + :class:`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 :class:`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. + """ + + def __init__( + self, + method: Callable[..., os_policy_assignments.ListOSPolicyAssignmentsResponse], + request: os_policy_assignments.ListOSPolicyAssignmentsRequest, + response: os_policy_assignments.ListOSPolicyAssignmentsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsRequest): + The initial request object. + response (google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = os_policy_assignments.ListOSPolicyAssignmentsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[os_policy_assignments.ListOSPolicyAssignmentsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterable[os_policy_assignments.OSPolicyAssignment]: + for page in self.pages: + yield from page.os_policy_assignments + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListOSPolicyAssignmentsAsyncPager: + """A pager for iterating through ``list_os_policy_assignments`` requests. + + This class thinly wraps an initial + :class:`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 :class:`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. + """ + + def __init__( + self, + method: Callable[ + ..., Awaitable[os_policy_assignments.ListOSPolicyAssignmentsResponse] + ], + request: os_policy_assignments.ListOSPolicyAssignmentsRequest, + response: os_policy_assignments.ListOSPolicyAssignmentsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsRequest): + The initial request object. + response (google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = os_policy_assignments.ListOSPolicyAssignmentsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages( + self, + ) -> AsyncIterable[os_policy_assignments.ListOSPolicyAssignmentsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterable[os_policy_assignments.OSPolicyAssignment]: + async def async_generator(): + async for page in self.pages: + for response in page.os_policy_assignments: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListOSPolicyAssignmentRevisionsPager: + """A pager for iterating through ``list_os_policy_assignment_revisions`` requests. + + This class thinly wraps an initial + :class:`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 :class:`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. + """ + + def __init__( + self, + method: Callable[ + ..., os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse + ], + request: os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest, + response: os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsRequest): + The initial request object. + response (google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest( + request + ) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages( + self, + ) -> Iterable[os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterable[os_policy_assignments.OSPolicyAssignment]: + for page in self.pages: + yield from page.os_policy_assignments + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListOSPolicyAssignmentRevisionsAsyncPager: + """A pager for iterating through ``list_os_policy_assignment_revisions`` requests. + + This class thinly wraps an initial + :class:`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 :class:`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. + """ + + def __init__( + self, + method: Callable[ + ..., + Awaitable[os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse], + ], + request: os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest, + response: os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsRequest): + The initial request object. + response (google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest( + request + ) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages( + self, + ) -> AsyncIterable[os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterable[os_policy_assignments.OSPolicyAssignment]: + async def async_generator(): + async for page in self.pages: + for response in page.os_policy_assignments: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListInstanceOSPoliciesCompliancesPager: + """A pager for iterating through ``list_instance_os_policies_compliances`` requests. + + This class thinly wraps an initial + :class:`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 :class:`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. + """ + + def __init__( + self, + method: Callable[ + ..., + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse, + ], + request: instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest, + response: instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.osconfig_v1alpha.types.ListInstanceOSPoliciesCompliancesRequest): + The initial request object. + response (google.cloud.osconfig_v1alpha.types.ListInstanceOSPoliciesCompliancesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest( + request + ) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages( + self, + ) -> Iterable[ + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse + ]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__( + self, + ) -> Iterable[instance_os_policies_compliance.InstanceOSPoliciesCompliance]: + for page in self.pages: + yield from page.instance_os_policies_compliances + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListInstanceOSPoliciesCompliancesAsyncPager: + """A pager for iterating through ``list_instance_os_policies_compliances`` requests. + + This class thinly wraps an initial + :class:`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 :class:`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. + """ + + def __init__( + self, + method: Callable[ + ..., + Awaitable[ + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse + ], + ], + request: instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest, + response: instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.osconfig_v1alpha.types.ListInstanceOSPoliciesCompliancesRequest): + The initial request object. + response (google.cloud.osconfig_v1alpha.types.ListInstanceOSPoliciesCompliancesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest( + request + ) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages( + self, + ) -> AsyncIterable[ + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse + ]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__( + self, + ) -> AsyncIterable[instance_os_policies_compliance.InstanceOSPoliciesCompliance]: + async def async_generator(): + async for page in self.pages: + for response in page.instance_os_policies_compliances: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListInventoriesPager: + """A pager for iterating through ``list_inventories`` requests. + + This class thinly wraps an initial + :class:`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 :class:`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. + """ + + def __init__( + self, + method: Callable[..., inventory.ListInventoriesResponse], + request: inventory.ListInventoriesRequest, + response: inventory.ListInventoriesResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.osconfig_v1alpha.types.ListInventoriesRequest): + The initial request object. + response (google.cloud.osconfig_v1alpha.types.ListInventoriesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = inventory.ListInventoriesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[inventory.ListInventoriesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterable[inventory.Inventory]: + for page in self.pages: + yield from page.inventories + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListInventoriesAsyncPager: + """A pager for iterating through ``list_inventories`` requests. + + This class thinly wraps an initial + :class:`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 :class:`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. + """ + + def __init__( + self, + method: Callable[..., Awaitable[inventory.ListInventoriesResponse]], + request: inventory.ListInventoriesRequest, + response: inventory.ListInventoriesResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.osconfig_v1alpha.types.ListInventoriesRequest): + The initial request object. + response (google.cloud.osconfig_v1alpha.types.ListInventoriesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = inventory.ListInventoriesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[inventory.ListInventoriesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterable[inventory.Inventory]: + async def async_generator(): + async for page in self.pages: + for response in page.inventories: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListVulnerabilityReportsPager: + """A pager for iterating through ``list_vulnerability_reports`` requests. + + This class thinly wraps an initial + :class:`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 :class:`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. + """ + + def __init__( + self, + method: Callable[..., vulnerability.ListVulnerabilityReportsResponse], + request: vulnerability.ListVulnerabilityReportsRequest, + response: vulnerability.ListVulnerabilityReportsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsRequest): + The initial request object. + response (google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = vulnerability.ListVulnerabilityReportsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[vulnerability.ListVulnerabilityReportsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterable[vulnerability.VulnerabilityReport]: + for page in self.pages: + yield from page.vulnerability_reports + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListVulnerabilityReportsAsyncPager: + """A pager for iterating through ``list_vulnerability_reports`` requests. + + This class thinly wraps an initial + :class:`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 :class:`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. + """ + + def __init__( + self, + method: Callable[ + ..., Awaitable[vulnerability.ListVulnerabilityReportsResponse] + ], + request: vulnerability.ListVulnerabilityReportsRequest, + response: vulnerability.ListVulnerabilityReportsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsRequest): + The initial request object. + response (google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = vulnerability.ListVulnerabilityReportsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages( + self, + ) -> AsyncIterable[vulnerability.ListVulnerabilityReportsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterable[vulnerability.VulnerabilityReport]: + async def async_generator(): + async for page in self.pages: + for response in page.vulnerability_reports: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/__init__.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/__init__.py new file mode 100644 index 000000000000..c070e43930b9 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/__init__.py @@ -0,0 +1,35 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import OsConfigZonalServiceTransport +from .grpc import OsConfigZonalServiceGrpcTransport +from .grpc_asyncio import OsConfigZonalServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = ( + OrderedDict() +) # type: Dict[str, Type[OsConfigZonalServiceTransport]] +_transport_registry["grpc"] = OsConfigZonalServiceGrpcTransport +_transport_registry["grpc_asyncio"] = OsConfigZonalServiceGrpcAsyncIOTransport + +__all__ = ( + "OsConfigZonalServiceTransport", + "OsConfigZonalServiceGrpcTransport", + "OsConfigZonalServiceGrpcAsyncIOTransport", +) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/base.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/base.py new file mode 100644 index 000000000000..b5aaf8b42f7d --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/base.py @@ -0,0 +1,370 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import packaging.version +import pkg_resources + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.auth import credentials as ga_credentials # type: ignore + +from google.cloud.osconfig_v1alpha.types import instance_os_policies_compliance +from google.cloud.osconfig_v1alpha.types import inventory +from google.cloud.osconfig_v1alpha.types import os_policy_assignments +from google.cloud.osconfig_v1alpha.types import vulnerability +from google.longrunning import operations_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution("google-cloud-os-config",).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = google.auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + +_API_CORE_VERSION = google.api_core.__version__ + + +class OsConfigZonalServiceTransport(abc.ABC): + """Abstract transport class for OsConfigZonalService.""" + + AUTH_SCOPES = ("https://www.googleapis.com/auth/cloud-platform",) + + DEFAULT_HOST: str = "osconfig.googleapis.com" + + def __init__( + self, + *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + 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. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + 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. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ":" not in host: + host += ":443" + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes or self.AUTH_SCOPES + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs( + "'credentials_file' and 'credentials' are mutually exclusive" + ) + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, **scopes_kwargs, quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = google.auth.default( + **scopes_kwargs, quota_project_id=quota_project_id + ) + + # Save the credentials. + self._credentials = credentials + + # TODO(busunkim): These two class methods are in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-api-core + # and google-auth are increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs( + cls, host: str, scopes: Optional[Sequence[str]] + ) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + # TODO: Remove this function once google-api-core >= 1.26.0 is required + @classmethod + def _get_self_signed_jwt_kwargs( + cls, host: str, scopes: Optional[Sequence[str]] + ) -> Dict[str, Union[Optional[Sequence[str]], str]]: + """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version""" + + self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {} + + if _API_CORE_VERSION and ( + packaging.version.parse(_API_CORE_VERSION) + >= packaging.version.parse("1.26.0") + ): + self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES + self_signed_jwt_kwargs["scopes"] = scopes + self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST + else: + self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES + + return self_signed_jwt_kwargs + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_os_policy_assignment: gapic_v1.method.wrap_method( + self.create_os_policy_assignment, + default_timeout=None, + client_info=client_info, + ), + self.update_os_policy_assignment: gapic_v1.method.wrap_method( + self.update_os_policy_assignment, + default_timeout=None, + client_info=client_info, + ), + self.get_os_policy_assignment: gapic_v1.method.wrap_method( + self.get_os_policy_assignment, + default_timeout=None, + client_info=client_info, + ), + self.list_os_policy_assignments: gapic_v1.method.wrap_method( + self.list_os_policy_assignments, + default_timeout=None, + client_info=client_info, + ), + self.list_os_policy_assignment_revisions: gapic_v1.method.wrap_method( + self.list_os_policy_assignment_revisions, + default_timeout=None, + client_info=client_info, + ), + self.delete_os_policy_assignment: gapic_v1.method.wrap_method( + self.delete_os_policy_assignment, + default_timeout=None, + client_info=client_info, + ), + self.get_instance_os_policies_compliance: gapic_v1.method.wrap_method( + self.get_instance_os_policies_compliance, + default_timeout=None, + client_info=client_info, + ), + self.list_instance_os_policies_compliances: gapic_v1.method.wrap_method( + self.list_instance_os_policies_compliances, + default_timeout=None, + client_info=client_info, + ), + self.get_inventory: gapic_v1.method.wrap_method( + self.get_inventory, default_timeout=None, client_info=client_info, + ), + self.list_inventories: gapic_v1.method.wrap_method( + self.list_inventories, default_timeout=None, client_info=client_info, + ), + self.get_vulnerability_report: gapic_v1.method.wrap_method( + self.get_vulnerability_report, + default_timeout=None, + client_info=client_info, + ), + self.list_vulnerability_reports: gapic_v1.method.wrap_method( + self.list_vulnerability_reports, + default_timeout=None, + client_info=client_info, + ), + } + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def create_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.CreateOSPolicyAssignmentRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def update_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.UpdateOSPolicyAssignmentRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def get_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.GetOSPolicyAssignmentRequest], + Union[ + os_policy_assignments.OSPolicyAssignment, + Awaitable[os_policy_assignments.OSPolicyAssignment], + ], + ]: + raise NotImplementedError() + + @property + def list_os_policy_assignments( + self, + ) -> Callable[ + [os_policy_assignments.ListOSPolicyAssignmentsRequest], + Union[ + os_policy_assignments.ListOSPolicyAssignmentsResponse, + Awaitable[os_policy_assignments.ListOSPolicyAssignmentsResponse], + ], + ]: + raise NotImplementedError() + + @property + def list_os_policy_assignment_revisions( + self, + ) -> Callable[ + [os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest], + Union[ + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse, + Awaitable[os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse], + ], + ]: + raise NotImplementedError() + + @property + def delete_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.DeleteOSPolicyAssignmentRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def get_instance_os_policies_compliance( + self, + ) -> Callable[ + [instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest], + Union[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance, + Awaitable[instance_os_policies_compliance.InstanceOSPoliciesCompliance], + ], + ]: + raise NotImplementedError() + + @property + def list_instance_os_policies_compliances( + self, + ) -> Callable[ + [instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest], + Union[ + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse, + Awaitable[ + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse + ], + ], + ]: + raise NotImplementedError() + + @property + def get_inventory( + self, + ) -> Callable[ + [inventory.GetInventoryRequest], + Union[inventory.Inventory, Awaitable[inventory.Inventory]], + ]: + raise NotImplementedError() + + @property + def list_inventories( + self, + ) -> Callable[ + [inventory.ListInventoriesRequest], + Union[ + inventory.ListInventoriesResponse, + Awaitable[inventory.ListInventoriesResponse], + ], + ]: + raise NotImplementedError() + + @property + def get_vulnerability_report( + self, + ) -> Callable[ + [vulnerability.GetVulnerabilityReportRequest], + Union[ + vulnerability.VulnerabilityReport, + Awaitable[vulnerability.VulnerabilityReport], + ], + ]: + raise NotImplementedError() + + @property + def list_vulnerability_reports( + self, + ) -> Callable[ + [vulnerability.ListVulnerabilityReportsRequest], + Union[ + vulnerability.ListVulnerabilityReportsResponse, + Awaitable[vulnerability.ListVulnerabilityReportsResponse], + ], + ]: + raise NotImplementedError() + + +__all__ = ("OsConfigZonalServiceTransport",) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/grpc.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/grpc.py new file mode 100644 index 000000000000..fdb18a0b6eef --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/grpc.py @@ -0,0 +1,646 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.api_core import gapic_v1 # type: ignore +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.osconfig_v1alpha.types import instance_os_policies_compliance +from google.cloud.osconfig_v1alpha.types import inventory +from google.cloud.osconfig_v1alpha.types import os_policy_assignments +from google.cloud.osconfig_v1alpha.types import vulnerability +from google.longrunning import operations_pb2 # type: ignore +from .base import OsConfigZonalServiceTransport, DEFAULT_CLIENT_INFO + + +class OsConfigZonalServiceGrpcTransport(OsConfigZonalServiceTransport): + """gRPC backend transport for OsConfigZonalService. + + 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. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _stubs: Dict[str, Callable] + + def __init__( + self, + *, + host: str = "osconfig.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + 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. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + 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. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel( + cls, + host: str = "osconfig.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + **self_signed_jwt_kwargs, + **kwargs, + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Sanity check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient(self.grpc_channel) + + # Return the client from cache. + return self._operations_client + + @property + def create_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.CreateOSPolicyAssignmentRequest], + operations_pb2.Operation, + ]: + r"""Return a callable for the create os policy assignment method over gRPC. + + 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 `__. + + Returns: + Callable[[~.CreateOSPolicyAssignmentRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_os_policy_assignment" not in self._stubs: + self._stubs["create_os_policy_assignment"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/CreateOSPolicyAssignment", + request_serializer=os_policy_assignments.CreateOSPolicyAssignmentRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_os_policy_assignment"] + + @property + def update_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.UpdateOSPolicyAssignmentRequest], + operations_pb2.Operation, + ]: + r"""Return a callable for the update os policy assignment method over gRPC. + + 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 `__. + + Returns: + Callable[[~.UpdateOSPolicyAssignmentRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_os_policy_assignment" not in self._stubs: + self._stubs["update_os_policy_assignment"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/UpdateOSPolicyAssignment", + request_serializer=os_policy_assignments.UpdateOSPolicyAssignmentRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_os_policy_assignment"] + + @property + def get_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.GetOSPolicyAssignmentRequest], + os_policy_assignments.OSPolicyAssignment, + ]: + r"""Return a callable for the get os policy assignment method over gRPC. + + 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. + + Returns: + Callable[[~.GetOSPolicyAssignmentRequest], + ~.OSPolicyAssignment]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_os_policy_assignment" not in self._stubs: + self._stubs["get_os_policy_assignment"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/GetOSPolicyAssignment", + request_serializer=os_policy_assignments.GetOSPolicyAssignmentRequest.serialize, + response_deserializer=os_policy_assignments.OSPolicyAssignment.deserialize, + ) + return self._stubs["get_os_policy_assignment"] + + @property + def list_os_policy_assignments( + self, + ) -> Callable[ + [os_policy_assignments.ListOSPolicyAssignmentsRequest], + os_policy_assignments.ListOSPolicyAssignmentsResponse, + ]: + r"""Return a callable for the list os policy assignments method over gRPC. + + List the OS policy assignments under the parent + resource. + For each OS policy assignment, the latest revision is + returned. + + Returns: + Callable[[~.ListOSPolicyAssignmentsRequest], + ~.ListOSPolicyAssignmentsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_os_policy_assignments" not in self._stubs: + self._stubs["list_os_policy_assignments"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/ListOSPolicyAssignments", + request_serializer=os_policy_assignments.ListOSPolicyAssignmentsRequest.serialize, + response_deserializer=os_policy_assignments.ListOSPolicyAssignmentsResponse.deserialize, + ) + return self._stubs["list_os_policy_assignments"] + + @property + def list_os_policy_assignment_revisions( + self, + ) -> Callable[ + [os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest], + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse, + ]: + r"""Return a callable for the list os policy assignment + revisions method over gRPC. + + List the OS policy assignment revisions for a given + OS policy assignment. + + Returns: + Callable[[~.ListOSPolicyAssignmentRevisionsRequest], + ~.ListOSPolicyAssignmentRevisionsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_os_policy_assignment_revisions" not in self._stubs: + self._stubs[ + "list_os_policy_assignment_revisions" + ] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/ListOSPolicyAssignmentRevisions", + request_serializer=os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest.serialize, + response_deserializer=os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse.deserialize, + ) + return self._stubs["list_os_policy_assignment_revisions"] + + @property + def delete_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.DeleteOSPolicyAssignmentRequest], + operations_pb2.Operation, + ]: + r"""Return a callable for the delete os policy assignment method over gRPC. + + 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 `__. + + Returns: + Callable[[~.DeleteOSPolicyAssignmentRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_os_policy_assignment" not in self._stubs: + self._stubs["delete_os_policy_assignment"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/DeleteOSPolicyAssignment", + request_serializer=os_policy_assignments.DeleteOSPolicyAssignmentRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_os_policy_assignment"] + + @property + def get_instance_os_policies_compliance( + self, + ) -> Callable[ + [instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest], + instance_os_policies_compliance.InstanceOSPoliciesCompliance, + ]: + r"""Return a callable for the get instance os policies + compliance method over gRPC. + + Get OS policies compliance data for the specified + Compute Engine VM instance. + + Returns: + Callable[[~.GetInstanceOSPoliciesComplianceRequest], + ~.InstanceOSPoliciesCompliance]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_instance_os_policies_compliance" not in self._stubs: + self._stubs[ + "get_instance_os_policies_compliance" + ] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/GetInstanceOSPoliciesCompliance", + request_serializer=instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest.serialize, + response_deserializer=instance_os_policies_compliance.InstanceOSPoliciesCompliance.deserialize, + ) + return self._stubs["get_instance_os_policies_compliance"] + + @property + def list_instance_os_policies_compliances( + self, + ) -> Callable[ + [instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest], + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse, + ]: + r"""Return a callable for the list instance os policies + compliances method over gRPC. + + List OS policies compliance data for all Compute + Engine VM instances in the specified zone. + + Returns: + Callable[[~.ListInstanceOSPoliciesCompliancesRequest], + ~.ListInstanceOSPoliciesCompliancesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_instance_os_policies_compliances" not in self._stubs: + self._stubs[ + "list_instance_os_policies_compliances" + ] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/ListInstanceOSPoliciesCompliances", + request_serializer=instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest.serialize, + response_deserializer=instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse.deserialize, + ) + return self._stubs["list_instance_os_policies_compliances"] + + @property + def get_inventory( + self, + ) -> Callable[[inventory.GetInventoryRequest], inventory.Inventory]: + r"""Return a callable for the get inventory method over gRPC. + + Get inventory data for the specified VM instance. If the VM has + no associated inventory, the message ``NOT_FOUND`` is returned. + + Returns: + Callable[[~.GetInventoryRequest], + ~.Inventory]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_inventory" not in self._stubs: + self._stubs["get_inventory"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/GetInventory", + request_serializer=inventory.GetInventoryRequest.serialize, + response_deserializer=inventory.Inventory.deserialize, + ) + return self._stubs["get_inventory"] + + @property + def list_inventories( + self, + ) -> Callable[ + [inventory.ListInventoriesRequest], inventory.ListInventoriesResponse + ]: + r"""Return a callable for the list inventories method over gRPC. + + List inventory data for all VM instances in the + specified zone. + + Returns: + Callable[[~.ListInventoriesRequest], + ~.ListInventoriesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_inventories" not in self._stubs: + self._stubs["list_inventories"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/ListInventories", + request_serializer=inventory.ListInventoriesRequest.serialize, + response_deserializer=inventory.ListInventoriesResponse.deserialize, + ) + return self._stubs["list_inventories"] + + @property + def get_vulnerability_report( + self, + ) -> Callable[ + [vulnerability.GetVulnerabilityReportRequest], vulnerability.VulnerabilityReport + ]: + r"""Return a callable for the get vulnerability report method over gRPC. + + Gets the vulnerability report for the specified VM + instance. Only VMs with inventory data have + vulnerability reports associated with them. + + Returns: + Callable[[~.GetVulnerabilityReportRequest], + ~.VulnerabilityReport]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_vulnerability_report" not in self._stubs: + self._stubs["get_vulnerability_report"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/GetVulnerabilityReport", + request_serializer=vulnerability.GetVulnerabilityReportRequest.serialize, + response_deserializer=vulnerability.VulnerabilityReport.deserialize, + ) + return self._stubs["get_vulnerability_report"] + + @property + def list_vulnerability_reports( + self, + ) -> Callable[ + [vulnerability.ListVulnerabilityReportsRequest], + vulnerability.ListVulnerabilityReportsResponse, + ]: + r"""Return a callable for the list vulnerability reports method over gRPC. + + List vulnerability reports for all VM instances in + the specified zone. + + Returns: + Callable[[~.ListVulnerabilityReportsRequest], + ~.ListVulnerabilityReportsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_vulnerability_reports" not in self._stubs: + self._stubs["list_vulnerability_reports"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/ListVulnerabilityReports", + request_serializer=vulnerability.ListVulnerabilityReportsRequest.serialize, + response_deserializer=vulnerability.ListVulnerabilityReportsResponse.deserialize, + ) + return self._stubs["list_vulnerability_reports"] + + +__all__ = ("OsConfigZonalServiceGrpcTransport",) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/grpc_asyncio.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/grpc_asyncio.py new file mode 100644 index 000000000000..ee090cf20f9c --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/grpc_asyncio.py @@ -0,0 +1,654 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.osconfig_v1alpha.types import instance_os_policies_compliance +from google.cloud.osconfig_v1alpha.types import inventory +from google.cloud.osconfig_v1alpha.types import os_policy_assignments +from google.cloud.osconfig_v1alpha.types import vulnerability +from google.longrunning import operations_pb2 # type: ignore +from .base import OsConfigZonalServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import OsConfigZonalServiceGrpcTransport + + +class OsConfigZonalServiceGrpcAsyncIOTransport(OsConfigZonalServiceTransport): + """gRPC AsyncIO backend transport for OsConfigZonalService. + + 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. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel( + cls, + host: str = "osconfig.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + **self_signed_jwt_kwargs, + **kwargs, + ) + + def __init__( + self, + *, + host: str = "osconfig.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + 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. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + 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. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Sanity check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def create_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.CreateOSPolicyAssignmentRequest], + Awaitable[operations_pb2.Operation], + ]: + r"""Return a callable for the create os policy assignment method over gRPC. + + 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 `__. + + Returns: + Callable[[~.CreateOSPolicyAssignmentRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_os_policy_assignment" not in self._stubs: + self._stubs["create_os_policy_assignment"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/CreateOSPolicyAssignment", + request_serializer=os_policy_assignments.CreateOSPolicyAssignmentRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_os_policy_assignment"] + + @property + def update_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.UpdateOSPolicyAssignmentRequest], + Awaitable[operations_pb2.Operation], + ]: + r"""Return a callable for the update os policy assignment method over gRPC. + + 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 `__. + + Returns: + Callable[[~.UpdateOSPolicyAssignmentRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_os_policy_assignment" not in self._stubs: + self._stubs["update_os_policy_assignment"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/UpdateOSPolicyAssignment", + request_serializer=os_policy_assignments.UpdateOSPolicyAssignmentRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_os_policy_assignment"] + + @property + def get_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.GetOSPolicyAssignmentRequest], + Awaitable[os_policy_assignments.OSPolicyAssignment], + ]: + r"""Return a callable for the get os policy assignment method over gRPC. + + 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. + + Returns: + Callable[[~.GetOSPolicyAssignmentRequest], + Awaitable[~.OSPolicyAssignment]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_os_policy_assignment" not in self._stubs: + self._stubs["get_os_policy_assignment"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/GetOSPolicyAssignment", + request_serializer=os_policy_assignments.GetOSPolicyAssignmentRequest.serialize, + response_deserializer=os_policy_assignments.OSPolicyAssignment.deserialize, + ) + return self._stubs["get_os_policy_assignment"] + + @property + def list_os_policy_assignments( + self, + ) -> Callable[ + [os_policy_assignments.ListOSPolicyAssignmentsRequest], + Awaitable[os_policy_assignments.ListOSPolicyAssignmentsResponse], + ]: + r"""Return a callable for the list os policy assignments method over gRPC. + + List the OS policy assignments under the parent + resource. + For each OS policy assignment, the latest revision is + returned. + + Returns: + Callable[[~.ListOSPolicyAssignmentsRequest], + Awaitable[~.ListOSPolicyAssignmentsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_os_policy_assignments" not in self._stubs: + self._stubs["list_os_policy_assignments"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/ListOSPolicyAssignments", + request_serializer=os_policy_assignments.ListOSPolicyAssignmentsRequest.serialize, + response_deserializer=os_policy_assignments.ListOSPolicyAssignmentsResponse.deserialize, + ) + return self._stubs["list_os_policy_assignments"] + + @property + def list_os_policy_assignment_revisions( + self, + ) -> Callable[ + [os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest], + Awaitable[os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse], + ]: + r"""Return a callable for the list os policy assignment + revisions method over gRPC. + + List the OS policy assignment revisions for a given + OS policy assignment. + + Returns: + Callable[[~.ListOSPolicyAssignmentRevisionsRequest], + Awaitable[~.ListOSPolicyAssignmentRevisionsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_os_policy_assignment_revisions" not in self._stubs: + self._stubs[ + "list_os_policy_assignment_revisions" + ] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/ListOSPolicyAssignmentRevisions", + request_serializer=os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest.serialize, + response_deserializer=os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse.deserialize, + ) + return self._stubs["list_os_policy_assignment_revisions"] + + @property + def delete_os_policy_assignment( + self, + ) -> Callable[ + [os_policy_assignments.DeleteOSPolicyAssignmentRequest], + Awaitable[operations_pb2.Operation], + ]: + r"""Return a callable for the delete os policy assignment method over gRPC. + + 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 `__. + + Returns: + Callable[[~.DeleteOSPolicyAssignmentRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_os_policy_assignment" not in self._stubs: + self._stubs["delete_os_policy_assignment"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/DeleteOSPolicyAssignment", + request_serializer=os_policy_assignments.DeleteOSPolicyAssignmentRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_os_policy_assignment"] + + @property + def get_instance_os_policies_compliance( + self, + ) -> Callable[ + [instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest], + Awaitable[instance_os_policies_compliance.InstanceOSPoliciesCompliance], + ]: + r"""Return a callable for the get instance os policies + compliance method over gRPC. + + Get OS policies compliance data for the specified + Compute Engine VM instance. + + Returns: + Callable[[~.GetInstanceOSPoliciesComplianceRequest], + Awaitable[~.InstanceOSPoliciesCompliance]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_instance_os_policies_compliance" not in self._stubs: + self._stubs[ + "get_instance_os_policies_compliance" + ] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/GetInstanceOSPoliciesCompliance", + request_serializer=instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest.serialize, + response_deserializer=instance_os_policies_compliance.InstanceOSPoliciesCompliance.deserialize, + ) + return self._stubs["get_instance_os_policies_compliance"] + + @property + def list_instance_os_policies_compliances( + self, + ) -> Callable[ + [instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest], + Awaitable[ + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse + ], + ]: + r"""Return a callable for the list instance os policies + compliances method over gRPC. + + List OS policies compliance data for all Compute + Engine VM instances in the specified zone. + + Returns: + Callable[[~.ListInstanceOSPoliciesCompliancesRequest], + Awaitable[~.ListInstanceOSPoliciesCompliancesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_instance_os_policies_compliances" not in self._stubs: + self._stubs[ + "list_instance_os_policies_compliances" + ] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/ListInstanceOSPoliciesCompliances", + request_serializer=instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest.serialize, + response_deserializer=instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse.deserialize, + ) + return self._stubs["list_instance_os_policies_compliances"] + + @property + def get_inventory( + self, + ) -> Callable[[inventory.GetInventoryRequest], Awaitable[inventory.Inventory]]: + r"""Return a callable for the get inventory method over gRPC. + + Get inventory data for the specified VM instance. If the VM has + no associated inventory, the message ``NOT_FOUND`` is returned. + + Returns: + Callable[[~.GetInventoryRequest], + Awaitable[~.Inventory]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_inventory" not in self._stubs: + self._stubs["get_inventory"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/GetInventory", + request_serializer=inventory.GetInventoryRequest.serialize, + response_deserializer=inventory.Inventory.deserialize, + ) + return self._stubs["get_inventory"] + + @property + def list_inventories( + self, + ) -> Callable[ + [inventory.ListInventoriesRequest], Awaitable[inventory.ListInventoriesResponse] + ]: + r"""Return a callable for the list inventories method over gRPC. + + List inventory data for all VM instances in the + specified zone. + + Returns: + Callable[[~.ListInventoriesRequest], + Awaitable[~.ListInventoriesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_inventories" not in self._stubs: + self._stubs["list_inventories"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/ListInventories", + request_serializer=inventory.ListInventoriesRequest.serialize, + response_deserializer=inventory.ListInventoriesResponse.deserialize, + ) + return self._stubs["list_inventories"] + + @property + def get_vulnerability_report( + self, + ) -> Callable[ + [vulnerability.GetVulnerabilityReportRequest], + Awaitable[vulnerability.VulnerabilityReport], + ]: + r"""Return a callable for the get vulnerability report method over gRPC. + + Gets the vulnerability report for the specified VM + instance. Only VMs with inventory data have + vulnerability reports associated with them. + + Returns: + Callable[[~.GetVulnerabilityReportRequest], + Awaitable[~.VulnerabilityReport]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_vulnerability_report" not in self._stubs: + self._stubs["get_vulnerability_report"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/GetVulnerabilityReport", + request_serializer=vulnerability.GetVulnerabilityReportRequest.serialize, + response_deserializer=vulnerability.VulnerabilityReport.deserialize, + ) + return self._stubs["get_vulnerability_report"] + + @property + def list_vulnerability_reports( + self, + ) -> Callable[ + [vulnerability.ListVulnerabilityReportsRequest], + Awaitable[vulnerability.ListVulnerabilityReportsResponse], + ]: + r"""Return a callable for the list vulnerability reports method over gRPC. + + List vulnerability reports for all VM instances in + the specified zone. + + Returns: + Callable[[~.ListVulnerabilityReportsRequest], + Awaitable[~.ListVulnerabilityReportsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_vulnerability_reports" not in self._stubs: + self._stubs["list_vulnerability_reports"] = self.grpc_channel.unary_unary( + "/google.cloud.osconfig.v1alpha.OsConfigZonalService/ListVulnerabilityReports", + request_serializer=vulnerability.ListVulnerabilityReportsRequest.serialize, + response_deserializer=vulnerability.ListVulnerabilityReportsResponse.deserialize, + ) + return self._stubs["list_vulnerability_reports"] + + +__all__ = ("OsConfigZonalServiceGrpcAsyncIOTransport",) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/__init__.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/__init__.py new file mode 100644 index 000000000000..7cb3abb1617c --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/__init__.py @@ -0,0 +1,86 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .config_common import ( + OSPolicyResourceCompliance, + OSPolicyResourceConfigStep, + OSPolicyComplianceState, +) +from .instance_os_policies_compliance import ( + GetInstanceOSPoliciesComplianceRequest, + InstanceOSPoliciesCompliance, + ListInstanceOSPoliciesCompliancesRequest, + ListInstanceOSPoliciesCompliancesResponse, +) +from .inventory import ( + GetInventoryRequest, + Inventory, + ListInventoriesRequest, + ListInventoriesResponse, + InventoryView, +) +from .os_policy import OSPolicy +from .os_policy_assignments import ( + CreateOSPolicyAssignmentRequest, + DeleteOSPolicyAssignmentRequest, + GetOSPolicyAssignmentRequest, + ListOSPolicyAssignmentRevisionsRequest, + ListOSPolicyAssignmentRevisionsResponse, + ListOSPolicyAssignmentsRequest, + ListOSPolicyAssignmentsResponse, + OSPolicyAssignment, + OSPolicyAssignmentOperationMetadata, + UpdateOSPolicyAssignmentRequest, +) +from .osconfig_common import FixedOrPercent +from .vulnerability import ( + CVSSv3, + GetVulnerabilityReportRequest, + ListVulnerabilityReportsRequest, + ListVulnerabilityReportsResponse, + VulnerabilityReport, +) + +__all__ = ( + "OSPolicyResourceCompliance", + "OSPolicyResourceConfigStep", + "OSPolicyComplianceState", + "GetInstanceOSPoliciesComplianceRequest", + "InstanceOSPoliciesCompliance", + "ListInstanceOSPoliciesCompliancesRequest", + "ListInstanceOSPoliciesCompliancesResponse", + "GetInventoryRequest", + "Inventory", + "ListInventoriesRequest", + "ListInventoriesResponse", + "InventoryView", + "OSPolicy", + "CreateOSPolicyAssignmentRequest", + "DeleteOSPolicyAssignmentRequest", + "GetOSPolicyAssignmentRequest", + "ListOSPolicyAssignmentRevisionsRequest", + "ListOSPolicyAssignmentRevisionsResponse", + "ListOSPolicyAssignmentsRequest", + "ListOSPolicyAssignmentsResponse", + "OSPolicyAssignment", + "OSPolicyAssignmentOperationMetadata", + "UpdateOSPolicyAssignmentRequest", + "FixedOrPercent", + "CVSSv3", + "GetVulnerabilityReportRequest", + "ListVulnerabilityReportsRequest", + "ListVulnerabilityReportsResponse", + "VulnerabilityReport", +) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/config_common.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/config_common.py new file mode 100644 index 000000000000..7d6e04c42525 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/config_common.py @@ -0,0 +1,106 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.osconfig.v1alpha", + manifest={ + "OSPolicyComplianceState", + "OSPolicyResourceConfigStep", + "OSPolicyResourceCompliance", + }, +) + + +class OSPolicyComplianceState(proto.Enum): + r"""Supported OSPolicy compliance states.""" + OS_POLICY_COMPLIANCE_STATE_UNSPECIFIED = 0 + COMPLIANT = 1 + NON_COMPLIANT = 2 + UNKNOWN = 3 + NO_OS_POLICIES_APPLICABLE = 4 + + +class OSPolicyResourceConfigStep(proto.Message): + r"""Step performed by the OS Config agent for configuring an + ``OSPolicyResource`` to its desired state. + + Attributes: + type_ (google.cloud.osconfig_v1alpha.types.OSPolicyResourceConfigStep.Type): + Configuration step type. + outcome (google.cloud.osconfig_v1alpha.types.OSPolicyResourceConfigStep.Outcome): + Outcome of the configuration step. + error_message (str): + An error message recorded during the + execution of this step. Only populated when + outcome is FAILED. + """ + + class Type(proto.Enum): + r"""Supported configuration step types""" + TYPE_UNSPECIFIED = 0 + VALIDATION = 1 + DESIRED_STATE_CHECK = 2 + DESIRED_STATE_ENFORCEMENT = 3 + DESIRED_STATE_CHECK_POST_ENFORCEMENT = 4 + + class Outcome(proto.Enum): + r"""Supported outcomes for a configuration step.""" + OUTCOME_UNSPECIFIED = 0 + SUCCEEDED = 1 + FAILED = 2 + + type_ = proto.Field(proto.ENUM, number=1, enum=Type,) + outcome = proto.Field(proto.ENUM, number=2, enum=Outcome,) + error_message = proto.Field(proto.STRING, number=3,) + + +class OSPolicyResourceCompliance(proto.Message): + r"""Compliance data for an OS policy resource. + Attributes: + os_policy_resource_id (str): + The id of the OS policy resource. + config_steps (Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyResourceConfigStep]): + Ordered list of configuration steps taken by + the agent for the OS policy resource. + state (google.cloud.osconfig_v1alpha.types.OSPolicyComplianceState): + Compliance state of the OS policy resource. + exec_resource_output (google.cloud.osconfig_v1alpha.types.OSPolicyResourceCompliance.ExecResourceOutput): + ExecResource specific output. + """ + + class ExecResourceOutput(proto.Message): + r"""ExecResource specific output. + Attributes: + enforcement_output (bytes): + Output from Enforcement phase output file (if + run). Output size is limited to 100K bytes. + """ + + enforcement_output = proto.Field(proto.BYTES, number=2,) + + os_policy_resource_id = proto.Field(proto.STRING, number=1,) + config_steps = proto.RepeatedField( + proto.MESSAGE, number=2, message="OSPolicyResourceConfigStep", + ) + state = proto.Field(proto.ENUM, number=3, enum="OSPolicyComplianceState",) + exec_resource_output = proto.Field( + proto.MESSAGE, number=4, oneof="output", message=ExecResourceOutput, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/instance_os_policies_compliance.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/instance_os_policies_compliance.py new file mode 100644 index 000000000000..7414995e83a7 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/instance_os_policies_compliance.py @@ -0,0 +1,212 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.cloud.osconfig_v1alpha.types import config_common +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.osconfig.v1alpha", + manifest={ + "InstanceOSPoliciesCompliance", + "GetInstanceOSPoliciesComplianceRequest", + "ListInstanceOSPoliciesCompliancesRequest", + "ListInstanceOSPoliciesCompliancesResponse", + }, +) + + +class InstanceOSPoliciesCompliance(proto.Message): + r"""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 `__. + + Attributes: + name (str): + Output only. The ``InstanceOSPoliciesCompliance`` API + resource name. + + Format: + ``projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}`` + instance (str): + Output only. The Compute Engine VM instance + name. + state (google.cloud.osconfig_v1alpha.types.OSPolicyComplianceState): + Output only. Compliance state of the VM. + detailed_state (str): + Output only. Detailed compliance state of the VM. This field + is populated only when compliance state is ``UNKNOWN``. + + It may contain one of the following values: + + - ``no-compliance-data``: Compliance data is not available + for this VM. + - ``no-agent-detected``: OS Config agent is not detected + for this VM. + - ``config-not-supported-by-agent``: The version of the OS + Config agent running on this VM does not support + configuration management. + - ``inactive``: VM is not running. + - ``internal-service-errors``: There were internal service + errors encountered while enforcing compliance. + - ``agent-errors``: OS config agent encountered errors + while enforcing compliance. + detailed_state_reason (str): + Output only. The reason for the ``detailed_state`` of the VM + (if any). + os_policy_compliances (Sequence[google.cloud.osconfig_v1alpha.types.InstanceOSPoliciesCompliance.OSPolicyCompliance]): + Output only. Compliance data for each ``OSPolicy`` that is + applied to the VM. + last_compliance_check_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Timestamp of the last compliance + check for the VM. + last_compliance_run_id (str): + Output only. Unique identifier for the last + compliance run. This id will be logged by the OS + config agent during a compliance run and can be + used for debugging and tracing purpose. + """ + + class OSPolicyCompliance(proto.Message): + r"""Compliance data for an OS policy + Attributes: + os_policy_id (str): + The OS policy id + os_policy_assignment (str): + Reference to the ``OSPolicyAssignment`` API resource that + the ``OSPolicy`` belongs to. + + Format: + ``projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`` + state (google.cloud.osconfig_v1alpha.types.OSPolicyComplianceState): + Compliance state of the OS policy. + os_policy_resource_compliances (Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyResourceCompliance]): + Compliance data for each ``OSPolicyResource`` that is + applied to the VM. + """ + + os_policy_id = proto.Field(proto.STRING, number=1,) + os_policy_assignment = proto.Field(proto.STRING, number=2,) + state = proto.Field( + proto.ENUM, number=4, enum=config_common.OSPolicyComplianceState, + ) + os_policy_resource_compliances = proto.RepeatedField( + proto.MESSAGE, number=5, message=config_common.OSPolicyResourceCompliance, + ) + + name = proto.Field(proto.STRING, number=1,) + instance = proto.Field(proto.STRING, number=2,) + state = proto.Field( + proto.ENUM, number=3, enum=config_common.OSPolicyComplianceState, + ) + detailed_state = proto.Field(proto.STRING, number=4,) + detailed_state_reason = proto.Field(proto.STRING, number=5,) + os_policy_compliances = proto.RepeatedField( + proto.MESSAGE, number=6, message=OSPolicyCompliance, + ) + last_compliance_check_time = proto.Field( + proto.MESSAGE, number=7, message=timestamp_pb2.Timestamp, + ) + last_compliance_run_id = proto.Field(proto.STRING, number=8,) + + +class GetInstanceOSPoliciesComplianceRequest(proto.Message): + r"""A request message for getting OS policies compliance data for + the given Compute Engine VM instance. + + Attributes: + 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. + """ + + name = proto.Field(proto.STRING, number=1,) + + +class ListInstanceOSPoliciesCompliancesRequest(proto.Message): + r"""A request message for listing OS policies compliance data for + all Compute Engine VMs in the given location. + + Attributes: + 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. + page_size (int): + The maximum number of results to return. + page_token (str): + A pagination token returned from a previous call to + ``ListInstanceOSPoliciesCompliances`` that indicates where + this listing should continue from. + filter (str): + If provided, this field specifies the criteria that must be + met by a ``InstanceOSPoliciesCompliance`` API resource to be + included in the response. + """ + + parent = proto.Field(proto.STRING, number=1,) + page_size = proto.Field(proto.INT32, number=2,) + page_token = proto.Field(proto.STRING, number=3,) + filter = proto.Field(proto.STRING, number=4,) + + +class ListInstanceOSPoliciesCompliancesResponse(proto.Message): + r"""A response message for listing OS policies compliance data + for all Compute Engine VMs in the given location. + + Attributes: + instance_os_policies_compliances (Sequence[google.cloud.osconfig_v1alpha.types.InstanceOSPoliciesCompliance]): + List of instance OS policies compliance + objects. + next_page_token (str): + The pagination token to retrieve the next + page of instance OS policies compliance objects. + """ + + @property + def raw_page(self): + return self + + instance_os_policies_compliances = proto.RepeatedField( + proto.MESSAGE, number=1, message="InstanceOSPoliciesCompliance", + ) + next_page_token = proto.Field(proto.STRING, number=2,) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/inventory.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/inventory.py new file mode 100644 index 000000000000..a5e4ae8e60fb --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/inventory.py @@ -0,0 +1,466 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.osconfig.v1alpha", + manifest={ + "InventoryView", + "Inventory", + "GetInventoryRequest", + "ListInventoriesRequest", + "ListInventoriesResponse", + }, +) + + +class InventoryView(proto.Enum): + r"""The view for inventory objects.""" + INVENTORY_VIEW_UNSPECIFIED = 0 + BASIC = 1 + FULL = 2 + + +class Inventory(proto.Message): + r"""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 `__. + + Attributes: + name (str): + Output only. The ``Inventory`` API resource name. + + Format: + ``projects/{project_number}/locations/{location}/instances/{instance_id}/inventory`` + os_info (google.cloud.osconfig_v1alpha.types.Inventory.OsInfo): + Output only. Base level operating system + information for the VM. + items (Sequence[google.cloud.osconfig_v1alpha.types.Inventory.ItemsEntry]): + Output only. Inventory items related to the + VM keyed by an opaque unique identifier for each + inventory item. The identifier is unique to each + distinct and addressable inventory item and will + change, when there is a new package version. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Timestamp of the last reported + inventory for the VM. + """ + + class OsInfo(proto.Message): + r"""Operating system information for the VM. + Attributes: + hostname (str): + The VM hostname. + long_name (str): + The operating system long name. + For example 'Debian GNU/Linux 9' or 'Microsoft + Window Server 2019 Datacenter'. + short_name (str): + The operating system short name. + For example, 'windows' or 'debian'. + version (str): + The version of the operating system. + architecture (str): + The system architecture of the operating + system. + kernel_version (str): + The kernel version of the operating system. + kernel_release (str): + The kernel release of the operating system. + osconfig_agent_version (str): + The current version of the OS Config agent + running on the VM. + """ + + hostname = proto.Field(proto.STRING, number=9,) + long_name = proto.Field(proto.STRING, number=2,) + short_name = proto.Field(proto.STRING, number=3,) + version = proto.Field(proto.STRING, number=4,) + architecture = proto.Field(proto.STRING, number=5,) + kernel_version = proto.Field(proto.STRING, number=6,) + kernel_release = proto.Field(proto.STRING, number=7,) + osconfig_agent_version = proto.Field(proto.STRING, number=8,) + + class Item(proto.Message): + r"""A single piece of inventory on a VM. + Attributes: + id (str): + Identifier for this item, unique across items + for this VM. + origin_type (google.cloud.osconfig_v1alpha.types.Inventory.Item.OriginType): + The origin of this inventory item. + create_time (google.protobuf.timestamp_pb2.Timestamp): + When this inventory item was first detected. + update_time (google.protobuf.timestamp_pb2.Timestamp): + When this inventory item was last modified. + type_ (google.cloud.osconfig_v1alpha.types.Inventory.Item.Type): + The specific type of inventory, correlating + to its specific details. + installed_package (google.cloud.osconfig_v1alpha.types.Inventory.SoftwarePackage): + Software package present on the VM instance. + available_package (google.cloud.osconfig_v1alpha.types.Inventory.SoftwarePackage): + Software package available to be installed on + the VM instance. + """ + + class OriginType(proto.Enum): + r"""The origin of a specific inventory item.""" + ORIGIN_TYPE_UNSPECIFIED = 0 + INVENTORY_REPORT = 1 + + class Type(proto.Enum): + r"""The different types of inventory that are tracked on a VM.""" + TYPE_UNSPECIFIED = 0 + INSTALLED_PACKAGE = 1 + AVAILABLE_PACKAGE = 2 + + id = proto.Field(proto.STRING, number=1,) + origin_type = proto.Field( + proto.ENUM, number=2, enum="Inventory.Item.OriginType", + ) + create_time = proto.Field( + proto.MESSAGE, number=8, message=timestamp_pb2.Timestamp, + ) + update_time = proto.Field( + proto.MESSAGE, number=9, message=timestamp_pb2.Timestamp, + ) + type_ = proto.Field(proto.ENUM, number=5, enum="Inventory.Item.Type",) + installed_package = proto.Field( + proto.MESSAGE, + number=6, + oneof="details", + message="Inventory.SoftwarePackage", + ) + available_package = proto.Field( + proto.MESSAGE, + number=7, + oneof="details", + message="Inventory.SoftwarePackage", + ) + + class SoftwarePackage(proto.Message): + r"""Software package information of the operating system. + Attributes: + yum_package (google.cloud.osconfig_v1alpha.types.Inventory.VersionedPackage): + Yum package info. For details about the yum package manager, + see + https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/ch-yum. + apt_package (google.cloud.osconfig_v1alpha.types.Inventory.VersionedPackage): + Details of an APT package. + For details about the apt package manager, see + https://wiki.debian.org/Apt. + zypper_package (google.cloud.osconfig_v1alpha.types.Inventory.VersionedPackage): + Details of a Zypper package. For details about the Zypper + package manager, see + https://en.opensuse.org/SDB:Zypper_manual. + googet_package (google.cloud.osconfig_v1alpha.types.Inventory.VersionedPackage): + Details of a Googet package. + For details about the googet package manager, + see https://github.com/google/googet. + zypper_patch (google.cloud.osconfig_v1alpha.types.Inventory.ZypperPatch): + Details of a Zypper patch. For details about the Zypper + package manager, see + https://en.opensuse.org/SDB:Zypper_manual. + wua_package (google.cloud.osconfig_v1alpha.types.Inventory.WindowsUpdatePackage): + Details of a Windows Update package. See + https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for + information about Windows Update. + qfe_package (google.cloud.osconfig_v1alpha.types.Inventory.WindowsQuickFixEngineeringPackage): + Details of a Windows Quick Fix engineering + package. See + https://docs.microsoft.com/en- + us/windows/win32/cimwin32prov/win32-quickfixengineering + for info in Windows Quick Fix Engineering. + cos_package (google.cloud.osconfig_v1alpha.types.Inventory.VersionedPackage): + Details of a COS package. + """ + + yum_package = proto.Field( + proto.MESSAGE, + number=1, + oneof="details", + message="Inventory.VersionedPackage", + ) + apt_package = proto.Field( + proto.MESSAGE, + number=2, + oneof="details", + message="Inventory.VersionedPackage", + ) + zypper_package = proto.Field( + proto.MESSAGE, + number=3, + oneof="details", + message="Inventory.VersionedPackage", + ) + googet_package = proto.Field( + proto.MESSAGE, + number=4, + oneof="details", + message="Inventory.VersionedPackage", + ) + zypper_patch = proto.Field( + proto.MESSAGE, number=5, oneof="details", message="Inventory.ZypperPatch", + ) + wua_package = proto.Field( + proto.MESSAGE, + number=6, + oneof="details", + message="Inventory.WindowsUpdatePackage", + ) + qfe_package = proto.Field( + proto.MESSAGE, + number=7, + oneof="details", + message="Inventory.WindowsQuickFixEngineeringPackage", + ) + cos_package = proto.Field( + proto.MESSAGE, + number=8, + oneof="details", + message="Inventory.VersionedPackage", + ) + + class VersionedPackage(proto.Message): + r"""Information related to the a standard versioned package. + This includes package info for APT, Yum, Zypper, and Googet + package managers. + + Attributes: + package_name (str): + The name of the package. + architecture (str): + The system architecture this package is + intended for. + version (str): + The version of the package. + """ + + package_name = proto.Field(proto.STRING, number=4,) + architecture = proto.Field(proto.STRING, number=2,) + version = proto.Field(proto.STRING, number=3,) + + class ZypperPatch(proto.Message): + r"""Details related to a Zypper Patch. + Attributes: + patch_name (str): + The name of the patch. + category (str): + The category of the patch. + severity (str): + The severity specified for this patch + summary (str): + Any summary information provided about this + patch. + """ + + patch_name = proto.Field(proto.STRING, number=5,) + category = proto.Field(proto.STRING, number=2,) + severity = proto.Field(proto.STRING, number=3,) + summary = proto.Field(proto.STRING, number=4,) + + class WindowsUpdatePackage(proto.Message): + r"""Details related to a Windows Update package. Field data and names + are taken from Windows Update API IUpdate Interface: + https://docs.microsoft.com/en-us/windows/win32/api/_wua/ Descriptive + fields like title, and description are localized based on the locale + of the VM being updated. + + Attributes: + title (str): + The localized title of the update package. + description (str): + The localized description of the update + package. + categories (Sequence[google.cloud.osconfig_v1alpha.types.Inventory.WindowsUpdatePackage.WindowsUpdateCategory]): + The categories that are associated with this + update package. + kb_article_ids (Sequence[str]): + A collection of Microsoft Knowledge Base + article IDs that are associated with the update + package. + support_url (str): + A hyperlink to the language-specific support + information for the update. + more_info_urls (Sequence[str]): + A collection of URLs that provide more + information about the update package. + update_id (str): + Gets the identifier of an update package. + Stays the same across revisions. + revision_number (int): + The revision number of this update package. + last_deployment_change_time (google.protobuf.timestamp_pb2.Timestamp): + The last published date of the update, in + (UTC) date and time. + """ + + class WindowsUpdateCategory(proto.Message): + r"""Categories specified by the Windows Update. + Attributes: + id (str): + The identifier of the windows update + category. + name (str): + The name of the windows update category. + """ + + id = proto.Field(proto.STRING, number=1,) + name = proto.Field(proto.STRING, number=2,) + + title = proto.Field(proto.STRING, number=1,) + description = proto.Field(proto.STRING, number=2,) + categories = proto.RepeatedField( + proto.MESSAGE, + number=3, + message="Inventory.WindowsUpdatePackage.WindowsUpdateCategory", + ) + kb_article_ids = proto.RepeatedField(proto.STRING, number=4,) + support_url = proto.Field(proto.STRING, number=11,) + more_info_urls = proto.RepeatedField(proto.STRING, number=5,) + update_id = proto.Field(proto.STRING, number=6,) + revision_number = proto.Field(proto.INT32, number=7,) + last_deployment_change_time = proto.Field( + proto.MESSAGE, number=10, message=timestamp_pb2.Timestamp, + ) + + class WindowsQuickFixEngineeringPackage(proto.Message): + r"""Information related to a Quick Fix Engineering package. + Fields are taken from Windows QuickFixEngineering Interface and + match the source names: + https://docs.microsoft.com/en- + us/windows/win32/cimwin32prov/win32-quickfixengineering + + Attributes: + caption (str): + A short textual description of the QFE + update. + description (str): + A textual description of the QFE update. + hot_fix_id (str): + Unique identifier associated with a + particular QFE update. + install_time (google.protobuf.timestamp_pb2.Timestamp): + Date that the QFE update was installed. Mapped from + installed_on field. + """ + + caption = proto.Field(proto.STRING, number=1,) + description = proto.Field(proto.STRING, number=2,) + hot_fix_id = proto.Field(proto.STRING, number=3,) + install_time = proto.Field( + proto.MESSAGE, number=5, message=timestamp_pb2.Timestamp, + ) + + name = proto.Field(proto.STRING, number=3,) + os_info = proto.Field(proto.MESSAGE, number=1, message=OsInfo,) + items = proto.MapField(proto.STRING, proto.MESSAGE, number=2, message=Item,) + update_time = proto.Field(proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp,) + + +class GetInventoryRequest(proto.Message): + r"""A request message for getting inventory data for the + specified VM. + + Attributes: + 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. + view (google.cloud.osconfig_v1alpha.types.InventoryView): + Inventory view indicating what information + should be included in the inventory resource. If + unspecified, the default view is BASIC. + """ + + name = proto.Field(proto.STRING, number=1,) + view = proto.Field(proto.ENUM, number=2, enum="InventoryView",) + + +class ListInventoriesRequest(proto.Message): + r"""A request message for listing inventory data for all VMs in + the specified location. + + Attributes: + 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. + view (google.cloud.osconfig_v1alpha.types.InventoryView): + Inventory view indicating what information + should be included in the inventory resource. If + unspecified, the default view is BASIC. + page_size (int): + The maximum number of results to return. + page_token (str): + A pagination token returned from a previous call to + ``ListInventories`` that indicates where this listing should + continue from. + filter (str): + If provided, this field specifies the criteria that must be + met by a ``Inventory`` API resource to be included in the + response. + """ + + parent = proto.Field(proto.STRING, number=1,) + view = proto.Field(proto.ENUM, number=2, enum="InventoryView",) + page_size = proto.Field(proto.INT32, number=3,) + page_token = proto.Field(proto.STRING, number=4,) + filter = proto.Field(proto.STRING, number=5,) + + +class ListInventoriesResponse(proto.Message): + r"""A response message for listing inventory data for all VMs in + a specified location. + + Attributes: + inventories (Sequence[google.cloud.osconfig_v1alpha.types.Inventory]): + List of inventory objects. + next_page_token (str): + The pagination token to retrieve the next + page of inventory objects. + """ + + @property + def raw_page(self): + return self + + inventories = proto.RepeatedField(proto.MESSAGE, number=1, message="Inventory",) + next_page_token = proto.Field(proto.STRING, number=2,) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy.py new file mode 100644 index 000000000000..0a11b5a4434c --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy.py @@ -0,0 +1,722 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.osconfig.v1alpha", manifest={"OSPolicy",}, +) + + +class OSPolicy(proto.Message): + r"""An OS policy defines the desired state configuration for a + VM. + + Attributes: + id (str): + Required. The id of the OS policy 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 assignment. + description (str): + Policy description. + Length of the description is limited to 1024 + characters. + mode (google.cloud.osconfig_v1alpha.types.OSPolicy.Mode): + Required. Policy mode + resource_groups (Sequence[google.cloud.osconfig_v1alpha.types.OSPolicy.ResourceGroup]): + Required. List of resource groups for the policy. For a + particular VM, resource groups are evaluated in the order + specified and the first resource group that is applicable is + selected and the rest are ignored. + + If none of the resource groups are applicable for a VM, the + VM is considered to be non-compliant w.r.t this policy. This + behavior can be toggled by the flag + ``allow_no_resource_group_match`` + allow_no_resource_group_match (bool): + This flag determines the OS policy compliance status when + none of the resource groups within the policy are applicable + for a VM. Set this value to ``true`` if the policy needs to + be reported as compliant even if the policy has nothing to + validate or enforce. + """ + + class Mode(proto.Enum): + r"""Policy mode""" + MODE_UNSPECIFIED = 0 + VALIDATION = 1 + ENFORCEMENT = 2 + + class OSFilter(proto.Message): + r"""The ``OSFilter`` is used to specify the OS filtering criteria for + the resource group. + + Attributes: + os_short_name (str): + This should match OS short name emitted by + the OS inventory agent. An empty value matches + any OS. + os_version (str): + This value should match the version emitted by the OS + inventory agent. Prefix matches are supported if asterisk(*) + is provided as the last character. For example, to match all + versions with a major version of ``7``, specify the + following value for this field ``7.*`` + """ + + os_short_name = proto.Field(proto.STRING, number=1,) + os_version = proto.Field(proto.STRING, number=2,) + + class Resource(proto.Message): + r"""An OS policy resource is used to define the desired state + configuration and provides a specific functionality like + installing/removing packages, executing a script etc. + + The system ensures that resources are always in their desired + state by taking necessary actions if they have drifted from + their desired state. + + Attributes: + id (str): + Required. The id of the resource 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 OS policy. + pkg (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource): + Package resource + repository (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource): + Package repository resource + exec_ (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.ExecResource): + Exec resource + file (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.FileResource): + File resource + """ + + class File(proto.Message): + r"""A remote or local file. + Attributes: + remote (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File.Remote): + A generic remote file. + gcs (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File.Gcs): + A Cloud Storage object. + local_path (str): + A local path within the VM to use. + allow_insecure (bool): + Defaults to false. When false, files are + subject to validations based on the file type: + Remote: A checksum must be specified. + Cloud Storage: An object generation number must + be specified. + """ + + class Remote(proto.Message): + r"""Specifies a file available via some URI. + Attributes: + uri (str): + Required. URI from which to fetch the object. It should + contain both the protocol and path following the format + ``{protocol}://{location}``. + sha256_checksum (str): + SHA256 checksum of the remote file. + """ + + uri = proto.Field(proto.STRING, number=1,) + sha256_checksum = proto.Field(proto.STRING, number=2,) + + class Gcs(proto.Message): + r"""Specifies a file available as a Cloud Storage Object. + Attributes: + bucket (str): + Required. Bucket of the Cloud Storage object. + object_ (str): + Required. Name of the Cloud Storage object. + generation (int): + Generation number of the Cloud Storage + object. + """ + + bucket = proto.Field(proto.STRING, number=1,) + object_ = proto.Field(proto.STRING, number=2,) + generation = proto.Field(proto.INT64, number=3,) + + remote = proto.Field( + proto.MESSAGE, + number=1, + oneof="type", + message="OSPolicy.Resource.File.Remote", + ) + gcs = proto.Field( + proto.MESSAGE, + number=2, + oneof="type", + message="OSPolicy.Resource.File.Gcs", + ) + local_path = proto.Field(proto.STRING, number=3, oneof="type",) + allow_insecure = proto.Field(proto.BOOL, number=4,) + + class PackageResource(proto.Message): + r"""A resource that manages a system package. + Attributes: + desired_state (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.DesiredState): + Required. The desired state the agent should + maintain for this package. + apt (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.APT): + A package managed by Apt. + deb (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.Deb): + A deb package file. + yum (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.YUM): + A package managed by YUM. + zypper (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.Zypper): + A package managed by Zypper. + rpm (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.RPM): + An rpm package file. + googet (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.GooGet): + A package managed by GooGet. + msi (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.MSI): + An MSI package. + """ + + class DesiredState(proto.Enum): + r"""The desired state that the OS Config agent maintains on the + VM. + """ + DESIRED_STATE_UNSPECIFIED = 0 + INSTALLED = 1 + REMOVED = 2 + + class Deb(proto.Message): + r"""A deb package file. dpkg packages only support INSTALLED + state. + + Attributes: + source (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File): + Required. A deb package. + pull_deps (bool): + Whether dependencies should also be installed. + + - install when false: ``dpkg -i package`` + - install when true: + ``apt-get update && apt-get -y install package.deb`` + """ + + source = proto.Field( + proto.MESSAGE, number=1, message="OSPolicy.Resource.File", + ) + pull_deps = proto.Field(proto.BOOL, number=2,) + + class APT(proto.Message): + r"""A package managed by APT. + + - install: ``apt-get update && apt-get -y install [name]`` + - remove: ``apt-get -y remove [name]`` + + Attributes: + name (str): + Required. Package name. + """ + + name = proto.Field(proto.STRING, number=1,) + + class RPM(proto.Message): + r"""An RPM package file. RPM packages only support INSTALLED + state. + + Attributes: + source (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File): + Required. An rpm package. + pull_deps (bool): + Whether dependencies should also be installed. + + - install when false: + ``rpm --upgrade --replacepkgs package.rpm`` + - install when true: ``yum -y install package.rpm`` or + ``zypper -y install package.rpm`` + """ + + source = proto.Field( + proto.MESSAGE, number=1, message="OSPolicy.Resource.File", + ) + pull_deps = proto.Field(proto.BOOL, number=2,) + + class YUM(proto.Message): + r"""A package managed by YUM. + + - install: ``yum -y install package`` + - remove: ``yum -y remove package`` + + Attributes: + name (str): + Required. Package name. + """ + + name = proto.Field(proto.STRING, number=1,) + + class Zypper(proto.Message): + r"""A package managed by Zypper. + + - install: ``zypper -y install package`` + - remove: ``zypper -y rm package`` + + Attributes: + name (str): + Required. Package name. + """ + + name = proto.Field(proto.STRING, number=1,) + + class GooGet(proto.Message): + r"""A package managed by GooGet. + + - install: ``googet -noconfirm install package`` + - remove: ``googet -noconfirm remove package`` + + Attributes: + name (str): + Required. Package name. + """ + + name = proto.Field(proto.STRING, number=1,) + + class MSI(proto.Message): + r"""An MSI package. MSI packages only support INSTALLED state. + Attributes: + source (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File): + Required. The MSI package. + properties (Sequence[str]): + Additional properties to use during installation. This + should be in the format of Property=Setting. Appended to the + defaults of ``ACTION=INSTALL REBOOT=ReallySuppress``. + """ + + source = proto.Field( + proto.MESSAGE, number=1, message="OSPolicy.Resource.File", + ) + properties = proto.RepeatedField(proto.STRING, number=2,) + + desired_state = proto.Field( + proto.ENUM, + number=1, + enum="OSPolicy.Resource.PackageResource.DesiredState", + ) + apt = proto.Field( + proto.MESSAGE, + number=2, + oneof="system_package", + message="OSPolicy.Resource.PackageResource.APT", + ) + deb = proto.Field( + proto.MESSAGE, + number=3, + oneof="system_package", + message="OSPolicy.Resource.PackageResource.Deb", + ) + yum = proto.Field( + proto.MESSAGE, + number=4, + oneof="system_package", + message="OSPolicy.Resource.PackageResource.YUM", + ) + zypper = proto.Field( + proto.MESSAGE, + number=5, + oneof="system_package", + message="OSPolicy.Resource.PackageResource.Zypper", + ) + rpm = proto.Field( + proto.MESSAGE, + number=6, + oneof="system_package", + message="OSPolicy.Resource.PackageResource.RPM", + ) + googet = proto.Field( + proto.MESSAGE, + number=7, + oneof="system_package", + message="OSPolicy.Resource.PackageResource.GooGet", + ) + msi = proto.Field( + proto.MESSAGE, + number=8, + oneof="system_package", + message="OSPolicy.Resource.PackageResource.MSI", + ) + + class RepositoryResource(proto.Message): + r"""A resource that manages a package repository. + Attributes: + apt (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource.AptRepository): + An Apt Repository. + yum (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource.YumRepository): + A Yum Repository. + zypper (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource.ZypperRepository): + A Zypper Repository. + goo (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource.GooRepository): + A Goo Repository. + """ + + class AptRepository(proto.Message): + r"""Represents a single apt package repository. These will be added to a + repo file that will be managed at + ``/etc/apt/sources.list.d/google_osconfig.list``. + + Attributes: + archive_type (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource.AptRepository.ArchiveType): + Required. Type of archive files in this + repository. + uri (str): + Required. URI for this repository. + distribution (str): + Required. Distribution of this repository. + components (Sequence[str]): + Required. List of components for this + repository. Must contain at least one item. + gpg_key (str): + URI of the key file for this repository. The agent maintains + a keyring at + ``/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg``. + """ + + class ArchiveType(proto.Enum): + r"""Type of archive.""" + ARCHIVE_TYPE_UNSPECIFIED = 0 + DEB = 1 + DEB_SRC = 2 + + archive_type = proto.Field( + proto.ENUM, + number=1, + enum="OSPolicy.Resource.RepositoryResource.AptRepository.ArchiveType", + ) + uri = proto.Field(proto.STRING, number=2,) + distribution = proto.Field(proto.STRING, number=3,) + components = proto.RepeatedField(proto.STRING, number=4,) + gpg_key = proto.Field(proto.STRING, number=5,) + + class YumRepository(proto.Message): + r"""Represents a single yum package repository. These are added to a + repo file that is managed at + ``/etc/yum.repos.d/google_osconfig.repo``. + + Attributes: + id (str): + Required. A one word, unique name for this repository. This + is the ``repo id`` in the yum config file and also the + ``display_name`` if ``display_name`` is omitted. This id is + also used as the unique identifier when checking for + resource conflicts. + display_name (str): + The display name of the repository. + base_url (str): + Required. The location of the repository + directory. + gpg_keys (Sequence[str]): + URIs of GPG keys. + """ + + id = proto.Field(proto.STRING, number=1,) + display_name = proto.Field(proto.STRING, number=2,) + base_url = proto.Field(proto.STRING, number=3,) + gpg_keys = proto.RepeatedField(proto.STRING, number=4,) + + class ZypperRepository(proto.Message): + r"""Represents a single zypper package repository. These are added to a + repo file that is managed at + ``/etc/zypp/repos.d/google_osconfig.repo``. + + Attributes: + id (str): + Required. A one word, unique name for this repository. This + is the ``repo id`` in the zypper config file and also the + ``display_name`` if ``display_name`` is omitted. This id is + also used as the unique identifier when checking for + GuestPolicy conflicts. + display_name (str): + The display name of the repository. + base_url (str): + Required. The location of the repository + directory. + gpg_keys (Sequence[str]): + URIs of GPG keys. + """ + + id = proto.Field(proto.STRING, number=1,) + display_name = proto.Field(proto.STRING, number=2,) + base_url = proto.Field(proto.STRING, number=3,) + gpg_keys = proto.RepeatedField(proto.STRING, number=4,) + + class GooRepository(proto.Message): + r"""Represents a Goo package repository. These are added to a repo file + that is managed at + ``C:/ProgramData/GooGet/repos/google_osconfig.repo``. + + Attributes: + name (str): + Required. The name of the repository. + url (str): + Required. The url of the repository. + """ + + name = proto.Field(proto.STRING, number=1,) + url = proto.Field(proto.STRING, number=2,) + + apt = proto.Field( + proto.MESSAGE, + number=1, + oneof="repository", + message="OSPolicy.Resource.RepositoryResource.AptRepository", + ) + yum = proto.Field( + proto.MESSAGE, + number=2, + oneof="repository", + message="OSPolicy.Resource.RepositoryResource.YumRepository", + ) + zypper = proto.Field( + proto.MESSAGE, + number=3, + oneof="repository", + message="OSPolicy.Resource.RepositoryResource.ZypperRepository", + ) + goo = proto.Field( + proto.MESSAGE, + number=4, + oneof="repository", + message="OSPolicy.Resource.RepositoryResource.GooRepository", + ) + + class ExecResource(proto.Message): + r"""A resource that allows executing scripts on the VM. + + The ``ExecResource`` has 2 stages: ``validate`` and ``enforce`` and + both stages accept a script as an argument to execute. + + When the ``ExecResource`` is applied by the agent, it first executes + the script in the ``validate`` stage. The ``validate`` stage can + signal that the ``ExecResource`` is already in the desired state by + returning an exit code of ``100``. If the ``ExecResource`` is not in + the desired state, it should return an exit code of ``101``. Any + other exit code returned by this stage is considered an error. + + If the ``ExecResource`` is not in the desired state based on the + exit code from the ``validate`` stage, the agent proceeds to execute + the script from the ``enforce`` stage. If the ``ExecResource`` is + already in the desired state, the ``enforce`` stage will not be run. + Similar to ``validate`` stage, the ``enforce`` stage should return + an exit code of ``100`` to indicate that the resource in now in its + desired state. Any other exit code is considered an error. + + NOTE: An exit code of ``100`` was chosen over ``0`` (and ``101`` vs + ``1``) to have an explicit indicator of ``in desired state``, + ``not in desired state`` and errors. Because, for example, + Powershell will always return an exit code of ``0`` unless an + ``exit`` statement is provided in the script. So, for reasons of + consistency and being explicit, exit codes ``100`` and ``101`` were + chosen. + + Attributes: + validate (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.ExecResource.Exec): + Required. What to run to validate this + resource is in the desired state. An exit code + of 100 indicates "in desired state", and exit + code of 101 indicates "not in desired state". + Any other exit code indicates a failure running + validate. + enforce (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.ExecResource.Exec): + What to run to bring this resource into the + desired state. An exit code of 100 indicates + "success", any other exit code indicates a + failure running enforce. + """ + + class Exec(proto.Message): + r"""A file or script to execute. + Attributes: + file (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File): + A remote or local file. + script (str): + An inline script. + The size of the script is limited to 1024 + characters. + args (Sequence[str]): + Optional arguments to pass to the source + during execution. + interpreter (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.ExecResource.Exec.Interpreter): + Required. The script interpreter to use. + output_file_path (str): + Only recorded for enforce Exec. + Path to an output file (that is created by this + Exec) whose content will be recorded in + OSPolicyResourceCompliance after a successful + run. Absence or failure to read this file will + result in this ExecResource being non-compliant. + Output file size is limited to 100K bytes. + """ + + class Interpreter(proto.Enum): + r"""The interpreter to use.""" + INTERPRETER_UNSPECIFIED = 0 + NONE = 1 + SHELL = 2 + POWERSHELL = 3 + + file = proto.Field( + proto.MESSAGE, + number=1, + oneof="source", + message="OSPolicy.Resource.File", + ) + script = proto.Field(proto.STRING, number=2, oneof="source",) + args = proto.RepeatedField(proto.STRING, number=3,) + interpreter = proto.Field( + proto.ENUM, + number=4, + enum="OSPolicy.Resource.ExecResource.Exec.Interpreter", + ) + output_file_path = proto.Field(proto.STRING, number=5,) + + validate = proto.Field( + proto.MESSAGE, number=1, message="OSPolicy.Resource.ExecResource.Exec", + ) + enforce = proto.Field( + proto.MESSAGE, number=2, message="OSPolicy.Resource.ExecResource.Exec", + ) + + class FileResource(proto.Message): + r"""A resource that manages the state of a file. + Attributes: + file (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File): + A remote or local source. + content (str): + A a file with this content. + The size of the content is limited to 1024 + characters. + path (str): + Required. The absolute path of the file + within the VM. + state (google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.FileResource.DesiredState): + Required. Desired state of the file. + permissions (str): + Consists of three octal digits which + represent, in order, the permissions of the + owner, group, and other users for the file + (similarly to the numeric mode used in the linux + chmod utility). Each digit represents a three + bit number with the 4 bit corresponding to the + read permissions, the 2 bit corresponds to the + write bit, and the one bit corresponds to the + execute permission. Default behavior is 755. + + Below are some examples of permissions and their + associated values: read, write, and execute: 7 + read and execute: 5 + read and write: 6 + read only: 4 + """ + + class DesiredState(proto.Enum): + r"""Desired state of the file.""" + DESIRED_STATE_UNSPECIFIED = 0 + PRESENT = 1 + ABSENT = 2 + CONTENTS_MATCH = 3 + + file = proto.Field( + proto.MESSAGE, + number=1, + oneof="source", + message="OSPolicy.Resource.File", + ) + content = proto.Field(proto.STRING, number=2, oneof="source",) + path = proto.Field(proto.STRING, number=3,) + state = proto.Field( + proto.ENUM, + number=4, + enum="OSPolicy.Resource.FileResource.DesiredState", + ) + permissions = proto.Field(proto.STRING, number=5,) + + id = proto.Field(proto.STRING, number=1,) + pkg = proto.Field( + proto.MESSAGE, + number=2, + oneof="resource_type", + message="OSPolicy.Resource.PackageResource", + ) + repository = proto.Field( + proto.MESSAGE, + number=3, + oneof="resource_type", + message="OSPolicy.Resource.RepositoryResource", + ) + exec_ = proto.Field( + proto.MESSAGE, + number=4, + oneof="resource_type", + message="OSPolicy.Resource.ExecResource", + ) + file = proto.Field( + proto.MESSAGE, + number=5, + oneof="resource_type", + message="OSPolicy.Resource.FileResource", + ) + + class ResourceGroup(proto.Message): + r"""Resource groups provide a mechanism to group OS policy resources. + + Resource groups enable OS policy authors to create a single OS + policy to be applied to VMs running different operating Systems. + + When the OS policy is applied to a target VM, the appropriate + resource group within the OS policy is selected based on the + ``OSFilter`` specified within the resource group. + + Attributes: + os_filter (google.cloud.osconfig_v1alpha.types.OSPolicy.OSFilter): + Used to specify the OS filter for a resource + group + resources (Sequence[google.cloud.osconfig_v1alpha.types.OSPolicy.Resource]): + Required. List of resources configured for + this resource group. The resources are executed + in the exact order specified here. + """ + + os_filter = proto.Field(proto.MESSAGE, number=1, message="OSPolicy.OSFilter",) + resources = proto.RepeatedField( + proto.MESSAGE, number=2, message="OSPolicy.Resource", + ) + + id = proto.Field(proto.STRING, number=1,) + description = proto.Field(proto.STRING, number=2,) + mode = proto.Field(proto.ENUM, number=3, enum=Mode,) + resource_groups = proto.RepeatedField( + proto.MESSAGE, number=4, message=ResourceGroup, + ) + allow_no_resource_group_match = proto.Field(proto.BOOL, number=5,) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy_assignments.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy_assignments.py new file mode 100644 index 000000000000..cde4f84ebda8 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy_assignments.py @@ -0,0 +1,426 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.cloud.osconfig_v1alpha.types import os_policy +from google.cloud.osconfig_v1alpha.types import osconfig_common +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.osconfig.v1alpha", + manifest={ + "OSPolicyAssignment", + "OSPolicyAssignmentOperationMetadata", + "CreateOSPolicyAssignmentRequest", + "UpdateOSPolicyAssignmentRequest", + "GetOSPolicyAssignmentRequest", + "ListOSPolicyAssignmentsRequest", + "ListOSPolicyAssignmentsResponse", + "ListOSPolicyAssignmentRevisionsRequest", + "ListOSPolicyAssignmentRevisionsResponse", + "DeleteOSPolicyAssignmentRequest", + }, +) + + +class OSPolicyAssignment(proto.Message): + r"""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 `__. + + Attributes: + name (str): + Resource name. + + Format: + ``projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}`` + + This field is ignored when you create an OS policy + assignment. + description (str): + OS policy assignment description. + Length of the description is limited to 1024 + characters. + os_policies (Sequence[google.cloud.osconfig_v1alpha.types.OSPolicy]): + Required. List of OS policies to be applied + to the VMs. + instance_filter (google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.InstanceFilter): + Required. Filter to select VMs. + rollout (google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.Rollout): + Required. Rollout to deploy the OS policy assignment. A + rollout is triggered in the following situations: + + 1) OSPolicyAssignment is created. + 2) OSPolicyAssignment is updated and the update contains + changes to one of the following fields: + + - instance_filter + - os_policies + + 3) OSPolicyAssignment is deleted. + revision_id (str): + Output only. The assignment revision ID + A new revision is committed whenever a rollout + is triggered for a OS policy assignment + revision_create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The timestamp that the revision + was created. + rollout_state (google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.RolloutState): + Output only. OS policy assignment rollout + state + baseline (bool): + Output only. Indicates that this revision has been + successfully rolled out in this zone and new VMs will be + assigned OS policies from this revision. + + For a given OS policy assignment, there is only one revision + with a value of ``true`` for this field. + deleted (bool): + Output only. Indicates that this revision + deletes the OS policy assignment. + reconciling (bool): + Output only. Indicates that reconciliation is in progress + for the revision. This value is ``true`` when the + ``rollout_state`` is one of: + + - IN_PROGRESS + - CANCELLING + uid (str): + Output only. Server generated unique id for + the OS policy assignment resource. + """ + + class RolloutState(proto.Enum): + r"""OS policy assignment rollout state""" + ROLLOUT_STATE_UNSPECIFIED = 0 + IN_PROGRESS = 1 + CANCELLING = 2 + CANCELLED = 3 + SUCCEEDED = 4 + + class LabelSet(proto.Message): + r"""Message representing label set. + + - A label is a key value pair set for a VM. + - A LabelSet is a set of labels. + - Labels within a LabelSet are ANDed. In other words, a LabelSet is + applicable for a VM only if it matches all the labels in the + LabelSet. + - Example: A LabelSet with 2 labels: ``env=prod`` and + ``type=webserver`` will only be applicable for those VMs with + both labels present. + + Attributes: + labels (Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.LabelSet.LabelsEntry]): + Labels are identified by key/value pairs in + this map. A VM should contain all the key/value + pairs specified in this map to be selected. + """ + + labels = proto.MapField(proto.STRING, proto.STRING, number=1,) + + class InstanceFilter(proto.Message): + r"""Message to represent the filters to select VMs for an + assignment + + Attributes: + all_ (bool): + Target all VMs in the project. If true, no + other criteria is permitted. + os_short_names (Sequence[str]): + A VM is included if it's OS short name + matches with any of the values provided in this + list. + inclusion_labels (Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.LabelSet]): + List of label sets used for VM inclusion. + + If the list has more than one ``LabelSet``, the VM is + included if any of the label sets are applicable for the VM. + exclusion_labels (Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.LabelSet]): + List of label sets used for VM exclusion. + If the list has more than one label set, the VM + is excluded if any of the label sets are + applicable for the VM. + + This filter is applied last in the filtering + chain and therefore a VM is guaranteed to be + excluded if it satisfies one of the below label + sets. + """ + + all_ = proto.Field(proto.BOOL, number=1,) + os_short_names = proto.RepeatedField(proto.STRING, number=2,) + inclusion_labels = proto.RepeatedField( + proto.MESSAGE, number=3, message="OSPolicyAssignment.LabelSet", + ) + exclusion_labels = proto.RepeatedField( + proto.MESSAGE, number=4, message="OSPolicyAssignment.LabelSet", + ) + + class Rollout(proto.Message): + r"""Message to configure the rollout at the zonal level for the + OS policy assignment. + + Attributes: + disruption_budget (google.cloud.osconfig_v1alpha.types.FixedOrPercent): + Required. The maximum number (or percentage) + of VMs per zone to disrupt at any given moment. + min_wait_duration (google.protobuf.duration_pb2.Duration): + Required. This determines the minimum duration of time to + wait after the configuration changes are applied through the + current rollout. A VM continues to count towards the + ``disruption_budget`` at least until this duration of time + has passed after configuration changes are applied. + """ + + disruption_budget = proto.Field( + proto.MESSAGE, number=1, message=osconfig_common.FixedOrPercent, + ) + min_wait_duration = proto.Field( + proto.MESSAGE, number=2, message=duration_pb2.Duration, + ) + + name = proto.Field(proto.STRING, number=1,) + description = proto.Field(proto.STRING, number=2,) + os_policies = proto.RepeatedField( + proto.MESSAGE, number=3, message=os_policy.OSPolicy, + ) + instance_filter = proto.Field(proto.MESSAGE, number=4, message=InstanceFilter,) + rollout = proto.Field(proto.MESSAGE, number=5, message=Rollout,) + revision_id = proto.Field(proto.STRING, number=6,) + revision_create_time = proto.Field( + proto.MESSAGE, number=7, message=timestamp_pb2.Timestamp, + ) + rollout_state = proto.Field(proto.ENUM, number=9, enum=RolloutState,) + baseline = proto.Field(proto.BOOL, number=10,) + deleted = proto.Field(proto.BOOL, number=11,) + reconciling = proto.Field(proto.BOOL, number=12,) + uid = proto.Field(proto.STRING, number=13,) + + +class OSPolicyAssignmentOperationMetadata(proto.Message): + r"""OS policy assignment operation metadata provided by OS policy + assignment API methods that return long running operations. + + Attributes: + os_policy_assignment (str): + Reference to the ``OSPolicyAssignment`` API resource. + + Format: + ``projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`` + api_method (google.cloud.osconfig_v1alpha.types.OSPolicyAssignmentOperationMetadata.APIMethod): + The OS policy assignment API method. + rollout_state (google.cloud.osconfig_v1alpha.types.OSPolicyAssignmentOperationMetadata.RolloutState): + State of the rollout + rollout_start_time (google.protobuf.timestamp_pb2.Timestamp): + Rollout start time + rollout_update_time (google.protobuf.timestamp_pb2.Timestamp): + Rollout update time + """ + + class APIMethod(proto.Enum): + r"""The OS policy assignment API method.""" + API_METHOD_UNSPECIFIED = 0 + CREATE = 1 + UPDATE = 2 + DELETE = 3 + + class RolloutState(proto.Enum): + r"""State of the rollout""" + ROLLOUT_STATE_UNSPECIFIED = 0 + IN_PROGRESS = 1 + CANCELLING = 2 + CANCELLED = 3 + SUCCEEDED = 4 + + os_policy_assignment = proto.Field(proto.STRING, number=1,) + api_method = proto.Field(proto.ENUM, number=2, enum=APIMethod,) + rollout_state = proto.Field(proto.ENUM, number=3, enum=RolloutState,) + rollout_start_time = proto.Field( + proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp, + ) + rollout_update_time = proto.Field( + proto.MESSAGE, number=5, message=timestamp_pb2.Timestamp, + ) + + +class CreateOSPolicyAssignmentRequest(proto.Message): + r"""A request message to create an OS policy assignment + Attributes: + parent (str): + Required. The parent resource name in the + form: projects/{project}/locations/{location} + os_policy_assignment (google.cloud.osconfig_v1alpha.types.OSPolicyAssignment): + Required. The OS policy assignment to be + created. + 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. + """ + + parent = proto.Field(proto.STRING, number=1,) + os_policy_assignment = proto.Field( + proto.MESSAGE, number=2, message="OSPolicyAssignment", + ) + os_policy_assignment_id = proto.Field(proto.STRING, number=3,) + + +class UpdateOSPolicyAssignmentRequest(proto.Message): + r"""A request message to update an OS policy assignment + Attributes: + os_policy_assignment (google.cloud.osconfig_v1alpha.types.OSPolicyAssignment): + Required. The updated OS policy assignment. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. Field mask that controls which + fields of the assignment should be updated. + """ + + os_policy_assignment = proto.Field( + proto.MESSAGE, number=1, message="OSPolicyAssignment", + ) + update_mask = proto.Field( + proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask, + ) + + +class GetOSPolicyAssignmentRequest(proto.Message): + r"""A request message to get an OS policy assignment + Attributes: + name (str): + Required. The resource name of OS policy assignment. + + Format: + ``projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}`` + """ + + name = proto.Field(proto.STRING, number=1,) + + +class ListOSPolicyAssignmentsRequest(proto.Message): + r"""A request message to list OS policy assignments for a parent + resource + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of assignments to return. + page_token (str): + A pagination token returned from a previous call to + ``ListOSPolicyAssignments`` that indicates where this + listing should continue from. + """ + + parent = proto.Field(proto.STRING, number=1,) + page_size = proto.Field(proto.INT32, number=2,) + page_token = proto.Field(proto.STRING, number=3,) + + +class ListOSPolicyAssignmentsResponse(proto.Message): + r"""A response message for listing all assignments under given + parent. + + Attributes: + os_policy_assignments (Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment]): + The list of assignments + next_page_token (str): + The pagination token to retrieve the next + page of OS policy assignments. + """ + + @property + def raw_page(self): + return self + + os_policy_assignments = proto.RepeatedField( + proto.MESSAGE, number=1, message="OSPolicyAssignment", + ) + next_page_token = proto.Field(proto.STRING, number=2,) + + +class ListOSPolicyAssignmentRevisionsRequest(proto.Message): + r"""A request message to list revisions for a OS policy + assignment + + Attributes: + name (str): + Required. The name of the OS policy + assignment to list revisions for. + page_size (int): + The maximum number of revisions to return. + page_token (str): + A pagination token returned from a previous call to + ``ListOSPolicyAssignmentRevisions`` that indicates where + this listing should continue from. + """ + + name = proto.Field(proto.STRING, number=1,) + page_size = proto.Field(proto.INT32, number=2,) + page_token = proto.Field(proto.STRING, number=3,) + + +class ListOSPolicyAssignmentRevisionsResponse(proto.Message): + r"""A response message for listing all revisions for a OS policy + assignment. + + Attributes: + os_policy_assignments (Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment]): + The OS policy assignment revisions + next_page_token (str): + The pagination token to retrieve the next + page of OS policy assignment revisions. + """ + + @property + def raw_page(self): + return self + + os_policy_assignments = proto.RepeatedField( + proto.MESSAGE, number=1, message="OSPolicyAssignment", + ) + next_page_token = proto.Field(proto.STRING, number=2,) + + +class DeleteOSPolicyAssignmentRequest(proto.Message): + r"""A request message for deleting a OS policy assignment. + Attributes: + name (str): + Required. The name of the OS policy + assignment to be deleted + """ + + name = proto.Field(proto.STRING, number=1,) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/osconfig_common.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/osconfig_common.py new file mode 100644 index 000000000000..22d30057d754 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/osconfig_common.py @@ -0,0 +1,41 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.osconfig.v1alpha", manifest={"FixedOrPercent",}, +) + + +class FixedOrPercent(proto.Message): + r"""Message encapsulating a value that can be either absolute + ("fixed") or relative ("percent") to a value. + + Attributes: + fixed (int): + Specifies a fixed value. + percent (int): + Specifies the relative value defined as a + percentage, which will be multiplied by a + reference value. + """ + + fixed = proto.Field(proto.INT32, number=1, oneof="mode",) + percent = proto.Field(proto.INT32, number=2, oneof="mode",) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/osconfig_zonal_service.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/osconfig_zonal_service.py new file mode 100644 index 000000000000..fc350733121a --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/osconfig_zonal_service.py @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + + +__protobuf__ = proto.module(package="google.cloud.osconfig.v1alpha", manifest={},) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/vulnerability.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/vulnerability.py new file mode 100644 index 000000000000..06977d8700c7 --- /dev/null +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/vulnerability.py @@ -0,0 +1,353 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.osconfig.v1alpha", + manifest={ + "VulnerabilityReport", + "GetVulnerabilityReportRequest", + "ListVulnerabilityReportsRequest", + "ListVulnerabilityReportsResponse", + "CVSSv3", + }, +) + + +class VulnerabilityReport(proto.Message): + r"""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 `__. + + Attributes: + name (str): + Output only. The ``vulnerabilityReport`` API resource name. + + Format: + ``projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport`` + vulnerabilities (Sequence[google.cloud.osconfig_v1alpha.types.VulnerabilityReport.Vulnerability]): + Output only. List of vulnerabilities + affecting the VM. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The timestamp for when the last + vulnerability report was generated for the VM. + """ + + class Vulnerability(proto.Message): + r"""A vulnerability affecting the VM instance. + Attributes: + details (google.cloud.osconfig_v1alpha.types.VulnerabilityReport.Vulnerability.Details): + Contains metadata as per the upstream feed of + the operating system and NVD. + installed_inventory_item_ids (Sequence[str]): + Corresponds to the ``INSTALLED_PACKAGE`` inventory item on + the VM. This field displays the inventory items affected by + this vulnerability. If the vulnerability report was not + updated after the VM inventory update, these values might + not display in VM inventory. For some distros, this field + may be empty. + available_inventory_item_ids (Sequence[str]): + Corresponds to the ``AVAILABLE_PACKAGE`` inventory item on + the VM. If the vulnerability report was not updated after + the VM inventory update, these values might not display in + VM inventory. If there is no available fix, the field is + empty. The ``inventory_item`` value specifies the latest + ``SoftwarePackage`` available to the VM that fixes the + vulnerability. + create_time (google.protobuf.timestamp_pb2.Timestamp): + The timestamp for when the vulnerability was + first detected. + update_time (google.protobuf.timestamp_pb2.Timestamp): + The timestamp for when the vulnerability was + last modified. + """ + + class Details(proto.Message): + r"""Contains metadata information for the vulnerability. This + information is collected from the upstream feed of the operating + system. + + Attributes: + cve (str): + The CVE of the vulnerability. CVE cannot be + empty and the combination of should be unique across + vulnerabilities for a VM. + cvss_v2_score (float): + The CVSS V2 score of this vulnerability. CVSS + V2 score is on a scale of 0 - 10 where 0 + indicates low severity and 10 indicates high + severity. + cvss_v3 (google.cloud.osconfig_v1alpha.types.CVSSv3): + The full description of the CVSSv3 for this + vulnerability from NVD. + severity (str): + Assigned severity/impact ranking from the + distro. + description (str): + The note or description describing the + vulnerability from the distro. + references (Sequence[google.cloud.osconfig_v1alpha.types.VulnerabilityReport.Vulnerability.Details.Reference]): + Corresponds to the references attached to the + ``VulnerabilityDetails``. + """ + + class Reference(proto.Message): + r"""A reference for this vulnerability. + Attributes: + url (str): + The url of the reference. + """ + + url = proto.Field(proto.STRING, number=1,) + + cve = proto.Field(proto.STRING, number=1,) + cvss_v2_score = proto.Field(proto.FLOAT, number=2,) + cvss_v3 = proto.Field(proto.MESSAGE, number=3, message="CVSSv3",) + severity = proto.Field(proto.STRING, number=4,) + description = proto.Field(proto.STRING, number=5,) + references = proto.RepeatedField( + proto.MESSAGE, + number=6, + message="VulnerabilityReport.Vulnerability.Details.Reference", + ) + + details = proto.Field( + proto.MESSAGE, + number=1, + message="VulnerabilityReport.Vulnerability.Details", + ) + installed_inventory_item_ids = proto.RepeatedField(proto.STRING, number=2,) + available_inventory_item_ids = proto.RepeatedField(proto.STRING, number=3,) + create_time = proto.Field( + proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp, + ) + update_time = proto.Field( + proto.MESSAGE, number=5, message=timestamp_pb2.Timestamp, + ) + + name = proto.Field(proto.STRING, number=1,) + vulnerabilities = proto.RepeatedField( + proto.MESSAGE, number=2, message=Vulnerability, + ) + update_time = proto.Field(proto.MESSAGE, number=3, message=timestamp_pb2.Timestamp,) + + +class GetVulnerabilityReportRequest(proto.Message): + r"""A request message for getting the vulnerability report for + the specified VM. + + Attributes: + 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. + """ + + name = proto.Field(proto.STRING, number=1,) + + +class ListVulnerabilityReportsRequest(proto.Message): + r"""A request message for listing vulnerability reports for all + VM instances in the specified location. + + Attributes: + 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. + page_size (int): + The maximum number of results to return. + page_token (str): + A pagination token returned from a previous call to + ``ListVulnerabilityReports`` that indicates where this + listing should continue from. + filter (str): + If provided, this field specifies the criteria that must be + met by a ``vulnerabilityReport`` API resource to be included + in the response. + """ + + parent = proto.Field(proto.STRING, number=1,) + page_size = proto.Field(proto.INT32, number=2,) + page_token = proto.Field(proto.STRING, number=3,) + filter = proto.Field(proto.STRING, number=4,) + + +class ListVulnerabilityReportsResponse(proto.Message): + r"""A response message for listing vulnerability reports for all + VM instances in the specified location. + + Attributes: + vulnerability_reports (Sequence[google.cloud.osconfig_v1alpha.types.VulnerabilityReport]): + List of vulnerabilityReport objects. + next_page_token (str): + The pagination token to retrieve the next + page of vulnerabilityReports object. + """ + + @property + def raw_page(self): + return self + + vulnerability_reports = proto.RepeatedField( + proto.MESSAGE, number=1, message="VulnerabilityReport", + ) + next_page_token = proto.Field(proto.STRING, number=2,) + + +class CVSSv3(proto.Message): + r"""Common Vulnerability Scoring System version 3. + For details, see https://www.first.org/cvss/specification- + document + + Attributes: + base_score (float): + The base score is a function of the base + metric scores. + https://www.first.org/cvss/specification- + document#Base-Metrics + exploitability_score (float): + The Exploitability sub-score equation is + derived from the Base Exploitability metrics. + https://www.first.org/cvss/specification- + document#2-1-Exploitability-Metrics + impact_score (float): + The Impact sub-score equation is derived from + the Base Impact metrics. + attack_vector (google.cloud.osconfig_v1alpha.types.CVSSv3.AttackVector): + This metric reflects the context by which + vulnerability exploitation is possible. + attack_complexity (google.cloud.osconfig_v1alpha.types.CVSSv3.AttackComplexity): + This metric describes the conditions beyond + the attacker's control that must exist in order + to exploit the vulnerability. + privileges_required (google.cloud.osconfig_v1alpha.types.CVSSv3.PrivilegesRequired): + This metric describes the level of privileges + an attacker must possess before successfully + exploiting the vulnerability. + user_interaction (google.cloud.osconfig_v1alpha.types.CVSSv3.UserInteraction): + This metric captures the requirement for a + human user, other than the attacker, to + participate in the successful compromise of the + vulnerable component. + scope (google.cloud.osconfig_v1alpha.types.CVSSv3.Scope): + The Scope metric captures whether a + vulnerability in one vulnerable component + impacts resources in components beyond its + security scope. + confidentiality_impact (google.cloud.osconfig_v1alpha.types.CVSSv3.Impact): + This metric measures the impact to the + confidentiality of the information resources + managed by a software component due to a + successfully exploited vulnerability. + integrity_impact (google.cloud.osconfig_v1alpha.types.CVSSv3.Impact): + This metric measures the impact to integrity + of a successfully exploited vulnerability. + availability_impact (google.cloud.osconfig_v1alpha.types.CVSSv3.Impact): + This metric measures the impact to the + availability of the impacted component resulting + from a successfully exploited vulnerability. + """ + + class AttackVector(proto.Enum): + r"""This metric reflects the context by which vulnerability + exploitation is possible. + """ + ATTACK_VECTOR_UNSPECIFIED = 0 + ATTACK_VECTOR_NETWORK = 1 + ATTACK_VECTOR_ADJACENT = 2 + ATTACK_VECTOR_LOCAL = 3 + ATTACK_VECTOR_PHYSICAL = 4 + + class AttackComplexity(proto.Enum): + r"""This metric describes the conditions beyond the attacker's + control that must exist in order to exploit the vulnerability. + """ + ATTACK_COMPLEXITY_UNSPECIFIED = 0 + ATTACK_COMPLEXITY_LOW = 1 + ATTACK_COMPLEXITY_HIGH = 2 + + class PrivilegesRequired(proto.Enum): + r"""This metric describes the level of privileges an attacker + must possess before successfully exploiting the vulnerability. + """ + PRIVILEGES_REQUIRED_UNSPECIFIED = 0 + PRIVILEGES_REQUIRED_NONE = 1 + PRIVILEGES_REQUIRED_LOW = 2 + PRIVILEGES_REQUIRED_HIGH = 3 + + class UserInteraction(proto.Enum): + r"""This metric captures the requirement for a human user, other + than the attacker, to participate in the successful compromise + of the vulnerable component. + """ + USER_INTERACTION_UNSPECIFIED = 0 + USER_INTERACTION_NONE = 1 + USER_INTERACTION_REQUIRED = 2 + + class Scope(proto.Enum): + r"""The Scope metric captures whether a vulnerability in one + vulnerable component impacts resources in components beyond its + security scope. + """ + SCOPE_UNSPECIFIED = 0 + SCOPE_UNCHANGED = 1 + SCOPE_CHANGED = 2 + + class Impact(proto.Enum): + r"""The Impact metrics capture the effects of a successfully + exploited vulnerability on the component that suffers the worst + outcome that is most directly and predictably associated with + the attack. + """ + IMPACT_UNSPECIFIED = 0 + IMPACT_HIGH = 1 + IMPACT_LOW = 2 + IMPACT_NONE = 3 + + base_score = proto.Field(proto.FLOAT, number=1,) + exploitability_score = proto.Field(proto.FLOAT, number=2,) + impact_score = proto.Field(proto.FLOAT, number=3,) + attack_vector = proto.Field(proto.ENUM, number=5, enum=AttackVector,) + attack_complexity = proto.Field(proto.ENUM, number=6, enum=AttackComplexity,) + privileges_required = proto.Field(proto.ENUM, number=7, enum=PrivilegesRequired,) + user_interaction = proto.Field(proto.ENUM, number=8, enum=UserInteraction,) + scope = proto.Field(proto.ENUM, number=9, enum=Scope,) + confidentiality_impact = proto.Field(proto.ENUM, number=10, enum=Impact,) + integrity_impact = proto.Field(proto.ENUM, number=11, enum=Impact,) + availability_impact = proto.Field(proto.ENUM, number=12, enum=Impact,) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-os-config/scripts/fixup_osconfig_v1alpha_keywords.py b/packages/google-cloud-os-config/scripts/fixup_osconfig_v1alpha_keywords.py new file mode 100644 index 000000000000..2e964d49a3be --- /dev/null +++ b/packages/google-cloud-os-config/scripts/fixup_osconfig_v1alpha_keywords.py @@ -0,0 +1,187 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class osconfigCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_os_policy_assignment': ('parent', 'os_policy_assignment', 'os_policy_assignment_id', ), + 'delete_os_policy_assignment': ('name', ), + 'get_instance_os_policies_compliance': ('name', ), + 'get_inventory': ('name', 'view', ), + 'get_os_policy_assignment': ('name', ), + 'get_vulnerability_report': ('name', ), + 'list_instance_os_policies_compliances': ('parent', 'page_size', 'page_token', 'filter', ), + 'list_inventories': ('parent', 'view', 'page_size', 'page_token', 'filter', ), + 'list_os_policy_assignment_revisions': ('name', 'page_size', 'page_token', ), + 'list_os_policy_assignments': ('parent', 'page_size', 'page_token', ), + 'list_vulnerability_reports': ('parent', 'page_size', 'page_token', 'filter', ), + 'update_os_policy_assignment': ('os_policy_assignment', 'update_mask', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: not a.keyword.value in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=osconfigCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the osconfig client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1alpha/__init__.py b/packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1alpha/__init__.py new file mode 100644 index 000000000000..4de65971c238 --- /dev/null +++ b/packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1alpha/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1alpha/test_os_config_zonal_service.py b/packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1alpha/test_os_config_zonal_service.py new file mode 100644 index 000000000000..ef7c5d202643 --- /dev/null +++ b/packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1alpha/test_os_config_zonal_service.py @@ -0,0 +1,5040 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.osconfig_v1alpha.services.os_config_zonal_service import ( + OsConfigZonalServiceAsyncClient, +) +from google.cloud.osconfig_v1alpha.services.os_config_zonal_service import ( + OsConfigZonalServiceClient, +) +from google.cloud.osconfig_v1alpha.services.os_config_zonal_service import pagers +from google.cloud.osconfig_v1alpha.services.os_config_zonal_service import transports +from google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.base import ( + _API_CORE_VERSION, +) +from google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.base import ( + _GOOGLE_AUTH_VERSION, +) +from google.cloud.osconfig_v1alpha.types import config_common +from google.cloud.osconfig_v1alpha.types import instance_os_policies_compliance +from google.cloud.osconfig_v1alpha.types import inventory +from google.cloud.osconfig_v1alpha.types import os_policy +from google.cloud.osconfig_v1alpha.types import os_policy_assignments +from google.cloud.osconfig_v1alpha.types import osconfig_common +from google.cloud.osconfig_v1alpha.types import vulnerability +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-api-core >= 1.26.0 is required: +# - Delete all the api-core and auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +requires_api_core_lt_1_26_0 = pytest.mark.skipif( + packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"), + reason="This test requires google-api-core < 1.26.0", +) + +requires_api_core_gte_1_26_0 = pytest.mark.skipif( + packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"), + reason="This test requires google-api-core >= 1.26.0", +) + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return ( + "foo.googleapis.com" + if ("localhost" in client.DEFAULT_ENDPOINT) + else client.DEFAULT_ENDPOINT + ) + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert OsConfigZonalServiceClient._get_default_mtls_endpoint(None) is None + assert ( + OsConfigZonalServiceClient._get_default_mtls_endpoint(api_endpoint) + == api_mtls_endpoint + ) + assert ( + OsConfigZonalServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) + == api_mtls_endpoint + ) + assert ( + OsConfigZonalServiceClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + OsConfigZonalServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + OsConfigZonalServiceClient._get_default_mtls_endpoint(non_googleapi) + == non_googleapi + ) + + +@pytest.mark.parametrize( + "client_class", [OsConfigZonalServiceClient, OsConfigZonalServiceAsyncClient,] +) +def test_os_config_zonal_service_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_info" + ) as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == "osconfig.googleapis.com:443" + + +@pytest.mark.parametrize( + "client_class", [OsConfigZonalServiceClient, OsConfigZonalServiceAsyncClient,] +) +def test_os_config_zonal_service_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_file" + ) as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == "osconfig.googleapis.com:443" + + +def test_os_config_zonal_service_client_get_transport_class(): + transport = OsConfigZonalServiceClient.get_transport_class() + available_transports = [ + transports.OsConfigZonalServiceGrpcTransport, + ] + assert transport in available_transports + + transport = OsConfigZonalServiceClient.get_transport_class("grpc") + assert transport == transports.OsConfigZonalServiceGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + OsConfigZonalServiceClient, + transports.OsConfigZonalServiceGrpcTransport, + "grpc", + ), + ( + OsConfigZonalServiceAsyncClient, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ], +) +@mock.patch.object( + OsConfigZonalServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(OsConfigZonalServiceClient), +) +@mock.patch.object( + OsConfigZonalServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(OsConfigZonalServiceAsyncClient), +) +def test_os_config_zonal_service_client_client_options( + client_class, transport_class, transport_name +): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(OsConfigZonalServiceClient, "get_transport_class") as gtc: + transport = transport_class(credentials=ga_credentials.AnonymousCredentials()) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(OsConfigZonalServiceClient, "get_transport_class") as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class() + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError): + client = client_class() + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,use_client_cert_env", + [ + ( + OsConfigZonalServiceClient, + transports.OsConfigZonalServiceGrpcTransport, + "grpc", + "true", + ), + ( + OsConfigZonalServiceAsyncClient, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + ( + OsConfigZonalServiceClient, + transports.OsConfigZonalServiceGrpcTransport, + "grpc", + "false", + ), + ( + OsConfigZonalServiceAsyncClient, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + ], +) +@mock.patch.object( + OsConfigZonalServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(OsConfigZonalServiceClient), +) +@mock.patch.object( + OsConfigZonalServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(OsConfigZonalServiceAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_os_config_zonal_service_client_mtls_env_auto( + client_class, transport_class, transport_name, use_client_cert_env +): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + options = client_options.ClientOptions( + client_cert_source=client_cert_source_callback + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=client_cert_source_callback, + ): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + OsConfigZonalServiceClient, + transports.OsConfigZonalServiceGrpcTransport, + "grpc", + ), + ( + OsConfigZonalServiceAsyncClient, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ], +) +def test_os_config_zonal_service_client_client_options_scopes( + client_class, transport_class, transport_name +): + # Check the case scopes are provided. + options = client_options.ClientOptions(scopes=["1", "2"],) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + OsConfigZonalServiceClient, + transports.OsConfigZonalServiceGrpcTransport, + "grpc", + ), + ( + OsConfigZonalServiceAsyncClient, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ], +) +def test_os_config_zonal_service_client_client_options_credentials_file( + client_class, transport_class, transport_name +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +def test_os_config_zonal_service_client_client_options_from_dict(): + with mock.patch( + "google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.OsConfigZonalServiceGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = OsConfigZonalServiceClient( + client_options={"api_endpoint": "squid.clam.whelk"} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +def test_create_os_policy_assignment( + transport: str = "grpc", + request_type=os_policy_assignments.CreateOSPolicyAssignmentRequest, +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.create_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.CreateOSPolicyAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_os_policy_assignment_from_dict(): + test_create_os_policy_assignment(request_type=dict) + + +def test_create_os_policy_assignment_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_os_policy_assignment), "__call__" + ) as call: + client.create_os_policy_assignment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.CreateOSPolicyAssignmentRequest() + + +@pytest.mark.asyncio +async def test_create_os_policy_assignment_async( + transport: str = "grpc_asyncio", + request_type=os_policy_assignments.CreateOSPolicyAssignmentRequest, +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.create_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.CreateOSPolicyAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_os_policy_assignment_async_from_dict(): + await test_create_os_policy_assignment_async(request_type=dict) + + +def test_create_os_policy_assignment_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.CreateOSPolicyAssignmentRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_os_policy_assignment), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.create_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_create_os_policy_assignment_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.CreateOSPolicyAssignmentRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_os_policy_assignment), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.create_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +def test_create_os_policy_assignment_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_os_policy_assignment( + parent="parent_value", + os_policy_assignment=os_policy_assignments.OSPolicyAssignment( + name="name_value" + ), + os_policy_assignment_id="os_policy_assignment_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + assert args[0].os_policy_assignment == os_policy_assignments.OSPolicyAssignment( + name="name_value" + ) + assert args[0].os_policy_assignment_id == "os_policy_assignment_id_value" + + +def test_create_os_policy_assignment_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_os_policy_assignment( + os_policy_assignments.CreateOSPolicyAssignmentRequest(), + parent="parent_value", + os_policy_assignment=os_policy_assignments.OSPolicyAssignment( + name="name_value" + ), + os_policy_assignment_id="os_policy_assignment_id_value", + ) + + +@pytest.mark.asyncio +async def test_create_os_policy_assignment_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_os_policy_assignment( + parent="parent_value", + os_policy_assignment=os_policy_assignments.OSPolicyAssignment( + name="name_value" + ), + os_policy_assignment_id="os_policy_assignment_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + assert args[0].os_policy_assignment == os_policy_assignments.OSPolicyAssignment( + name="name_value" + ) + assert args[0].os_policy_assignment_id == "os_policy_assignment_id_value" + + +@pytest.mark.asyncio +async def test_create_os_policy_assignment_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_os_policy_assignment( + os_policy_assignments.CreateOSPolicyAssignmentRequest(), + parent="parent_value", + os_policy_assignment=os_policy_assignments.OSPolicyAssignment( + name="name_value" + ), + os_policy_assignment_id="os_policy_assignment_id_value", + ) + + +def test_update_os_policy_assignment( + transport: str = "grpc", + request_type=os_policy_assignments.UpdateOSPolicyAssignmentRequest, +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.update_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.UpdateOSPolicyAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_os_policy_assignment_from_dict(): + test_update_os_policy_assignment(request_type=dict) + + +def test_update_os_policy_assignment_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_os_policy_assignment), "__call__" + ) as call: + client.update_os_policy_assignment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.UpdateOSPolicyAssignmentRequest() + + +@pytest.mark.asyncio +async def test_update_os_policy_assignment_async( + transport: str = "grpc_asyncio", + request_type=os_policy_assignments.UpdateOSPolicyAssignmentRequest, +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.update_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.UpdateOSPolicyAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_os_policy_assignment_async_from_dict(): + await test_update_os_policy_assignment_async(request_type=dict) + + +def test_update_os_policy_assignment_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.UpdateOSPolicyAssignmentRequest() + + request.os_policy_assignment.name = "os_policy_assignment.name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_os_policy_assignment), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.update_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "os_policy_assignment.name=os_policy_assignment.name/value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_update_os_policy_assignment_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.UpdateOSPolicyAssignmentRequest() + + request.os_policy_assignment.name = "os_policy_assignment.name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_os_policy_assignment), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.update_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "os_policy_assignment.name=os_policy_assignment.name/value", + ) in kw["metadata"] + + +def test_update_os_policy_assignment_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_os_policy_assignment( + os_policy_assignment=os_policy_assignments.OSPolicyAssignment( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].os_policy_assignment == os_policy_assignments.OSPolicyAssignment( + name="name_value" + ) + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=["paths_value"]) + + +def test_update_os_policy_assignment_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_os_policy_assignment( + os_policy_assignments.UpdateOSPolicyAssignmentRequest(), + os_policy_assignment=os_policy_assignments.OSPolicyAssignment( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.asyncio +async def test_update_os_policy_assignment_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_os_policy_assignment( + os_policy_assignment=os_policy_assignments.OSPolicyAssignment( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].os_policy_assignment == os_policy_assignments.OSPolicyAssignment( + name="name_value" + ) + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=["paths_value"]) + + +@pytest.mark.asyncio +async def test_update_os_policy_assignment_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_os_policy_assignment( + os_policy_assignments.UpdateOSPolicyAssignmentRequest(), + os_policy_assignment=os_policy_assignments.OSPolicyAssignment( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_get_os_policy_assignment( + transport: str = "grpc", + request_type=os_policy_assignments.GetOSPolicyAssignmentRequest, +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = os_policy_assignments.OSPolicyAssignment( + name="name_value", + description="description_value", + revision_id="revision_id_value", + rollout_state=os_policy_assignments.OSPolicyAssignment.RolloutState.IN_PROGRESS, + baseline=True, + deleted=True, + reconciling=True, + uid="uid_value", + ) + response = client.get_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.GetOSPolicyAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, os_policy_assignments.OSPolicyAssignment) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.revision_id == "revision_id_value" + assert ( + response.rollout_state + == os_policy_assignments.OSPolicyAssignment.RolloutState.IN_PROGRESS + ) + assert response.baseline is True + assert response.deleted is True + assert response.reconciling is True + assert response.uid == "uid_value" + + +def test_get_os_policy_assignment_from_dict(): + test_get_os_policy_assignment(request_type=dict) + + +def test_get_os_policy_assignment_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_os_policy_assignment), "__call__" + ) as call: + client.get_os_policy_assignment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.GetOSPolicyAssignmentRequest() + + +@pytest.mark.asyncio +async def test_get_os_policy_assignment_async( + transport: str = "grpc_asyncio", + request_type=os_policy_assignments.GetOSPolicyAssignmentRequest, +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + os_policy_assignments.OSPolicyAssignment( + name="name_value", + description="description_value", + revision_id="revision_id_value", + rollout_state=os_policy_assignments.OSPolicyAssignment.RolloutState.IN_PROGRESS, + baseline=True, + deleted=True, + reconciling=True, + uid="uid_value", + ) + ) + response = await client.get_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.GetOSPolicyAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, os_policy_assignments.OSPolicyAssignment) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.revision_id == "revision_id_value" + assert ( + response.rollout_state + == os_policy_assignments.OSPolicyAssignment.RolloutState.IN_PROGRESS + ) + assert response.baseline is True + assert response.deleted is True + assert response.reconciling is True + assert response.uid == "uid_value" + + +@pytest.mark.asyncio +async def test_get_os_policy_assignment_async_from_dict(): + await test_get_os_policy_assignment_async(request_type=dict) + + +def test_get_os_policy_assignment_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.GetOSPolicyAssignmentRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_os_policy_assignment), "__call__" + ) as call: + call.return_value = os_policy_assignments.OSPolicyAssignment() + client.get_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_os_policy_assignment_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.GetOSPolicyAssignmentRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_os_policy_assignment), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + os_policy_assignments.OSPolicyAssignment() + ) + await client.get_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_get_os_policy_assignment_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = os_policy_assignments.OSPolicyAssignment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_os_policy_assignment(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_get_os_policy_assignment_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_os_policy_assignment( + os_policy_assignments.GetOSPolicyAssignmentRequest(), name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_os_policy_assignment_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = os_policy_assignments.OSPolicyAssignment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + os_policy_assignments.OSPolicyAssignment() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_os_policy_assignment(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_get_os_policy_assignment_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_os_policy_assignment( + os_policy_assignments.GetOSPolicyAssignmentRequest(), name="name_value", + ) + + +def test_list_os_policy_assignments( + transport: str = "grpc", + request_type=os_policy_assignments.ListOSPolicyAssignmentsRequest, +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = os_policy_assignments.ListOSPolicyAssignmentsResponse( + next_page_token="next_page_token_value", + ) + response = client.list_os_policy_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.ListOSPolicyAssignmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListOSPolicyAssignmentsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_os_policy_assignments_from_dict(): + test_list_os_policy_assignments(request_type=dict) + + +def test_list_os_policy_assignments_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), "__call__" + ) as call: + client.list_os_policy_assignments() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.ListOSPolicyAssignmentsRequest() + + +@pytest.mark.asyncio +async def test_list_os_policy_assignments_async( + transport: str = "grpc_asyncio", + request_type=os_policy_assignments.ListOSPolicyAssignmentsRequest, +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + os_policy_assignments.ListOSPolicyAssignmentsResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_os_policy_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.ListOSPolicyAssignmentsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListOSPolicyAssignmentsAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_os_policy_assignments_async_from_dict(): + await test_list_os_policy_assignments_async(request_type=dict) + + +def test_list_os_policy_assignments_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.ListOSPolicyAssignmentsRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), "__call__" + ) as call: + call.return_value = os_policy_assignments.ListOSPolicyAssignmentsResponse() + client.list_os_policy_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_os_policy_assignments_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.ListOSPolicyAssignmentsRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + os_policy_assignments.ListOSPolicyAssignmentsResponse() + ) + await client.list_os_policy_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +def test_list_os_policy_assignments_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = os_policy_assignments.ListOSPolicyAssignmentsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_os_policy_assignments(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +def test_list_os_policy_assignments_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_os_policy_assignments( + os_policy_assignments.ListOSPolicyAssignmentsRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_os_policy_assignments_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = os_policy_assignments.ListOSPolicyAssignmentsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + os_policy_assignments.ListOSPolicyAssignmentsResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_os_policy_assignments(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +@pytest.mark.asyncio +async def test_list_os_policy_assignments_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_os_policy_assignments( + os_policy_assignments.ListOSPolicyAssignmentsRequest(), + parent="parent_value", + ) + + +def test_list_os_policy_assignments_pager(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + next_page_token="abc", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[], next_page_token="def", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[os_policy_assignments.OSPolicyAssignment(),], + next_page_token="ghi", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_os_policy_assignments(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all( + isinstance(i, os_policy_assignments.OSPolicyAssignment) for i in results + ) + + +def test_list_os_policy_assignments_pages(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + next_page_token="abc", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[], next_page_token="def", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[os_policy_assignments.OSPolicyAssignment(),], + next_page_token="ghi", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + ), + RuntimeError, + ) + pages = list(client.list_os_policy_assignments(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_os_policy_assignments_async_pager(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + next_page_token="abc", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[], next_page_token="def", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[os_policy_assignments.OSPolicyAssignment(),], + next_page_token="ghi", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_os_policy_assignments(request={},) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all( + isinstance(i, os_policy_assignments.OSPolicyAssignment) for i in responses + ) + + +@pytest.mark.asyncio +async def test_list_os_policy_assignments_async_pages(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignments), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + next_page_token="abc", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[], next_page_token="def", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[os_policy_assignments.OSPolicyAssignment(),], + next_page_token="ghi", + ), + os_policy_assignments.ListOSPolicyAssignmentsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_os_policy_assignments(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_list_os_policy_assignment_revisions( + transport: str = "grpc", + request_type=os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest, +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + next_page_token="next_page_token_value", + ) + response = client.list_os_policy_assignment_revisions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListOSPolicyAssignmentRevisionsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_os_policy_assignment_revisions_from_dict(): + test_list_os_policy_assignment_revisions(request_type=dict) + + +def test_list_os_policy_assignment_revisions_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), "__call__" + ) as call: + client.list_os_policy_assignment_revisions() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest() + + +@pytest.mark.asyncio +async def test_list_os_policy_assignment_revisions_async( + transport: str = "grpc_asyncio", + request_type=os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest, +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_os_policy_assignment_revisions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListOSPolicyAssignmentRevisionsAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_os_policy_assignment_revisions_async_from_dict(): + await test_list_os_policy_assignment_revisions_async(request_type=dict) + + +def test_list_os_policy_assignment_revisions_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), "__call__" + ) as call: + call.return_value = ( + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse() + ) + client.list_os_policy_assignment_revisions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_os_policy_assignment_revisions_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse() + ) + await client.list_os_policy_assignment_revisions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_list_os_policy_assignment_revisions_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = ( + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_os_policy_assignment_revisions(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_list_os_policy_assignment_revisions_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_os_policy_assignment_revisions( + os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_list_os_policy_assignment_revisions_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = ( + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse() + ) + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_os_policy_assignment_revisions(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_list_os_policy_assignment_revisions_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_os_policy_assignment_revisions( + os_policy_assignments.ListOSPolicyAssignmentRevisionsRequest(), + name="name_value", + ) + + +def test_list_os_policy_assignment_revisions_pager(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + next_page_token="abc", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[], next_page_token="def", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[os_policy_assignments.OSPolicyAssignment(),], + next_page_token="ghi", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", ""),)), + ) + pager = client.list_os_policy_assignment_revisions(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all( + isinstance(i, os_policy_assignments.OSPolicyAssignment) for i in results + ) + + +def test_list_os_policy_assignment_revisions_pages(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + next_page_token="abc", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[], next_page_token="def", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[os_policy_assignments.OSPolicyAssignment(),], + next_page_token="ghi", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + ), + RuntimeError, + ) + pages = list(client.list_os_policy_assignment_revisions(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_os_policy_assignment_revisions_async_pager(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + next_page_token="abc", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[], next_page_token="def", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[os_policy_assignments.OSPolicyAssignment(),], + next_page_token="ghi", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_os_policy_assignment_revisions(request={},) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all( + isinstance(i, os_policy_assignments.OSPolicyAssignment) for i in responses + ) + + +@pytest.mark.asyncio +async def test_list_os_policy_assignment_revisions_async_pages(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_os_policy_assignment_revisions), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + next_page_token="abc", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[], next_page_token="def", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[os_policy_assignments.OSPolicyAssignment(),], + next_page_token="ghi", + ), + os_policy_assignments.ListOSPolicyAssignmentRevisionsResponse( + os_policy_assignments=[ + os_policy_assignments.OSPolicyAssignment(), + os_policy_assignments.OSPolicyAssignment(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in ( + await client.list_os_policy_assignment_revisions(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_delete_os_policy_assignment( + transport: str = "grpc", + request_type=os_policy_assignments.DeleteOSPolicyAssignmentRequest, +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.delete_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.DeleteOSPolicyAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_os_policy_assignment_from_dict(): + test_delete_os_policy_assignment(request_type=dict) + + +def test_delete_os_policy_assignment_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_os_policy_assignment), "__call__" + ) as call: + client.delete_os_policy_assignment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.DeleteOSPolicyAssignmentRequest() + + +@pytest.mark.asyncio +async def test_delete_os_policy_assignment_async( + transport: str = "grpc_asyncio", + request_type=os_policy_assignments.DeleteOSPolicyAssignmentRequest, +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.delete_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == os_policy_assignments.DeleteOSPolicyAssignmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_os_policy_assignment_async_from_dict(): + await test_delete_os_policy_assignment_async(request_type=dict) + + +def test_delete_os_policy_assignment_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.DeleteOSPolicyAssignmentRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_os_policy_assignment), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.delete_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_delete_os_policy_assignment_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = os_policy_assignments.DeleteOSPolicyAssignmentRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_os_policy_assignment), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.delete_os_policy_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_delete_os_policy_assignment_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_os_policy_assignment(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_delete_os_policy_assignment_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_os_policy_assignment( + os_policy_assignments.DeleteOSPolicyAssignmentRequest(), name="name_value", + ) + + +@pytest.mark.asyncio +async def test_delete_os_policy_assignment_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_os_policy_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_os_policy_assignment(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_delete_os_policy_assignment_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_os_policy_assignment( + os_policy_assignments.DeleteOSPolicyAssignmentRequest(), name="name_value", + ) + + +def test_get_instance_os_policies_compliance( + transport: str = "grpc", + request_type=instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest, +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_instance_os_policies_compliance), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = instance_os_policies_compliance.InstanceOSPoliciesCompliance( + name="name_value", + instance="instance_value", + state=config_common.OSPolicyComplianceState.COMPLIANT, + detailed_state="detailed_state_value", + detailed_state_reason="detailed_state_reason_value", + last_compliance_run_id="last_compliance_run_id_value", + ) + response = client.get_instance_os_policies_compliance(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert ( + args[0] + == instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest() + ) + + # Establish that the response is the type that we expect. + assert isinstance( + response, instance_os_policies_compliance.InstanceOSPoliciesCompliance + ) + assert response.name == "name_value" + assert response.instance == "instance_value" + assert response.state == config_common.OSPolicyComplianceState.COMPLIANT + assert response.detailed_state == "detailed_state_value" + assert response.detailed_state_reason == "detailed_state_reason_value" + assert response.last_compliance_run_id == "last_compliance_run_id_value" + + +def test_get_instance_os_policies_compliance_from_dict(): + test_get_instance_os_policies_compliance(request_type=dict) + + +def test_get_instance_os_policies_compliance_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_instance_os_policies_compliance), "__call__" + ) as call: + client.get_instance_os_policies_compliance() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert ( + args[0] + == instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest() + ) + + +@pytest.mark.asyncio +async def test_get_instance_os_policies_compliance_async( + transport: str = "grpc_asyncio", + request_type=instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest, +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_instance_os_policies_compliance), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + instance_os_policies_compliance.InstanceOSPoliciesCompliance( + name="name_value", + instance="instance_value", + state=config_common.OSPolicyComplianceState.COMPLIANT, + detailed_state="detailed_state_value", + detailed_state_reason="detailed_state_reason_value", + last_compliance_run_id="last_compliance_run_id_value", + ) + ) + response = await client.get_instance_os_policies_compliance(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert ( + args[0] + == instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest() + ) + + # Establish that the response is the type that we expect. + assert isinstance( + response, instance_os_policies_compliance.InstanceOSPoliciesCompliance + ) + assert response.name == "name_value" + assert response.instance == "instance_value" + assert response.state == config_common.OSPolicyComplianceState.COMPLIANT + assert response.detailed_state == "detailed_state_value" + assert response.detailed_state_reason == "detailed_state_reason_value" + assert response.last_compliance_run_id == "last_compliance_run_id_value" + + +@pytest.mark.asyncio +async def test_get_instance_os_policies_compliance_async_from_dict(): + await test_get_instance_os_policies_compliance_async(request_type=dict) + + +def test_get_instance_os_policies_compliance_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_instance_os_policies_compliance), "__call__" + ) as call: + call.return_value = ( + instance_os_policies_compliance.InstanceOSPoliciesCompliance() + ) + client.get_instance_os_policies_compliance(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_instance_os_policies_compliance_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_instance_os_policies_compliance), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + instance_os_policies_compliance.InstanceOSPoliciesCompliance() + ) + await client.get_instance_os_policies_compliance(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_get_instance_os_policies_compliance_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_instance_os_policies_compliance), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = ( + instance_os_policies_compliance.InstanceOSPoliciesCompliance() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_instance_os_policies_compliance(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_get_instance_os_policies_compliance_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_instance_os_policies_compliance( + instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_instance_os_policies_compliance_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_instance_os_policies_compliance), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = ( + instance_os_policies_compliance.InstanceOSPoliciesCompliance() + ) + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + instance_os_policies_compliance.InstanceOSPoliciesCompliance() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_instance_os_policies_compliance(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_get_instance_os_policies_compliance_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_instance_os_policies_compliance( + instance_os_policies_compliance.GetInstanceOSPoliciesComplianceRequest(), + name="name_value", + ) + + +def test_list_instance_os_policies_compliances( + transport: str = "grpc", + request_type=instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest, +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + next_page_token="next_page_token_value", + ) + response = client.list_instance_os_policies_compliances(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert ( + args[0] + == instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest() + ) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListInstanceOSPoliciesCompliancesPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_instance_os_policies_compliances_from_dict(): + test_list_instance_os_policies_compliances(request_type=dict) + + +def test_list_instance_os_policies_compliances_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), "__call__" + ) as call: + client.list_instance_os_policies_compliances() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert ( + args[0] + == instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest() + ) + + +@pytest.mark.asyncio +async def test_list_instance_os_policies_compliances_async( + transport: str = "grpc_asyncio", + request_type=instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest, +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_instance_os_policies_compliances(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert ( + args[0] + == instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest() + ) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListInstanceOSPoliciesCompliancesAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_instance_os_policies_compliances_async_from_dict(): + await test_list_instance_os_policies_compliances_async(request_type=dict) + + +def test_list_instance_os_policies_compliances_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), "__call__" + ) as call: + call.return_value = ( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse() + ) + client.list_instance_os_policies_compliances(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_instance_os_policies_compliances_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse() + ) + await client.list_instance_os_policies_compliances(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +def test_list_instance_os_policies_compliances_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = ( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_instance_os_policies_compliances(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +def test_list_instance_os_policies_compliances_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_instance_os_policies_compliances( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_instance_os_policies_compliances_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = ( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse() + ) + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_instance_os_policies_compliances( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +@pytest.mark.asyncio +async def test_list_instance_os_policies_compliances_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_instance_os_policies_compliances( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesRequest(), + parent="parent_value", + ) + + +def test_list_instance_os_policies_compliances_pager(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + next_page_token="abc", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[], next_page_token="def", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + next_page_token="ghi", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_instance_os_policies_compliances(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all( + isinstance(i, instance_os_policies_compliance.InstanceOSPoliciesCompliance) + for i in results + ) + + +def test_list_instance_os_policies_compliances_pages(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + next_page_token="abc", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[], next_page_token="def", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + next_page_token="ghi", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + ), + RuntimeError, + ) + pages = list(client.list_instance_os_policies_compliances(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_instance_os_policies_compliances_async_pager(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + next_page_token="abc", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[], next_page_token="def", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + next_page_token="ghi", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_instance_os_policies_compliances(request={},) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all( + isinstance(i, instance_os_policies_compliance.InstanceOSPoliciesCompliance) + for i in responses + ) + + +@pytest.mark.asyncio +async def test_list_instance_os_policies_compliances_async_pages(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_instance_os_policies_compliances), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + next_page_token="abc", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[], next_page_token="def", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + next_page_token="ghi", + ), + instance_os_policies_compliance.ListInstanceOSPoliciesCompliancesResponse( + instance_os_policies_compliances=[ + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + instance_os_policies_compliance.InstanceOSPoliciesCompliance(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in ( + await client.list_instance_os_policies_compliances(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_get_inventory( + transport: str = "grpc", request_type=inventory.GetInventoryRequest +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_inventory), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = inventory.Inventory(name="name_value",) + response = client.get_inventory(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == inventory.GetInventoryRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, inventory.Inventory) + assert response.name == "name_value" + + +def test_get_inventory_from_dict(): + test_get_inventory(request_type=dict) + + +def test_get_inventory_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_inventory), "__call__") as call: + client.get_inventory() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == inventory.GetInventoryRequest() + + +@pytest.mark.asyncio +async def test_get_inventory_async( + transport: str = "grpc_asyncio", request_type=inventory.GetInventoryRequest +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_inventory), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + inventory.Inventory(name="name_value",) + ) + response = await client.get_inventory(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == inventory.GetInventoryRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, inventory.Inventory) + assert response.name == "name_value" + + +@pytest.mark.asyncio +async def test_get_inventory_async_from_dict(): + await test_get_inventory_async(request_type=dict) + + +def test_get_inventory_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = inventory.GetInventoryRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_inventory), "__call__") as call: + call.return_value = inventory.Inventory() + client.get_inventory(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_inventory_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = inventory.GetInventoryRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_inventory), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(inventory.Inventory()) + await client.get_inventory(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_get_inventory_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_inventory), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = inventory.Inventory() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_inventory(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_get_inventory_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_inventory( + inventory.GetInventoryRequest(), name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_inventory_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_inventory), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = inventory.Inventory() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(inventory.Inventory()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_inventory(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_get_inventory_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_inventory( + inventory.GetInventoryRequest(), name="name_value", + ) + + +def test_list_inventories( + transport: str = "grpc", request_type=inventory.ListInventoriesRequest +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_inventories), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = inventory.ListInventoriesResponse( + next_page_token="next_page_token_value", + ) + response = client.list_inventories(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == inventory.ListInventoriesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListInventoriesPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_inventories_from_dict(): + test_list_inventories(request_type=dict) + + +def test_list_inventories_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_inventories), "__call__") as call: + client.list_inventories() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == inventory.ListInventoriesRequest() + + +@pytest.mark.asyncio +async def test_list_inventories_async( + transport: str = "grpc_asyncio", request_type=inventory.ListInventoriesRequest +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_inventories), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + inventory.ListInventoriesResponse(next_page_token="next_page_token_value",) + ) + response = await client.list_inventories(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == inventory.ListInventoriesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListInventoriesAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_inventories_async_from_dict(): + await test_list_inventories_async(request_type=dict) + + +def test_list_inventories_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = inventory.ListInventoriesRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_inventories), "__call__") as call: + call.return_value = inventory.ListInventoriesResponse() + client.list_inventories(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_inventories_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = inventory.ListInventoriesRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_inventories), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + inventory.ListInventoriesResponse() + ) + await client.list_inventories(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +def test_list_inventories_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_inventories), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = inventory.ListInventoriesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_inventories(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +def test_list_inventories_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_inventories( + inventory.ListInventoriesRequest(), parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_inventories_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_inventories), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = inventory.ListInventoriesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + inventory.ListInventoriesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_inventories(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +@pytest.mark.asyncio +async def test_list_inventories_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_inventories( + inventory.ListInventoriesRequest(), parent="parent_value", + ) + + +def test_list_inventories_pager(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_inventories), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + inventory.ListInventoriesResponse( + inventories=[ + inventory.Inventory(), + inventory.Inventory(), + inventory.Inventory(), + ], + next_page_token="abc", + ), + inventory.ListInventoriesResponse(inventories=[], next_page_token="def",), + inventory.ListInventoriesResponse( + inventories=[inventory.Inventory(),], next_page_token="ghi", + ), + inventory.ListInventoriesResponse( + inventories=[inventory.Inventory(), inventory.Inventory(),], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_inventories(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, inventory.Inventory) for i in results) + + +def test_list_inventories_pages(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_inventories), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + inventory.ListInventoriesResponse( + inventories=[ + inventory.Inventory(), + inventory.Inventory(), + inventory.Inventory(), + ], + next_page_token="abc", + ), + inventory.ListInventoriesResponse(inventories=[], next_page_token="def",), + inventory.ListInventoriesResponse( + inventories=[inventory.Inventory(),], next_page_token="ghi", + ), + inventory.ListInventoriesResponse( + inventories=[inventory.Inventory(), inventory.Inventory(),], + ), + RuntimeError, + ) + pages = list(client.list_inventories(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_inventories_async_pager(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_inventories), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + inventory.ListInventoriesResponse( + inventories=[ + inventory.Inventory(), + inventory.Inventory(), + inventory.Inventory(), + ], + next_page_token="abc", + ), + inventory.ListInventoriesResponse(inventories=[], next_page_token="def",), + inventory.ListInventoriesResponse( + inventories=[inventory.Inventory(),], next_page_token="ghi", + ), + inventory.ListInventoriesResponse( + inventories=[inventory.Inventory(), inventory.Inventory(),], + ), + RuntimeError, + ) + async_pager = await client.list_inventories(request={},) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, inventory.Inventory) for i in responses) + + +@pytest.mark.asyncio +async def test_list_inventories_async_pages(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_inventories), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + inventory.ListInventoriesResponse( + inventories=[ + inventory.Inventory(), + inventory.Inventory(), + inventory.Inventory(), + ], + next_page_token="abc", + ), + inventory.ListInventoriesResponse(inventories=[], next_page_token="def",), + inventory.ListInventoriesResponse( + inventories=[inventory.Inventory(),], next_page_token="ghi", + ), + inventory.ListInventoriesResponse( + inventories=[inventory.Inventory(), inventory.Inventory(),], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_inventories(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_get_vulnerability_report( + transport: str = "grpc", request_type=vulnerability.GetVulnerabilityReportRequest +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_vulnerability_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = vulnerability.VulnerabilityReport(name="name_value",) + response = client.get_vulnerability_report(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == vulnerability.GetVulnerabilityReportRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, vulnerability.VulnerabilityReport) + assert response.name == "name_value" + + +def test_get_vulnerability_report_from_dict(): + test_get_vulnerability_report(request_type=dict) + + +def test_get_vulnerability_report_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_vulnerability_report), "__call__" + ) as call: + client.get_vulnerability_report() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == vulnerability.GetVulnerabilityReportRequest() + + +@pytest.mark.asyncio +async def test_get_vulnerability_report_async( + transport: str = "grpc_asyncio", + request_type=vulnerability.GetVulnerabilityReportRequest, +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_vulnerability_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + vulnerability.VulnerabilityReport(name="name_value",) + ) + response = await client.get_vulnerability_report(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == vulnerability.GetVulnerabilityReportRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, vulnerability.VulnerabilityReport) + assert response.name == "name_value" + + +@pytest.mark.asyncio +async def test_get_vulnerability_report_async_from_dict(): + await test_get_vulnerability_report_async(request_type=dict) + + +def test_get_vulnerability_report_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = vulnerability.GetVulnerabilityReportRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_vulnerability_report), "__call__" + ) as call: + call.return_value = vulnerability.VulnerabilityReport() + client.get_vulnerability_report(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_vulnerability_report_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = vulnerability.GetVulnerabilityReportRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_vulnerability_report), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + vulnerability.VulnerabilityReport() + ) + await client.get_vulnerability_report(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_get_vulnerability_report_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_vulnerability_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = vulnerability.VulnerabilityReport() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_vulnerability_report(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_get_vulnerability_report_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_vulnerability_report( + vulnerability.GetVulnerabilityReportRequest(), name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_vulnerability_report_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_vulnerability_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = vulnerability.VulnerabilityReport() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + vulnerability.VulnerabilityReport() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_vulnerability_report(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_get_vulnerability_report_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_vulnerability_report( + vulnerability.GetVulnerabilityReportRequest(), name="name_value", + ) + + +def test_list_vulnerability_reports( + transport: str = "grpc", request_type=vulnerability.ListVulnerabilityReportsRequest +): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = vulnerability.ListVulnerabilityReportsResponse( + next_page_token="next_page_token_value", + ) + response = client.list_vulnerability_reports(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == vulnerability.ListVulnerabilityReportsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListVulnerabilityReportsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_vulnerability_reports_from_dict(): + test_list_vulnerability_reports(request_type=dict) + + +def test_list_vulnerability_reports_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), "__call__" + ) as call: + client.list_vulnerability_reports() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == vulnerability.ListVulnerabilityReportsRequest() + + +@pytest.mark.asyncio +async def test_list_vulnerability_reports_async( + transport: str = "grpc_asyncio", + request_type=vulnerability.ListVulnerabilityReportsRequest, +): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + vulnerability.ListVulnerabilityReportsResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_vulnerability_reports(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == vulnerability.ListVulnerabilityReportsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListVulnerabilityReportsAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_vulnerability_reports_async_from_dict(): + await test_list_vulnerability_reports_async(request_type=dict) + + +def test_list_vulnerability_reports_field_headers(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = vulnerability.ListVulnerabilityReportsRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), "__call__" + ) as call: + call.return_value = vulnerability.ListVulnerabilityReportsResponse() + client.list_vulnerability_reports(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_vulnerability_reports_field_headers_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = vulnerability.ListVulnerabilityReportsRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + vulnerability.ListVulnerabilityReportsResponse() + ) + await client.list_vulnerability_reports(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +def test_list_vulnerability_reports_flattened(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = vulnerability.ListVulnerabilityReportsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_vulnerability_reports(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +def test_list_vulnerability_reports_flattened_error(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_vulnerability_reports( + vulnerability.ListVulnerabilityReportsRequest(), parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_vulnerability_reports_flattened_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = vulnerability.ListVulnerabilityReportsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + vulnerability.ListVulnerabilityReportsResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_vulnerability_reports(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +@pytest.mark.asyncio +async def test_list_vulnerability_reports_flattened_error_async(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_vulnerability_reports( + vulnerability.ListVulnerabilityReportsRequest(), parent="parent_value", + ) + + +def test_list_vulnerability_reports_pager(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[ + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + ], + next_page_token="abc", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[], next_page_token="def", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[vulnerability.VulnerabilityReport(),], + next_page_token="ghi", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[ + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_vulnerability_reports(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, vulnerability.VulnerabilityReport) for i in results) + + +def test_list_vulnerability_reports_pages(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[ + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + ], + next_page_token="abc", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[], next_page_token="def", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[vulnerability.VulnerabilityReport(),], + next_page_token="ghi", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[ + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + ], + ), + RuntimeError, + ) + pages = list(client.list_vulnerability_reports(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_vulnerability_reports_async_pager(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[ + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + ], + next_page_token="abc", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[], next_page_token="def", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[vulnerability.VulnerabilityReport(),], + next_page_token="ghi", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[ + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_vulnerability_reports(request={},) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, vulnerability.VulnerabilityReport) for i in responses) + + +@pytest.mark.asyncio +async def test_list_vulnerability_reports_async_pages(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_vulnerability_reports), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[ + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + ], + next_page_token="abc", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[], next_page_token="def", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[vulnerability.VulnerabilityReport(),], + next_page_token="ghi", + ), + vulnerability.ListVulnerabilityReportsResponse( + vulnerability_reports=[ + vulnerability.VulnerabilityReport(), + vulnerability.VulnerabilityReport(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_vulnerability_reports(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.OsConfigZonalServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.OsConfigZonalServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OsConfigZonalServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.OsConfigZonalServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OsConfigZonalServiceClient( + client_options={"scopes": ["1", "2"]}, transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.OsConfigZonalServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = OsConfigZonalServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.OsConfigZonalServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.OsConfigZonalServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OsConfigZonalServiceGrpcTransport, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance(client.transport, transports.OsConfigZonalServiceGrpcTransport,) + + +def test_os_config_zonal_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.OsConfigZonalServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_os_config_zonal_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.OsConfigZonalServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.OsConfigZonalServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "create_os_policy_assignment", + "update_os_policy_assignment", + "get_os_policy_assignment", + "list_os_policy_assignments", + "list_os_policy_assignment_revisions", + "delete_os_policy_assignment", + "get_instance_os_policies_compliance", + "list_instance_os_policies_compliances", + "get_inventory", + "list_inventories", + "get_vulnerability_report", + "list_vulnerability_reports", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + +@requires_google_auth_gte_1_25_0 +def test_os_config_zonal_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.OsConfigZonalServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.OsConfigZonalServiceTransport( + credentials_file="credentials.json", quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_os_config_zonal_service_base_transport_with_credentials_file_old_google_auth(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.OsConfigZonalServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.OsConfigZonalServiceTransport( + credentials_file="credentials.json", quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +def test_os_config_zonal_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.cloud.osconfig_v1alpha.services.os_config_zonal_service.transports.OsConfigZonalServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.OsConfigZonalServiceTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_os_config_zonal_service_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + OsConfigZonalServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_os_config_zonal_service_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + OsConfigZonalServiceClient() + adc.assert_called_once_with( + scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OsConfigZonalServiceGrpcTransport, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_os_config_zonal_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OsConfigZonalServiceGrpcTransport, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_os_config_zonal_service_transport_auth_adc_old_google_auth(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus") + adc.assert_called_once_with( + scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.OsConfigZonalServiceGrpcTransport, grpc_helpers), + (transports.OsConfigZonalServiceGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +@requires_api_core_gte_1_26_0 +def test_os_config_zonal_service_transport_create_channel( + transport_class, grpc_helpers +): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "osconfig.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + scopes=["1", "2"], + default_host="osconfig.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.OsConfigZonalServiceGrpcTransport, grpc_helpers), + (transports.OsConfigZonalServiceGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +@requires_api_core_lt_1_26_0 +def test_os_config_zonal_service_transport_create_channel_old_api_core( + transport_class, grpc_helpers +): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus") + + create_channel.assert_called_with( + "osconfig.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + scopes=("https://www.googleapis.com/auth/cloud-platform",), + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.OsConfigZonalServiceGrpcTransport, grpc_helpers), + (transports.OsConfigZonalServiceGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +@requires_api_core_lt_1_26_0 +def test_os_config_zonal_service_transport_create_channel_user_scopes( + transport_class, grpc_helpers +): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "osconfig.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + scopes=["1", "2"], + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OsConfigZonalServiceGrpcTransport, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + ], +) +def test_os_config_zonal_service_grpc_transport_client_cert_source_for_mtls( + transport_class, +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds, + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=("https://www.googleapis.com/auth/cloud-platform",), + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback, + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, private_key=expected_key + ) + + +def test_os_config_zonal_service_host_no_port(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="osconfig.googleapis.com" + ), + ) + assert client.transport._host == "osconfig.googleapis.com:443" + + +def test_os_config_zonal_service_host_with_port(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="osconfig.googleapis.com:8000" + ), + ) + assert client.transport._host == "osconfig.googleapis.com:8000" + + +def test_os_config_zonal_service_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.OsConfigZonalServiceGrpcTransport( + host="squid.clam.whelk", channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_os_config_zonal_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.OsConfigZonalServiceGrpcAsyncIOTransport( + host="squid.clam.whelk", channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.OsConfigZonalServiceGrpcTransport, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + ], +) +def test_os_config_zonal_service_transport_channel_mtls_with_client_cert_source( + transport_class, +): + with mock.patch( + "grpc.ssl_channel_credentials", autospec=True + ) as grpc_ssl_channel_cred: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=("https://www.googleapis.com/auth/cloud-platform",), + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.OsConfigZonalServiceGrpcTransport, + transports.OsConfigZonalServiceGrpcAsyncIOTransport, + ], +) +def test_os_config_zonal_service_transport_channel_mtls_with_adc(transport_class): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=("https://www.googleapis.com/auth/cloud-platform",), + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_os_config_zonal_service_grpc_lro_client(): + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance(transport.operations_client, operations_v1.OperationsClient,) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_os_config_zonal_service_grpc_lro_async_client(): + client = OsConfigZonalServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance(transport.operations_client, operations_v1.OperationsAsyncClient,) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_instance_path(): + project = "squid" + location = "clam" + instance = "whelk" + expected = "projects/{project}/locations/{location}/instances/{instance}".format( + project=project, location=location, instance=instance, + ) + actual = OsConfigZonalServiceClient.instance_path(project, location, instance) + assert expected == actual + + +def test_parse_instance_path(): + expected = { + "project": "octopus", + "location": "oyster", + "instance": "nudibranch", + } + path = OsConfigZonalServiceClient.instance_path(**expected) + + # Check that the path construction is reversible. + actual = OsConfigZonalServiceClient.parse_instance_path(path) + assert expected == actual + + +def test_instance_os_policies_compliance_path(): + project = "cuttlefish" + location = "mussel" + instance = "winkle" + expected = "projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}".format( + project=project, location=location, instance=instance, + ) + actual = OsConfigZonalServiceClient.instance_os_policies_compliance_path( + project, location, instance + ) + assert expected == actual + + +def test_parse_instance_os_policies_compliance_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "instance": "abalone", + } + path = OsConfigZonalServiceClient.instance_os_policies_compliance_path(**expected) + + # Check that the path construction is reversible. + actual = OsConfigZonalServiceClient.parse_instance_os_policies_compliance_path(path) + assert expected == actual + + +def test_inventory_path(): + project = "squid" + location = "clam" + instance = "whelk" + expected = "projects/{project}/locations/{location}/instances/{instance}/inventory".format( + project=project, location=location, instance=instance, + ) + actual = OsConfigZonalServiceClient.inventory_path(project, location, instance) + assert expected == actual + + +def test_parse_inventory_path(): + expected = { + "project": "octopus", + "location": "oyster", + "instance": "nudibranch", + } + path = OsConfigZonalServiceClient.inventory_path(**expected) + + # Check that the path construction is reversible. + actual = OsConfigZonalServiceClient.parse_inventory_path(path) + assert expected == actual + + +def test_os_policy_assignment_path(): + project = "cuttlefish" + location = "mussel" + os_policy_assignment = "winkle" + expected = "projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}".format( + project=project, location=location, os_policy_assignment=os_policy_assignment, + ) + actual = OsConfigZonalServiceClient.os_policy_assignment_path( + project, location, os_policy_assignment + ) + assert expected == actual + + +def test_parse_os_policy_assignment_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "os_policy_assignment": "abalone", + } + path = OsConfigZonalServiceClient.os_policy_assignment_path(**expected) + + # Check that the path construction is reversible. + actual = OsConfigZonalServiceClient.parse_os_policy_assignment_path(path) + assert expected == actual + + +def test_vulnerability_report_path(): + project = "squid" + location = "clam" + instance = "whelk" + expected = "projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport".format( + project=project, location=location, instance=instance, + ) + actual = OsConfigZonalServiceClient.vulnerability_report_path( + project, location, instance + ) + assert expected == actual + + +def test_parse_vulnerability_report_path(): + expected = { + "project": "octopus", + "location": "oyster", + "instance": "nudibranch", + } + path = OsConfigZonalServiceClient.vulnerability_report_path(**expected) + + # Check that the path construction is reversible. + actual = OsConfigZonalServiceClient.parse_vulnerability_report_path(path) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "cuttlefish" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = OsConfigZonalServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "mussel", + } + path = OsConfigZonalServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = OsConfigZonalServiceClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "winkle" + expected = "folders/{folder}".format(folder=folder,) + actual = OsConfigZonalServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nautilus", + } + path = OsConfigZonalServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = OsConfigZonalServiceClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "scallop" + expected = "organizations/{organization}".format(organization=organization,) + actual = OsConfigZonalServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "abalone", + } + path = OsConfigZonalServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = OsConfigZonalServiceClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "squid" + expected = "projects/{project}".format(project=project,) + actual = OsConfigZonalServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "clam", + } + path = OsConfigZonalServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = OsConfigZonalServiceClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "whelk" + location = "octopus" + expected = "projects/{project}/locations/{location}".format( + project=project, location=location, + ) + actual = OsConfigZonalServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + } + path = OsConfigZonalServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = OsConfigZonalServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object( + transports.OsConfigZonalServiceTransport, "_prep_wrapped_messages" + ) as prep: + client = OsConfigZonalServiceClient( + credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.OsConfigZonalServiceTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = OsConfigZonalServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, + ) + prep.assert_called_once_with(client_info)