Skip to content

Commit

Permalink
docs: [google-cloud-cloudcontrolspartner] Mark the accessApprovalRequ…
Browse files Browse the repository at this point in the history
…ests.list method as deprecated (#12815)

BEGIN_COMMIT_OVERRIDE
docs: Mark the accessApprovalRequests.list method as deprecated

END_COMMIT_OVERRIDE

- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 645046820

Source-Link:
googleapis/googleapis@52630ea

Source-Link:
googleapis/googleapis-gen@4dec2d0
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNsb3VkY29udHJvbHNwYXJ0bmVyLy5Pd2xCb3QueWFtbCIsImgiOiI0ZGVjMmQwZDdmZmZkY2MwZDRlN2ZmMWZjYmUxOGNkN2IzNGZjZTA5In0=

BEGIN_NESTED_COMMIT
docs: [google-cloud-cloudcontrolspartner] Mark the
accessApprovalRequests.list method as deprecated
PiperOrigin-RevId: 645007312

Source-Link:
googleapis/googleapis@ed2491e

Source-Link:
googleapis/googleapis-gen@086dd13
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNsb3VkY29udHJvbHNwYXJ0bmVyLy5Pd2xCb3QueWFtbCIsImgiOiIwODZkZDEzZDBlMzE4MzM1ZWRlMTE3ZTAxMDgyOTZlZDlhZWNmMWUwIn0=
END_NESTED_COMMIT

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: ohmayr <omairnaveed@ymail.com>
  • Loading branch information
3 people committed Jun 24, 2024
1 parent 2e0f94e commit 0520183
Show file tree
Hide file tree
Showing 17 changed files with 94 additions and 103 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
Type,
Union,
)
import warnings

from google.api_core import exceptions as core_exceptions
from google.api_core import gapic_v1
Expand Down Expand Up @@ -979,7 +980,8 @@ async def list_access_approval_requests(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListAccessApprovalRequestsAsyncPager:
r"""Lists access requests associated with a workload
r"""Deprecated: Only returns access approval requests
directly associated with an assured workload folder.
.. code-block:: python
Expand Down Expand Up @@ -1034,6 +1036,11 @@ async def sample_list_access_approval_requests():
automatically.
"""
warnings.warn(
"CloudControlsPartnerCoreAsyncClient.list_access_approval_requests is deprecated",
DeprecationWarning,
)

# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1471,7 +1471,8 @@ def list_access_approval_requests(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListAccessApprovalRequestsPager:
r"""Lists access requests associated with a workload
r"""Deprecated: Only returns access approval requests
directly associated with an assured workload folder.
.. code-block:: python
Expand Down Expand Up @@ -1526,6 +1527,11 @@ def sample_list_access_approval_requests():
automatically.
"""
warnings.warn(
"CloudControlsPartnerCoreClient.list_access_approval_requests is deprecated",
DeprecationWarning,
)

# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,8 @@ def list_access_approval_requests(
]:
r"""Return a callable for the list access approval requests method over gRPC.
Lists access requests associated with a workload
Deprecated: Only returns access approval requests
directly associated with an assured workload folder.
Returns:
Callable[[~.ListAccessApprovalRequestsRequest],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,8 @@ def list_access_approval_requests(
]:
r"""Return a callable for the list access approval requests method over gRPC.
Lists access requests associated with a workload
Deprecated: Only returns access approval requests
directly associated with an assured workload folder.
Returns:
Callable[[~.ListAccessApprovalRequestsRequest],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
Type,
Union,
)
import warnings

