Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

docs: Minor formatting #295

Merged
merged 2 commits into from
Sep 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
"""
Expand Down Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions google/cloud/osconfig_v1/types/os_policy_assignments.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
"""
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions google/cloud/osconfig_v1alpha/types/config_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
"""
Expand Down Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions google/cloud/osconfig_v1alpha/types/os_policy_assignments.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
"""
Expand Down Expand Up @@ -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.
Expand Down
Loading