Skip to content

Commit

Permalink
feat: [google-cloud-gdchardwaremanagement] add an order type field to…
Browse files Browse the repository at this point in the history 
… distinguish a fulfillment request from a sales inquiry (#13090)

BEGIN_COMMIT_OVERRIDE
feat: add an order type field to distinguish a fulfillment request from
a sales inquiry
feat: add support to mark comments as read or unread
feat: rename zone state signal READY_FOR_SITE_TURNUP to
FACTORY_TURNUP_CHECKS_PASSED
docs: clarify how access_times are used
END_COMMIT_OVERRIDE

- [ ] Regenerate this pull request now.

feat: add support to mark comments as read or unread
feat: rename zone state signal READY_FOR_SITE_TURNUP to
FACTORY_TURNUP_CHECKS_PASSED
docs: clarify how access_times are used

PiperOrigin-RevId: 675275984

Source-Link:
googleapis/googleapis@fde103c

Source-Link:
googleapis/googleapis-gen@a58cb74
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWdkY2hhcmR3YXJlbWFuYWdlbWVudC8uT3dsQm90LnlhbWwiLCJoIjoiYTU4Y2I3NDQ5ZmNjYWE3ZTljNzZiZDVhMTM3ZTc5YWVmYTQ1ZWRlNyJ9

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: ohmayr <omairnaveed@ymail.com>
  • Loading branch information
@gcf-owl-bot @ohmayr
3 people authored Sep 23, 2024
1 parent d6238e4 commit e727cc0
Show file tree
Hide file tree
Showing 17 changed files with 5,851 additions and 4,098 deletions.
6 changes: 6 additions & 0 deletions packages/google-cloud-gdchardwaremanagement/google/cloud/gdchardwaremanagement/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
Comment,
Contact,
Dimensions,
Entity,
Hardware,
HardwareConfig,
HardwareGroup,
Expand All @@ -44,6 +45,7 @@
SkuConfig,
SkuInstance,
Subnet,
SubscriptionConfig,
TimePeriod,
Zone,
ZoneNetworkConfig,
Expand Down Expand Up @@ -84,6 +86,7 @@
ListZonesRequest,
ListZonesResponse,
OperationMetadata,
RecordActionOnCommentRequest,
SignalZoneStateRequest,
SubmitOrderRequest,
UpdateHardwareGroupRequest,
Expand Down Expand Up @@ -114,9 +117,11 @@
"SkuConfig",
"SkuInstance",
"Subnet",
"SubscriptionConfig",
"TimePeriod",
"Zone",
"ZoneNetworkConfig",
"Entity",
"PowerSupply",
"CreateCommentRequest",
"CreateHardwareGroupRequest",
Expand Down Expand Up @@ -153,6 +158,7 @@
"ListZonesRequest",
"ListZonesResponse",
"OperationMetadata",
"RecordActionOnCommentRequest",
"SignalZoneStateRequest",
"SubmitOrderRequest",
"UpdateHardwareGroupRequest",
Expand Down
6 changes: 6 additions & 0 deletions ...google-cloud-gdchardwaremanagement/google/cloud/gdchardwaremanagement_v1alpha/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
Comment,
Contact,
Dimensions,
Entity,
Hardware,
HardwareConfig,
HardwareGroup,
Expand All @@ -42,6 +43,7 @@
SkuConfig,
SkuInstance,
Subnet,
SubscriptionConfig,
TimePeriod,
Zone,
ZoneNetworkConfig,
Expand Down Expand Up @@ -82,6 +84,7 @@
ListZonesRequest,
ListZonesResponse,
OperationMetadata,
RecordActionOnCommentRequest,
SignalZoneStateRequest,
SubmitOrderRequest,
UpdateHardwareGroupRequest,
Expand All @@ -107,6 +110,7 @@
"DeleteOrderRequest",
"DeleteZoneRequest",
"Dimensions",
"Entity",
"GDCHardwareManagementClient",
"GetChangeLogEntryRequest",
"GetCommentRequest",
Expand Down Expand Up @@ -143,13 +147,15 @@
"OrganizationContact",
"PowerSupply",
"RackSpace",
"RecordActionOnCommentRequest",
"SignalZoneStateRequest",
"Site",
"Sku",
"SkuConfig",
"SkuInstance",
"SubmitOrderRequest",
"Subnet",
"SubscriptionConfig",
"TimePeriod",
"UpdateHardwareGroupRequest",
"UpdateHardwareRequest",
Expand Down
15 changes: 15 additions & 0 deletions ...loud-gdchardwaremanagement/google/cloud/gdchardwaremanagement_v1alpha/gapic_metadata.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,11 @@
"list_zones"
]
},
"RecordActionOnComment": {
"methods": [
"record_action_on_comment"
]
},
"SignalZoneState": {
"methods": [
"signal_zone_state"
Expand Down Expand Up @@ -310,6 +315,11 @@
"list_zones"
]
},
"RecordActionOnComment": {
"methods": [
"record_action_on_comment"
]
},
"SignalZoneState": {
"methods": [
"signal_zone_state"
Expand Down Expand Up @@ -480,6 +490,11 @@
"list_zones"
]
},
"RecordActionOnComment": {
"methods": [
"record_action_on_comment"
]
},
"SignalZoneState": {
"methods": [
"signal_zone_state"
Expand Down
120 changes: 120 additions & 0 deletions ...ogle/cloud/gdchardwaremanagement_v1alpha/services/gdc_hardware_management/async_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3237,6 +3237,126 @@ async def sample_create_comment():
# Done; return the response.
return response

async def record_action_on_comment(
self,
request: Optional[Union[service.RecordActionOnCommentRequest, dict]] = None,
*,
name: Optional[str] = None,
action_type: Optional[service.RecordActionOnCommentRequest.ActionType] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> resources.Comment:
r"""Record Action on a Comment. If the Action specified
in the request is READ, the viewed time in the comment
is set to the time the request was received. If the
comment is already marked as read, subsequent calls will
be ignored. If the Action is UNREAD, the viewed time is
cleared from the comment.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gdchardwaremanagement_v1alpha
async def sample_record_action_on_comment():
# Create a client
client = gdchardwaremanagement_v1alpha.GDCHardwareManagementAsyncClient()
# Initialize request argument(s)
request = gdchardwaremanagement_v1alpha.RecordActionOnCommentRequest(
name="name_value",
action_type="UNREAD",
)
# Make the request
response = await client.record_action_on_comment(request=request)
# Handle the response
print(response)
Args:
request (Optional[Union[google.cloud.gdchardwaremanagement_v1alpha.types.RecordActionOnCommentRequest, dict]]):
The request object. A request to record an action on a
comment.
name (:class:`str`):
Required. The name of the comment. Format:
``projects/{project}/locations/{location}/orders/{order}/comments/{comment}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
action_type (:class:`google.cloud.gdchardwaremanagement_v1alpha.types.RecordActionOnCommentRequest.ActionType`):
Required. The action type of the
recorded action.
This corresponds to the ``action_type`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry_async.AsyncRetry): 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.gdchardwaremanagement_v1alpha.types.Comment:
A comment on an order.
"""
# 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.
has_flattened_params = any([name, action_type])
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."
)

# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, service.RecordActionOnCommentRequest):
request = service.RecordActionOnCommentRequest(request)

# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
if action_type is not None:
request.action_type = action_type

# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._client._transport._wrapped_methods[
self._client._transport.record_action_on_comment
]

# 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),)),
)