from google.api_core import exceptions as core_exceptions
from google.api_core import gapic_v1
Expand Down Expand Up @@ -348,8 +349,7 @@ async def sample_get_workload():
workload.
name (:class:`str`):
Required. Format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -455,10 +455,8 @@ async def sample_list_workloads():
request (Optional[Union[google.cloud.cloudcontrolspartner_v1beta.types.ListWorkloadsRequest, dict]]):
The request object. Request to list customer workloads.
parent (:class:`str`):
Required. Parent resource
Format:
organizations/{organization}/locations/{location}/customers/{customer}
Required. Parent resource Format:
``organizations/{organization}/locations/{location}/customers/{customer}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -575,8 +573,7 @@ async def sample_get_customer():
The request object. Message for getting a customer
name (:class:`str`):
Required. Format:
organizations/{organization}/locations/{location}/customers/{customer}
``organizations/{organization}/locations/{location}/customers/{customer}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -682,9 +679,8 @@ async def sample_list_customers():
request (Optional[Union[google.cloud.cloudcontrolspartner_v1beta.types.ListCustomersRequest, dict]]):
The request object. Request to list customers
parent (:class:`str`):
Required. Parent resource
Format:
organizations/{organization}/locations/{location}
Required. Parent resource Format:
``organizations/{organization}/locations/{location}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -802,8 +798,7 @@ async def sample_get_ekm_connections():
connections associated with a workload
name (:class:`str`):
Required. Format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -910,9 +905,8 @@ async def sample_get_partner_permissions():
The request object. Request for getting the partner
permissions granted for a workload
name (:class:`str`):
Required. Name of the resource to get
in the format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions
Required. Name of the resource to get in the format:
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -986,7 +980,8 @@ async def list_access_approval_requests(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListAccessApprovalRequestsAsyncPager:
r"""Lists access requests associated with a workload
r"""Deprecated: Only returns access approval requests
directly associated with an assured workload folder.
.. code-block:: python
Expand Down Expand Up @@ -1020,10 +1015,8 @@ async def sample_list_access_approval_requests():
The request object. Request for getting the access
requests associated with a workload.
parent (:class:`str`):
Required. Parent resource
Format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
Required. Parent resource Format:
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand All @@ -1043,6 +1036,11 @@ async def sample_list_access_approval_requests():
automatically.
"""
warnings.warn(
"CloudControlsPartnerCoreAsyncClient.list_access_approval_requests is deprecated",
DeprecationWarning,
)

# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
Expand Down Expand Up @@ -1144,7 +1142,7 @@ async def sample_get_partner():
The request object. Message for getting a Partner
name (:class:`str`):
Required. Format:
organizations/{organization}/locations/{location}/partner
``organizations/{organization}/locations/{location}/partner``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -858,8 +858,7 @@ def sample_get_workload():
workload.
name (str):
Required. Format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -962,10 +961,8 @@ def sample_list_workloads():
request (Union[google.cloud.cloudcontrolspartner_v1beta.types.ListWorkloadsRequest, dict]):
The request object. Request to list customer workloads.
parent (str):
Required. Parent resource
Format:
organizations/{organization}/locations/{location}/customers/{customer}
Required. Parent resource Format:
``organizations/{organization}/locations/{location}/customers/{customer}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1079,8 +1076,7 @@ def sample_get_customer():
The request object. Message for getting a customer
name (str):
Required. Format:
organizations/{organization}/locations/{location}/customers/{customer}
``organizations/{organization}/locations/{location}/customers/{customer}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1183,9 +1179,8 @@ def sample_list_customers():
request (Union[google.cloud.cloudcontrolspartner_v1beta.types.ListCustomersRequest, dict]):
The request object. Request to list customers
parent (str):
Required. Parent resource
Format:
organizations/{organization}/locations/{location}
Required. Parent resource Format:
``organizations/{organization}/locations/{location}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1300,8 +1295,7 @@ def sample_get_ekm_connections():
connections associated with a workload
name (str):
Required. Format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1405,9 +1399,8 @@ def sample_get_partner_permissions():
The request object. Request for getting the partner
permissions granted for a workload
name (str):
Required. Name of the resource to get
in the format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions
Required. Name of the resource to get in the format:
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1478,7 +1471,8 @@ def list_access_approval_requests(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListAccessApprovalRequestsPager:
r"""Lists access requests associated with a workload
r"""Deprecated: Only returns access approval requests
directly associated with an assured workload folder.
.. code-block:: python
Expand Down Expand Up @@ -1512,10 +1506,8 @@ def sample_list_access_approval_requests():
The request object. Request for getting the access
requests associated with a workload.
parent (str):
Required. Parent resource
Format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
Required. Parent resource Format:
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand All @@ -1535,6 +1527,11 @@ def sample_list_access_approval_requests():
automatically.
"""
warnings.warn(
"CloudControlsPartnerCoreClient.list_access_approval_requests is deprecated",
DeprecationWarning,
)

# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
Expand Down Expand Up @@ -1635,7 +1632,7 @@ def sample_get_partner():
The request object. Message for getting a Partner
name (str):
Required. Format:
organizations/{organization}/locations/{location}/partner
``organizations/{organization}/locations/{location}/partner``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,8 @@ def list_access_approval_requests(
]:
r"""Return a callable for the list access approval requests method over gRPC.
Lists access requests associated with a workload
Deprecated: Only returns access approval requests
directly associated with an assured workload folder.
Returns:
Callable[[~.ListAccessApprovalRequestsRequest],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,8 @@ def list_access_approval_requests(
]:
r"""Return a callable for the list access approval requests method over gRPC.
Lists access requests associated with a workload
Deprecated: Only returns access approval requests
directly associated with an assured workload folder.
Returns:
Callable[[~.ListAccessApprovalRequestsRequest],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -327,9 +327,8 @@ async def sample_list_violations():
The request object. Message for requesting list of
Violations
parent (:class:`str`):
Required. Parent resource
Format
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
Required. Parent resource Format
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -446,8 +445,7 @@ async def sample_get_violation():
The request object. Message for getting a Violation
name (:class:`str`):
Required. Format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -755,9 +755,8 @@ def sample_list_violations():
The request object. Message for requesting list of
Violations
parent (str):
Required. Parent resource
Format
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
Required. Parent resource Format
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -871,8 +870,7 @@ def sample_get_violation():
The request object. Message for getting a Violation
name (str):
Required. Format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class AccessApprovalRequest(proto.Message):
Attributes:
name (str):
Identifier. Format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request}.
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request}``
request_time (google.protobuf.timestamp_pb2.Timestamp):
The time at which approval was requested.
requested_reason (google.cloud.cloudcontrolspartner_v1beta.types.AccessReason):
Expand Down Expand Up @@ -77,10 +77,8 @@ class ListAccessApprovalRequestsRequest(proto.Message):
Attributes:
parent (str):
Required. Parent resource
Format:
organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
Required. Parent resource Format:
``organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}``
page_size (int):
Optional. The maximum number of access
requests to return. The service may return fewer
Expand Down
Loading

0 comments on commit 0520183

Please sign in to comment.