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

docs: Fix formatting of request arg in docstring #201

Merged
merged 2 commits into from
Mar 23, 2023
Merged

docs: Fix formatting of request arg in docstring #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2c3e08
docs: Fix formatting of request arg in docstring
gcf-owl-bot[bot] Mar 22, 2023
0f2f680
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 22, 2023
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
45 changes: 15 additions & 30 deletions google/cloud/domains_v1/services/domains/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,8 +261,7 @@ async def sample_search_domains():

Args:
request (Optional[Union[google.cloud.domains_v1.types.SearchDomainsRequest, dict]]):
The request object. Request for the `SearchDomains`
method.
The request object. Request for the ``SearchDomains`` method.
location (:class:`str`):
Required. The location. Must be in the format
``projects/*/locations/*``.
Expand Down Expand Up @@ -376,8 +375,7 @@ async def sample_retrieve_register_parameters():

Args:
request (Optional[Union[google.cloud.domains_v1.types.RetrieveRegisterParametersRequest, dict]]):
The request object. Request for the
`RetrieveRegisterParameters` method.
The request object. Request for the ``RetrieveRegisterParameters`` method.
location (:class:`str`):
Required. The location. Must be in the format
``projects/*/locations/*``.
Expand Down Expand Up @@ -516,8 +514,7 @@ async def sample_register_domain():

Args:
request (Optional[Union[google.cloud.domains_v1.types.RegisterDomainRequest, dict]]):
The request object. Request for the `RegisterDomain`
method.
The request object. Request for the ``RegisterDomain`` method.
parent (:class:`str`):
Required. The parent resource of the ``Registration``.
Must be in the format ``projects/*/locations/*``.
Expand Down Expand Up @@ -677,8 +674,7 @@ async def sample_retrieve_transfer_parameters():

Args:
request (Optional[Union[google.cloud.domains_v1.types.RetrieveTransferParametersRequest, dict]]):
The request object. Request for the
`RetrieveTransferParameters` method.
The request object. Request for the ``RetrieveTransferParameters`` method.
location (:class:`str`):
Required. The location. Must be in the format
``projects/*/locations/*``.
Expand Down Expand Up @@ -828,8 +824,7 @@ async def sample_transfer_domain():

Args:
request (Optional[Union[google.cloud.domains_v1.types.TransferDomainRequest, dict]]):
The request object. Request for the `TransferDomain`
method.
The request object. Request for the ``TransferDomain`` method.
parent (:class:`str`):
Required. The parent resource of the ``Registration``.
Must be in the format ``projects/*/locations/*``.
Expand Down Expand Up @@ -1000,8 +995,7 @@ async def sample_list_registrations():

Args:
request (Optional[Union[google.cloud.domains_v1.types.ListRegistrationsRequest, dict]]):
The request object. Request for the `ListRegistrations`
method.
The request object. Request for the ``ListRegistrations`` method.
parent (:class:`str`):
Required. The project and location from which to list
``Registration``\ s, specified in the format
Expand Down Expand Up @@ -1114,8 +1108,7 @@ async def sample_get_registration():

Args:
request (Optional[Union[google.cloud.domains_v1.types.GetRegistrationRequest, dict]]):
The request object. Request for the `GetRegistration`
method.
The request object. Request for the ``GetRegistration`` method.
name (:class:`str`):
Required. The name of the ``Registration`` to get, in
the format ``projects/*/locations/*/registrations/*``.
Expand Down Expand Up @@ -1248,8 +1241,7 @@ async def sample_update_registration():

Args:
request (Optional[Union[google.cloud.domains_v1.types.UpdateRegistrationRequest, dict]]):
The request object. Request for the `UpdateRegistration`
method.
The request object. Request for the ``UpdateRegistration`` method.
registration (:class:`google.cloud.domains_v1.types.Registration`):
Fields of the ``Registration`` to update.
This corresponds to the ``registration`` field
Expand Down Expand Up @@ -1399,8 +1391,7 @@ async def sample_configure_management_settings():

Args:
request (Optional[Union[google.cloud.domains_v1.types.ConfigureManagementSettingsRequest, dict]]):
The request object. Request for the
`ConfigureManagementSettings` method.
The request object. Request for the ``ConfigureManagementSettings`` method.
registration (:class:`str`):
Required. The name of the ``Registration`` whose
management settings are being updated, in the format
Expand Down Expand Up @@ -1558,8 +1549,7 @@ async def sample_configure_dns_settings():

Args:
request (Optional[Union[google.cloud.domains_v1.types.ConfigureDnsSettingsRequest, dict]]):
The request object. Request for the
`ConfigureDnsSettings` method.
The request object. Request for the ``ConfigureDnsSettings`` method.
registration (:class:`str`):
Required. The name of the ``Registration`` whose DNS
settings are being updated, in the format
Expand Down Expand Up @@ -1725,8 +1715,7 @@ async def sample_configure_contact_settings():

Args:
request (Optional[Union[google.cloud.domains_v1.types.ConfigureContactSettingsRequest, dict]]):
The request object. Request for the
`ConfigureContactSettings` method.
The request object. Request for the ``ConfigureContactSettings`` method.
registration (:class:`str`):
Required. The name of the ``Registration`` whose contact
settings are being updated, in the format
Expand Down Expand Up @@ -1891,8 +1880,7 @@ async def sample_export_registration():

Args:
request (Optional[Union[google.cloud.domains_v1.types.ExportRegistrationRequest, dict]]):
The request object. Request for the `ExportRegistration`
method.
The request object. Request for the ``ExportRegistration`` method.
name (:class:`str`):
Required. The name of the ``Registration`` to export, in
the format ``projects/*/locations/*/registrations/*``.
Expand Down Expand Up @@ -2048,8 +2036,7 @@ async def sample_delete_registration():

Args:
request (Optional[Union[google.cloud.domains_v1.types.DeleteRegistrationRequest, dict]]):
The request object. Request for the `DeleteRegistration`
method.
The request object. Request for the ``DeleteRegistration`` method.
name (:class:`str`):
Required. The name of the ``Registration`` to delete, in
the format ``projects/*/locations/*/registrations/*``.
Expand Down Expand Up @@ -2172,8 +2159,7 @@ async def sample_retrieve_authorization_code():

Args:
request (Optional[Union[google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest, dict]]):
The request object. Request for the
`RetrieveAuthorizationCode` method.
The request object. Request for the ``RetrieveAuthorizationCode`` method.
registration (:class:`str`):
Required. The name of the ``Registration`` whose
authorization code is being retrieved, in the format
Expand Down Expand Up @@ -2279,8 +2265,7 @@ async def sample_reset_authorization_code():

Args:
request (Optional[Union[google.cloud.domains_v1.types.ResetAuthorizationCodeRequest, dict]]):
The request object. Request for the
`ResetAuthorizationCode` method.
The request object. Request for the ``ResetAuthorizationCode`` method.
registration (:class:`str`):
Required. The name of the ``Registration`` whose
authorization code is being reset, in the format
Expand Down
45 changes: 15 additions & 30 deletions google/cloud/domains_v1/services/domains/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,8 +496,7 @@ def sample_search_domains():

Args:
request (Union[google.cloud.domains_v1.types.SearchDomainsRequest, dict]):
The request object. Request for the `SearchDomains`
method.
The request object. Request for the ``SearchDomains`` method.
location (str):
Required. The location. Must be in the format
``projects/*/locations/*``.
Expand Down Expand Up @@ -611,8 +610,7 @@ def sample_retrieve_register_parameters():

Args:
request (Union[google.cloud.domains_v1.types.RetrieveRegisterParametersRequest, dict]):
The request object. Request for the
`RetrieveRegisterParameters` method.
The request object. Request for the ``RetrieveRegisterParameters`` method.
location (str):
Required. The location. Must be in the format
``projects/*/locations/*``.
Expand Down Expand Up @@ -753,8 +751,7 @@ def sample_register_domain():

Args:
request (Union[google.cloud.domains_v1.types.RegisterDomainRequest, dict]):
The request object. Request for the `RegisterDomain`
method.
The request object. Request for the ``RegisterDomain`` method.
parent (str):
Required. The parent resource of the ``Registration``.
Must be in the format ``projects/*/locations/*``.
Expand Down Expand Up @@ -914,8 +911,7 @@ def sample_retrieve_transfer_parameters():

Args:
request (Union[google.cloud.domains_v1.types.RetrieveTransferParametersRequest, dict]):
The request object. Request for the
`RetrieveTransferParameters` method.
The request object. Request for the ``RetrieveTransferParameters`` method.
location (str):
Required. The location. Must be in the format
``projects/*/locations/*``.
Expand Down Expand Up @@ -1067,8 +1063,7 @@ def sample_transfer_domain():

Args:
request (Union[google.cloud.domains_v1.types.TransferDomainRequest, dict]):
The request object. Request for the `TransferDomain`
method.
The request object. Request for the ``TransferDomain`` method.
parent (str):
Required. The parent resource of the ``Registration``.
Must be in the format ``projects/*/locations/*``.
Expand Down Expand Up @@ -1239,8 +1234,7 @@ def sample_list_registrations():

Args:
request (Union[google.cloud.domains_v1.types.ListRegistrationsRequest, dict]):
The request object. Request for the `ListRegistrations`
method.
The request object. Request for the ``ListRegistrations`` method.
parent (str):
Required. The project and location from which to list
``Registration``\ s, specified in the format
Expand Down Expand Up @@ -1353,8 +1347,7 @@ def sample_get_registration():

Args:
request (Union[google.cloud.domains_v1.types.GetRegistrationRequest, dict]):
The request object. Request for the `GetRegistration`
method.
The request object. Request for the ``GetRegistration`` method.
name (str):
Required. The name of the ``Registration`` to get, in
the format ``projects/*/locations/*/registrations/*``.
Expand Down Expand Up @@ -1487,8 +1480,7 @@ def sample_update_registration():

Args:
request (Union[google.cloud.domains_v1.types.UpdateRegistrationRequest, dict]):
The request object. Request for the `UpdateRegistration`
method.
The request object. Request for the ``UpdateRegistration`` method.
registration (google.cloud.domains_v1.types.Registration):
Fields of the ``Registration`` to update.
This corresponds to the ``registration`` field
Expand Down Expand Up @@ -1638,8 +1630,7 @@ def sample_configure_management_settings():

Args:
request (Union[google.cloud.domains_v1.types.ConfigureManagementSettingsRequest, dict]):
The request object. Request for the
`ConfigureManagementSettings` method.
The request object. Request for the ``ConfigureManagementSettings`` method.
registration (str):
Required. The name of the ``Registration`` whose
management settings are being updated, in the format
Expand Down Expand Up @@ -1799,8 +1790,7 @@ def sample_configure_dns_settings():

Args:
request (Union[google.cloud.domains_v1.types.ConfigureDnsSettingsRequest, dict]):
The request object. Request for the
`ConfigureDnsSettings` method.
The request object. Request for the ``ConfigureDnsSettings`` method.
registration (str):
Required. The name of the ``Registration`` whose DNS
settings are being updated, in the format
Expand Down Expand Up @@ -1966,8 +1956,7 @@ def sample_configure_contact_settings():

Args:
request (Union[google.cloud.domains_v1.types.ConfigureContactSettingsRequest, dict]):
The request object. Request for the
`ConfigureContactSettings` method.
The request object. Request for the ``ConfigureContactSettings`` method.
registration (str):
Required. The name of the ``Registration`` whose contact
settings are being updated, in the format
Expand Down Expand Up @@ -2134,8 +2123,7 @@ def sample_export_registration():

Args:
request (Union[google.cloud.domains_v1.types.ExportRegistrationRequest, dict]):
The request object. Request for the `ExportRegistration`
method.
The request object. Request for the ``ExportRegistration`` method.
name (str):
Required. The name of the ``Registration`` to export, in
the format ``projects/*/locations/*/registrations/*``.
Expand Down Expand Up @@ -2291,8 +2279,7 @@ def sample_delete_registration():

Args:
request (Union[google.cloud.domains_v1.types.DeleteRegistrationRequest, dict]):
The request object. Request for the `DeleteRegistration`
method.
The request object. Request for the ``DeleteRegistration`` method.
name (str):
Required. The name of the ``Registration`` to delete, in
the format ``projects/*/locations/*/registrations/*``.
Expand Down Expand Up @@ -2415,8 +2402,7 @@ def sample_retrieve_authorization_code():

Args:
request (Union[google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest, dict]):
The request object. Request for the
`RetrieveAuthorizationCode` method.
The request object. Request for the ``RetrieveAuthorizationCode`` method.
registration (str):
Required. The name of the ``Registration`` whose
authorization code is being retrieved, in the format
Expand Down Expand Up @@ -2524,8 +2510,7 @@ def sample_reset_authorization_code():

Args:
request (Union[google.cloud.domains_v1.types.ResetAuthorizationCodeRequest, dict]):
The request object. Request for the
`ResetAuthorizationCode` method.
The request object. Request for the ``ResetAuthorizationCode`` method.
registration (str):
Required. The name of the ``Registration`` whose
authorization code is being reset, in the format
Expand Down
Loading