diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/async_client.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/async_client.py index 4f4277bd663f..8c1f6a16fa77 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/async_client.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/async_client.py @@ -56,6 +56,7 @@ class OsConfigServiceAsyncClient: """OS Config API + The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/client.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/client.py index c6628df514a2..8dd31e20bd91 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/client.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/client.py @@ -98,6 +98,7 @@ def get_transport_class( class OsConfigServiceClient(metaclass=OsConfigServiceClientMeta): """OS Config API + The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/grpc.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/grpc.py index 452915a74991..cd722e47de2e 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/grpc.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/grpc.py @@ -32,6 +32,7 @@ class OsConfigServiceGrpcTransport(OsConfigServiceTransport): """gRPC backend transport for OsConfigService. OS Config API + The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/grpc_asyncio.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/grpc_asyncio.py index 6e3630287152..cc8eefc26957 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/grpc_asyncio.py @@ -33,6 +33,7 @@ class OsConfigServiceGrpcAsyncIOTransport(OsConfigServiceTransport): """gRPC AsyncIO backend transport for OsConfigService. OS Config API + The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/rest.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/rest.py index 75398fd04a88..8abc50fd2f12 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/rest.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_service/transports/rest.py @@ -452,6 +452,7 @@ class OsConfigServiceRestTransport(OsConfigServiceTransport): """REST backend transport for OsConfigService. OS Config API + The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/async_client.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/async_client.py index b21f62d908f0..5782efe52b92 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/async_client.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/async_client.py @@ -64,6 +64,7 @@ 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. @@ -329,7 +330,6 @@ async def sample_create_os_policy_assignment(): parent (:class:`str`): Required. The parent resource name in the form: - projects/{project}/locations/{location} This corresponds to the ``parent`` field @@ -1294,6 +1294,7 @@ async def sample_list_os_policy_assignment_reports(): A response message for listing OS Policy assignment reports including the page of results and page token. + Iterating over this object will yield results and resolve additional pages automatically. @@ -1537,6 +1538,7 @@ async def sample_list_inventories(): 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. @@ -1780,6 +1782,7 @@ async def sample_list_vulnerability_reports(): 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. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/client.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/client.py index 76c6e90861de..fa7ca3141eeb 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/client.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/client.py @@ -106,6 +106,7 @@ def get_transport_class( 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. @@ -645,7 +646,6 @@ def sample_create_os_policy_assignment(): parent (str): Required. The parent resource name in the form: - projects/{project}/locations/{location} This corresponds to the ``parent`` field @@ -1636,6 +1636,7 @@ def sample_list_os_policy_assignment_reports(): A response message for listing OS Policy assignment reports including the page of results and page token. + Iterating over this object will yield results and resolve additional pages automatically. @@ -1883,6 +1884,7 @@ def sample_list_inventories(): 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. @@ -2126,6 +2128,7 @@ def sample_list_vulnerability_reports(): 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. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/grpc.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/grpc.py index 1f746a48881a..75553caa0b98 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/grpc.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/grpc.py @@ -37,6 +37,7 @@ 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. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/grpc_asyncio.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/grpc_asyncio.py index b5138a4ed750..bc0dc79e7a1f 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/grpc_asyncio.py @@ -38,6 +38,7 @@ 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. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/rest.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/rest.py index 7c012cdc3047..a8af97f0935c 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/rest.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/services/os_config_zonal_service/transports/rest.py @@ -486,6 +486,7 @@ class OsConfigZonalServiceRestTransport(OsConfigZonalServiceTransport): """REST 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. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/types/os_policy_assignment_reports.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/types/os_policy_assignment_reports.py index 5fead57c16c7..8d6b62e96bd6 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/types/os_policy_assignment_reports.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/types/os_policy_assignment_reports.py @@ -172,6 +172,7 @@ class OSPolicyAssignmentReport(proto.Message): Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM. + This ID is logged by the OS Config agent while applying the OS policies associated with this assignment on the VM. NOTE: If the service is @@ -232,10 +233,12 @@ class ComplianceState(proto.Enum): exact reason for the policy to be in this compliance state. COMPLIANT (1): Policy is compliant. + The policy is compliant if all the underlying resources are also compliant. NON_COMPLIANT (2): Policy is non-compliant. + The policy is non-compliant if one or more underlying resources are non-compliant. """ @@ -329,6 +332,7 @@ class Type(proto.Enum): Re-checks the status of the desired state. This check is done for a resource after the enforcement of all OS policies. + This step is used to determine the final desired state status for the resource. It accounts for any resources that might have drifted from their diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1/types/os_policy_assignments.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1/types/os_policy_assignments.py index 78d1c2d3f256..692332fd6347 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1/types/os_policy_assignments.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1/types/os_policy_assignments.py @@ -168,6 +168,7 @@ class LabelSet(proto.Message): class InstanceFilter(proto.Message): r"""Filters to select target VMs for an assignment. + If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them. @@ -182,11 +183,13 @@ class InstanceFilter(proto.Message): included if any of the label sets are applicable for the VM. exclusion_labels (MutableSequence[google.cloud.osconfig_v1.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. inventories (MutableSequence[google.cloud.osconfig_v1.types.OSPolicyAssignment.InstanceFilter.Inventory]): List of inventories to select VMs. + A VM is selected if its inventory data matches at least one of the following inventories. """ @@ -420,9 +423,7 @@ class CreateOSPolicyAssignmentRequest(proto.Message): Attributes: parent (str): Required. The parent resource name in the - form: - - projects/{project}/locations/{location} + form: projects/{project}/locations/{location} os_policy_assignment (google.cloud.osconfig_v1.types.OSPolicyAssignment): Required. The OS policy assignment to be created. 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 index 786c430c8c1e..1fb901aff9c5 100644 --- 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 @@ -67,6 +67,7 @@ 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. @@ -338,7 +339,6 @@ async def sample_create_os_policy_assignment(): parent (:class:`str`): Required. The parent resource name in the form: - projects/{project}/locations/{location} This corresponds to the ``parent`` field @@ -1307,6 +1307,7 @@ async def sample_list_instance_os_policies_compliances(): 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. @@ -1578,6 +1579,7 @@ async def sample_list_os_policy_assignment_reports(): A response message for listing OS Policy assignment reports including the page of results and page token. + Iterating over this object will yield results and resolve additional pages automatically. @@ -1821,6 +1823,7 @@ async def sample_list_inventories(): 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. @@ -2064,6 +2067,7 @@ async def sample_list_vulnerability_reports(): 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. 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 index 416b57593e74..8f6ce4661e9b 100644 --- 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 @@ -109,6 +109,7 @@ def get_transport_class( 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. @@ -670,7 +671,6 @@ def sample_create_os_policy_assignment(): parent (str): Required. The parent resource name in the form: - projects/{project}/locations/{location} This corresponds to the ``parent`` field @@ -1666,6 +1666,7 @@ def sample_list_instance_os_policies_compliances(): 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. @@ -1944,6 +1945,7 @@ def sample_list_os_policy_assignment_reports(): A response message for listing OS Policy assignment reports including the page of results and page token. + Iterating over this object will yield results and resolve additional pages automatically. @@ -2191,6 +2193,7 @@ def sample_list_inventories(): 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. @@ -2434,6 +2437,7 @@ def sample_list_vulnerability_reports(): 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. 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 index e3beb3d2bba7..113eec466914 100644 --- 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 @@ -38,6 +38,7 @@ 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. 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 index 703c40fd7bd0..76cc64b1ff4f 100644 --- 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 @@ -39,6 +39,7 @@ 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. diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/rest.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/rest.py index cd8ee82386e6..f0983d6bac74 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/rest.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/services/os_config_zonal_service/transports/rest.py @@ -556,6 +556,7 @@ class OsConfigZonalServiceRestTransport(OsConfigZonalServiceTransport): """REST 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. 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 index 45d0daefd5df..7fa9905ae22a 100644 --- 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 @@ -88,6 +88,7 @@ class Type(proto.Enum): Re-check desired state status for a resource after enforcement of all resources in the current configuration run. + This step is used to determine the final desired state status for the resource. It accounts for any resources that might have drifted from their diff --git a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy_assignment_reports.py b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy_assignment_reports.py index c5a14e5dca8c..9f11874181e2 100644 --- a/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy_assignment_reports.py +++ b/packages/google-cloud-os-config/google/cloud/osconfig_v1alpha/types/os_policy_assignment_reports.py @@ -172,6 +172,7 @@ class OSPolicyAssignmentReport(proto.Message): Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM. + This ID is logged by the OS Config agent while applying the OS policies associated with this assignment on the VM. NOTE: If the service is @@ -232,10 +233,12 @@ class ComplianceState(proto.Enum): exact reason for the policy to be in this compliance state. COMPLIANT (1): Policy is compliant. + The policy is compliant if all the underlying resources are also compliant. NON_COMPLIANT (2): Policy is non-compliant. + The policy is non-compliant if one or more underlying resources are non-compliant. """ @@ -329,6 +332,7 @@ class Type(proto.Enum): Re-checks the status of the desired state. This check is done for a resource after the enforcement of all OS policies. + This step is used to determine the final desired state status for the resource. It accounts for any resources that might have drifted from their 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 index 9fdc2d92d223..cf26b16cb936 100644 --- 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 @@ -168,6 +168,7 @@ class LabelSet(proto.Message): class InstanceFilter(proto.Message): r"""Filters to select target VMs for an assignment. + If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them. @@ -186,11 +187,13 @@ class InstanceFilter(proto.Message): included if any of the label sets are applicable for the VM. exclusion_labels (MutableSequence[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. inventories (MutableSequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.InstanceFilter.Inventory]): List of inventories to select VMs. + A VM is selected if its inventory data matches at least one of the following inventories. """ @@ -428,9 +431,7 @@ class CreateOSPolicyAssignmentRequest(proto.Message): Attributes: parent (str): Required. The parent resource name in the - form: - - projects/{project}/locations/{location} + form: projects/{project}/locations/{location} os_policy_assignment (google.cloud.osconfig_v1alpha.types.OSPolicyAssignment): Required. The OS policy assignment to be created. diff --git a/packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1/test_os_config_zonal_service.py b/packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1/test_os_config_zonal_service.py index 79980331ae12..8a068793b89d 100644 --- a/packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1/test_os_config_zonal_service.py +++ b/packages/google-cloud-os-config/tests/unit/gapic/osconfig_v1/test_os_config_zonal_service.py @@ -41,7 +41,7 @@ import google.auth from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError -from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore from google.oauth2 import service_account from google.protobuf import duration_pb2 # type: ignore from google.protobuf import empty_pb2 # type: ignore 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 index d8dec88439e1..f2249e1b398d 100644 --- 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 @@ -41,7 +41,7 @@ import google.auth from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError -from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore from google.oauth2 import service_account from google.protobuf import duration_pb2 # type: ignore from google.protobuf import empty_pb2 # type: ignore