-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Generate gRPC files for long-running operations (#13)
Fixes #12 🦕 (My automatic whitespace formatter removed some trailing whitespace, is this an issue?) Note that I'm not entirely sure how to work with synthtool, and so I couldn't figure out how to get the license header and formatting fixed before committing the files generated by `nox -s generate_protos`. Someone else is going to have to do that part for me 🙂 Still, the generated grpc file looks good.
- Loading branch information
Showing
4 changed files
with
335 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,6 @@ | ||
# Generated by the protocol buffer compiler. DO NOT EDIT! | ||
# source: google/longrunning/operations.proto | ||
from google.longrunning.operations_proto_pb2 import * | ||
from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2 | ||
|
||
|
||
class OperationsStub(object): | ||
"""Manages long-running operations with an API service. | ||
# This module is provided for backwards compatibility with | ||
# googleapis-common-protos <= 1.52.0, where this import path contained | ||
# all of the message and gRPC definitions. | ||
|
||
When an API method normally takes long time to complete, it can be designed | ||
to return [Operation][google.longrunning.Operation] to the client, and the client can use this | ||
interface to receive the real response asynchronously by polling the | ||
operation resource, or pass the operation resource to another API (such as | ||
Google Cloud Pub/Sub API) to receive the response. Any API service that | ||
returns long-running operations should implement the `Operations` interface | ||
so developers can have a consistent client experience. | ||
""" | ||
|
||
def __init__(self, channel): | ||
"""Constructor. | ||
Args: | ||
channel: A grpc.Channel. | ||
""" | ||
self.GetOperation = channel.unary_unary( | ||
"/google.longrunning.Operations/GetOperation", | ||
request_serializer=GetOperationRequest.SerializeToString, | ||
response_deserializer=Operation.FromString, | ||
) | ||
self.ListOperations = channel.unary_unary( | ||
"/google.longrunning.Operations/ListOperations", | ||
request_serializer=ListOperationsRequest.SerializeToString, | ||
response_deserializer=ListOperationsResponse.FromString, | ||
) | ||
self.CancelOperation = channel.unary_unary( | ||
"/google.longrunning.Operations/CancelOperation", | ||
request_serializer=CancelOperationRequest.SerializeToString, | ||
response_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString, | ||
) | ||
self.DeleteOperation = channel.unary_unary( | ||
"/google.longrunning.Operations/DeleteOperation", | ||
request_serializer=DeleteOperationRequest.SerializeToString, | ||
response_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString, | ||
) | ||
from google.longrunning.operations_proto_pb2 import * | ||
from google.longrunning.operations_pb2_grpc import * |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,282 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
# Copyright 2020 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT! | ||
"""Client and server classes corresponding to protobuf-defined services.""" | ||
import grpc | ||
|
||
from google.longrunning import ( | ||
operations_proto_pb2 as google_dot_longrunning_dot_operations__pb2, | ||
) | ||
from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2 | ||
|
||
|
||
class OperationsStub(object): | ||
"""Manages long-running operations with an API service. | ||
When an API method normally takes long time to complete, it can be designed | ||
to return [Operation][google.longrunning.Operation] to the client, and the client can use this | ||
interface to receive the real response asynchronously by polling the | ||
operation resource, or pass the operation resource to another API (such as | ||
Google Cloud Pub/Sub API) to receive the response. Any API service that | ||
returns long-running operations should implement the `Operations` interface | ||
so developers can have a consistent client experience. | ||
""" | ||
|
||
def __init__(self, channel): | ||
"""Constructor. | ||
Args: | ||
channel: A grpc.Channel. | ||
""" | ||
self.ListOperations = channel.unary_unary( | ||
"/google.longrunning.Operations/ListOperations", | ||
request_serializer=google_dot_longrunning_dot_operations__pb2.ListOperationsRequest.SerializeToString, | ||
response_deserializer=google_dot_longrunning_dot_operations__pb2.ListOperationsResponse.FromString, | ||
) | ||
self.GetOperation = channel.unary_unary( | ||
"/google.longrunning.Operations/GetOperation", | ||
request_serializer=google_dot_longrunning_dot_operations__pb2.GetOperationRequest.SerializeToString, | ||
response_deserializer=google_dot_longrunning_dot_operations__pb2.Operation.FromString, | ||
) | ||
self.DeleteOperation = channel.unary_unary( | ||
"/google.longrunning.Operations/DeleteOperation", | ||
request_serializer=google_dot_longrunning_dot_operations__pb2.DeleteOperationRequest.SerializeToString, | ||
response_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString, | ||
) | ||
self.CancelOperation = channel.unary_unary( | ||
"/google.longrunning.Operations/CancelOperation", | ||
request_serializer=google_dot_longrunning_dot_operations__pb2.CancelOperationRequest.SerializeToString, | ||
response_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString, | ||
) | ||
|
||
|
||
class OperationsServicer(object): | ||
"""Manages long-running operations with an API service. | ||
When an API method normally takes long time to complete, it can be designed | ||
to return [Operation][google.longrunning.Operation] to the client, and the client can use this | ||
interface to receive the real response asynchronously by polling the | ||
operation resource, or pass the operation resource to another API (such as | ||
Google Cloud Pub/Sub API) to receive the response. Any API service that | ||
returns long-running operations should implement the `Operations` interface | ||
so developers can have a consistent client experience. | ||
""" | ||
|
||
def ListOperations(self, request, context): | ||
"""Lists operations that match the specified filter in the request. If the | ||
server doesn't support this method, it returns `UNIMPLEMENTED`. | ||
NOTE: the `name` binding below allows API services to override the binding | ||
to use different resource name schemes, such as `users/*/operations`. | ||
""" | ||
context.set_code(grpc.StatusCode.UNIMPLEMENTED) | ||
context.set_details("Method not implemented!") | ||
raise NotImplementedError("Method not implemented!") | ||
|
||
def GetOperation(self, request, context): | ||
"""Gets the latest state of a long-running operation. Clients can use this | ||
method to poll the operation result at intervals as recommended by the API | ||
service. | ||
""" | ||
context.set_code(grpc.StatusCode.UNIMPLEMENTED) | ||
context.set_details("Method not implemented!") | ||
raise NotImplementedError("Method not implemented!") | ||
|
||
def DeleteOperation(self, request, context): | ||
"""Deletes a long-running operation. This method indicates that the client is | ||
no longer interested in the operation result. It does not cancel the | ||
operation. If the server doesn't support this method, it returns | ||
`google.rpc.Code.UNIMPLEMENTED`. | ||
""" | ||
context.set_code(grpc.StatusCode.UNIMPLEMENTED) | ||
context.set_details("Method not implemented!") | ||
raise NotImplementedError("Method not implemented!") | ||
|
||
def CancelOperation(self, request, context): | ||
"""Starts asynchronous cancellation on a long-running operation. The server | ||
makes a best effort to cancel the operation, but success is not | ||
guaranteed. If the server doesn't support this method, it returns | ||
`google.rpc.Code.UNIMPLEMENTED`. Clients can use | ||
[Operations.GetOperation][google.longrunning.Operations.GetOperation] or | ||
other methods to check whether the cancellation succeeded or whether the | ||
operation completed despite cancellation. On successful cancellation, | ||
the operation is not deleted; instead, it becomes an operation with | ||
an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, | ||
corresponding to `Code.CANCELLED`. | ||
""" | ||
context.set_code(grpc.StatusCode.UNIMPLEMENTED) | ||
context.set_details("Method not implemented!") | ||
raise NotImplementedError("Method not implemented!") | ||
|
||
|
||
def add_OperationsServicer_to_server(servicer, server): | ||
rpc_method_handlers = { | ||
"ListOperations": grpc.unary_unary_rpc_method_handler( | ||
servicer.ListOperations, | ||
request_deserializer=google_dot_longrunning_dot_operations__pb2.ListOperationsRequest.FromString, | ||
response_serializer=google_dot_longrunning_dot_operations__pb2.ListOperationsResponse.SerializeToString, | ||
), | ||
"GetOperation": grpc.unary_unary_rpc_method_handler( | ||
servicer.GetOperation, | ||
request_deserializer=google_dot_longrunning_dot_operations__pb2.GetOperationRequest.FromString, | ||
response_serializer=google_dot_longrunning_dot_operations__pb2.Operation.SerializeToString, | ||
), | ||
"DeleteOperation": grpc.unary_unary_rpc_method_handler( | ||
servicer.DeleteOperation, | ||
request_deserializer=google_dot_longrunning_dot_operations__pb2.DeleteOperationRequest.FromString, | ||
response_serializer=google_dot_protobuf_dot_empty__pb2.Empty.SerializeToString, | ||
), | ||
"CancelOperation": grpc.unary_unary_rpc_method_handler( | ||
servicer.CancelOperation, | ||
request_deserializer=google_dot_longrunning_dot_operations__pb2.CancelOperationRequest.FromString, | ||
response_serializer=google_dot_protobuf_dot_empty__pb2.Empty.SerializeToString, | ||
), | ||
} | ||
generic_handler = grpc.method_handlers_generic_handler( | ||
"google.longrunning.Operations", rpc_method_handlers | ||
) | ||
server.add_generic_rpc_handlers((generic_handler,)) | ||
|
||
|
||
# This class is part of an EXPERIMENTAL API. | ||
class Operations(object): | ||
"""Manages long-running operations with an API service. | ||
When an API method normally takes long time to complete, it can be designed | ||
to return [Operation][google.longrunning.Operation] to the client, and the client can use this | ||
interface to receive the real response asynchronously by polling the | ||
operation resource, or pass the operation resource to another API (such as | ||
Google Cloud Pub/Sub API) to receive the response. Any API service that | ||
returns long-running operations should implement the `Operations` interface | ||
so developers can have a consistent client experience. | ||
""" | ||
|
||
@staticmethod | ||
def ListOperations( | ||
request, | ||
target, | ||
options=(), | ||
channel_credentials=None, | ||
call_credentials=None, | ||
insecure=False, | ||
compression=None, | ||
wait_for_ready=None, | ||
timeout=None, | ||
metadata=None, | ||
): | ||
return grpc.experimental.unary_unary( | ||
request, | ||
target, | ||
"/google.longrunning.Operations/ListOperations", | ||
google_dot_longrunning_dot_operations__pb2.ListOperationsRequest.SerializeToString, | ||
google_dot_longrunning_dot_operations__pb2.ListOperationsResponse.FromString, | ||
options, | ||
channel_credentials, | ||
insecure, | ||
call_credentials, | ||
compression, | ||
wait_for_ready, | ||
timeout, | ||
metadata, | ||
) | ||
|
||
@staticmethod | ||
def GetOperation( | ||
request, | ||
target, | ||
options=(), | ||
channel_credentials=None, | ||
call_credentials=None, | ||
insecure=False, | ||
compression=None, | ||
wait_for_ready=None, | ||
timeout=None, | ||
metadata=None, | ||
): | ||
return grpc.experimental.unary_unary( | ||
request, | ||
target, | ||
"/google.longrunning.Operations/GetOperation", | ||
google_dot_longrunning_dot_operations__pb2.GetOperationRequest.SerializeToString, | ||
google_dot_longrunning_dot_operations__pb2.Operation.FromString, | ||
options, | ||
channel_credentials, | ||
insecure, | ||
call_credentials, | ||
compression, | ||
wait_for_ready, | ||
timeout, | ||
metadata, | ||
) | ||
|
||
@staticmethod | ||
def DeleteOperation( | ||
request, | ||
target, | ||
options=(), | ||
channel_credentials=None, | ||
call_credentials=None, | ||
insecure=False, | ||
compression=None, | ||
wait_for_ready=None, | ||
timeout=None, | ||
metadata=None, | ||
): | ||
return grpc.experimental.unary_unary( | ||
request, | ||
target, | ||
"/google.longrunning.Operations/DeleteOperation", | ||
google_dot_longrunning_dot_operations__pb2.DeleteOperationRequest.SerializeToString, | ||
google_dot_protobuf_dot_empty__pb2.Empty.FromString, | ||
options, | ||
channel_credentials, | ||
insecure, | ||
call_credentials, | ||
compression, | ||
wait_for_ready, | ||
timeout, | ||
metadata, | ||
) | ||
|
||
@staticmethod | ||
def CancelOperation( | ||
request, | ||
target, | ||
options=(), | ||
channel_credentials=None, | ||
call_credentials=None, | ||
insecure=False, | ||
compression=None, | ||
wait_for_ready=None, | ||
timeout=None, | ||
metadata=None, | ||
): | ||
return grpc.experimental.unary_unary( | ||
request, | ||
target, | ||
"/google.longrunning.Operations/CancelOperation", | ||
google_dot_longrunning_dot_operations__pb2.CancelOperationRequest.SerializeToString, | ||
google_dot_protobuf_dot_empty__pb2.Empty.FromString, | ||
options, | ||
channel_credentials, | ||
insecure, | ||
call_credentials, | ||
compression, | ||
wait_for_ready, | ||
timeout, | ||
metadata, | ||
) |
Oops, something went wrong.