# Validate the universe domain.
self._client._validate_universe_domain()

# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)

# Done; return the response.
return response

async def list_change_log_entries(
self,
request: Optional[Union[service.ListChangeLogEntriesRequest, dict]] = None,
Expand Down
117 changes: 117 additions & 0 deletions ...ent/google/cloud/gdchardwaremanagement_v1alpha/services/gdc_hardware_management/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3734,6 +3734,123 @@ def sample_create_comment():
# Done; return the response.
return response

def record_action_on_comment(
self,
request: Optional[Union[service.RecordActionOnCommentRequest, dict]] = None,
*,
name: Optional[str] = None,
action_type: Optional[service.RecordActionOnCommentRequest.ActionType] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> resources.Comment:
r"""Record Action on a Comment. If the Action specified
in the request is READ, the viewed time in the comment
is set to the time the request was received. If the
comment is already marked as read, subsequent calls will
be ignored. If the Action is UNREAD, the viewed time is
cleared from the comment.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gdchardwaremanagement_v1alpha
def sample_record_action_on_comment():
# Create a client
client = gdchardwaremanagement_v1alpha.GDCHardwareManagementClient()
# Initialize request argument(s)
request = gdchardwaremanagement_v1alpha.RecordActionOnCommentRequest(
name="name_value",
action_type="UNREAD",
)
# Make the request
response = client.record_action_on_comment(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.gdchardwaremanagement_v1alpha.types.RecordActionOnCommentRequest, dict]):
The request object. A request to record an action on a
comment.
name (str):
Required. The name of the comment. Format:
``projects/{project}/locations/{location}/orders/{order}/comments/{comment}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
action_type (google.cloud.gdchardwaremanagement_v1alpha.types.RecordActionOnCommentRequest.ActionType):
Required. The action type of the
recorded action.
This corresponds to the ``action_type`` 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.gdchardwaremanagement_v1alpha.types.Comment:
A comment on an order.
"""
# 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.
has_flattened_params = any([name, action_type])
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."
)

# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, service.RecordActionOnCommentRequest):
request = service.RecordActionOnCommentRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
if action_type is not None:
request.action_type = action_type

# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.record_action_on_comment]

# 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),)),
)

# Validate the universe domain.
self._validate_universe_domain()

# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)

# Done; return the response.
return response

def list_change_log_entries(
self,
request: Optional[Union[service.ListChangeLogEntriesRequest, dict]] = None,
Expand Down
Loading

0 comments on commit e727cc0

Please sign in to comment.