U h3@sdZddlZddlZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z Gd d d ejZdd d Zd dZddZdddZddZdddZdddZdS)a6Futures for long-running operations returned from Google Cloud APIs. These futures can be used to synchronously wait for the result of a long-running operation using :meth:`Operation.result`: .. code-block:: python operation = my_api_client.long_running_method() result = operation.result() Or asynchronously using callbacks and :meth:`Operation.add_done_callback`: .. code-block:: python operation = my_api_client.long_running_method() def my_callback(future): result = future.result() operation.add_done_callback(my_callback) N) exceptions)protobuf_helpers)polling)operations_pb2) json_format)code_pb2csxeZdZdZdejffdd ZeddZeddZ e d d Z d d Z dd dZ dddZddZddZZS) OperationaHA Future for interacting with a Google API Long-Running Operation. Args: operation (google.longrunning.operations_pb2.Operation): The initial operation. refresh (Callable[[], ~.api_core.operation.Operation]): A callable that returns the latest state of the operation. cancel (Callable[[], None]): A callable that tries to cancel the operation. result_type (func:`type`): The protobuf type for the operation's result. metadata_type (func:`type`): The protobuf type for the operation's metadata. polling (google.api_core.retry.Retry): The configuration used for polling. This parameter controls how often :meth:`done` is polled. If the ``timeout`` argument is specified in the :meth:`result` method, it will override the ``polling.timeout`` property. retry (google.api_core.retry.Retry): DEPRECATED: use ``polling`` instead. If specified it will override ``polling`` parameter to maintain backward compatibility. Nc sNtt|jfd|i|||_||_||_||_||_t |_ | dS)Nr) superr__init__ _operation_refresh_cancel _result_type_metadata_type threadingLock_completion_lock_set_result_from_operation)self operationrefreshcancel result_typeZ metadata_typerkwargs __class__=/tmp/pip-unpacked-wheel-eraazoov/google/api_core/operation.pyr Is  zOperation.__init__cCs|jS)zAgoogle.longrunning.Operation: The current long-running operation.)r rrrrr]szOperation.operationcCs"|jdsdSt|j|jjS)z8google.protobuf.Message: the current operation metadata.metadataN)r HasFieldr from_any_pbrrrrrrrbs  zOperation.metadatacCs tj|S)zDeserialize a ``google.longrunning.Operation`` protocol buffer. Args: payload (bytes): A serialized operation protocol buffer. Returns: ~.operations_pb2.Operation: An Operation protobuf object. )rrZ FromString)rpayloadrrr deserializels zOperation.deserializec Cs|j|jjr|jr$W5QRdS|jdrNt|j|jj}| |nR|jdrt j |jj j |jj j|jj f|jd}||nt d}||W5QRXdS)zASet the result or exception from the operation if it is complete.Nresponseerror) status_codemessageerrorsr$zLUnexpected state: Long-running operation had neither response nor error set.)rr doneZ _result_setr rr!rr$Z set_resultrZfrom_grpc_statusr%coder'Z set_exceptionZGoogleAPICallError)rr$ exceptionrrrrxs*    z$Operation._set_result_from_operationcCs.|jjs*|r|j|dn||_|dS)zRefresh the operation and update the result if needed. Args: retry (google.api_core.retry.Retry): (Optional) How to retry the RPC. )retryN)r r)r rrr,rrr_refresh_and_updateszOperation._refresh_and_updatecCs|||jjS)zChecks to see if the operation is complete. Args: retry (google.api_core.retry.Retry): (Optional) How to retry the RPC. Returns: bool: True if the operation is complete, False otherwise. )r.r r)r-rrrr)s zOperation.donecCs|r dS|dS)zAttempt to cancel the operation. Returns: bool: True if the cancel RPC was made, False if the operation is already complete. FT)r)r rrrrrszOperation.cancelcCs$||jdo"|jjjtjkS)z$True if the operation was cancelled.r%)r.r r r%r*rZ CANCELLEDrrrr cancelleds zOperation.cancelled)N)N)__name__ __module__ __qualname____doc__rZDEFAULT_POLLINGr propertyrr classmethodr#rr.r)rr/ __classcell__rrrrr2s   !  rcCs6d|}|dk r||}|d|d}t|tS)aRefresh an operation using a JSON/HTTP client. Args: api_request (Callable): A callable used to make an API request. This should generally be :meth:`google.cloud._http.Connection.api_request`. operation_name (str): The name of the operation. retry (google.api_core.retry.Retry): (Optional) retry policy Returns: google.longrunning.operations_pb2.Operation: The operation. z operations/{}NGETmethodpath)formatr ParseDictrr) api_requestoperation_namer,r:Z api_responserrr _refresh_https  r?cCsd|}|d|ddS)a"Cancel an operation using a JSON/HTTP client. Args: api_request (Callable): A callable used to make an API request. This should generally be :meth:`google.cloud._http.Connection.api_request`. operation_name (str): The name of the operation. zoperations/{}:cancelPOSTr8N)r;)r=r>r:rrr _cancel_https rAcKsBt|t}tt||j}tt||j}t||||f|S)aCreate an operation future using a HTTP/JSON client. This interacts with the long-running operations `service`_ (specific to a given API) via `HTTP/JSON`_. .. _HTTP/JSON: https://cloud.google.com/speech/reference/rest/ v1beta1/operations#Operation Args: operation (dict): Operation as a dictionary. api_request (Callable): A callable used to make an API request. This should generally be :meth:`google.cloud._http.Connection.api_request`. result_type (:func:`type`): The protobuf result type. kwargs: Keyword args passed into the :class:`Operation` constructor. Returns: ~.api_core.operation.Operation: The operation future to track the given operation. ) rr<rr functoolspartialr?namerA)rr=rrZoperation_protorrrrrfrom_http_jsonsrEcCs*tj|d}|j}|dk r"||}||S)a{Refresh an operation using a gRPC client. Args: operations_stub (google.longrunning.operations_pb2.OperationsStub): The gRPC operations stub. operation_name (str): The name of the operation. retry (google.api_core.retry.Retry): (Optional) retry policy Returns: google.longrunning.operations_pb2.Operation: The operation. rDN)rZGetOperationRequestZ GetOperation)operations_stubr>r, request_pbZrpcrrr _refresh_grpcs rIcCstj|d}||dS)zCancel an operation using a gRPC client. Args: operations_stub (google.longrunning.operations_pb2.OperationsStub): The gRPC operations stub. operation_name (str): The name of the operation. rFN)rZCancelOperationRequestZCancelOperation)rGr>rHrrr _cancel_grpcs rJcKs:tjt||j|d}tjt||j|d}t||||f|S)aCreate an operation future using a gRPC client. This interacts with the long-running operations `service`_ (specific to a given API) via gRPC. .. _service: https://github.com/googleapis/googleapis/blob/ 050400df0fdb16f63b63e9dee53819044bffc857/ google/longrunning/operations.proto#L38 Args: operation (google.longrunning.operations_pb2.Operation): The operation. operations_stub (google.longrunning.operations_pb2.OperationsStub): The operations stub. result_type (:func:`type`): The protobuf result type. grpc_metadata (Optional[List[Tuple[str, str]]]): Additional metadata to pass to the rpc. kwargs: Keyword args passed into the :class:`Operation` constructor. Returns: ~.api_core.operation.Operation: The operation future to track the given operation. r)rBrCrIrDrJr)rrGr grpc_metadatarrrrrr from_grpc&srMcKs:tj|j|j|d}tj|j|j|d}t||||f|S)aCreate an operation future from a gapic client. This interacts with the long-running operations `service`_ (specific to a given API) via a gapic client. .. _service: https://github.com/googleapis/googleapis/blob/ 050400df0fdb16f63b63e9dee53819044bffc857/ google/longrunning/operations.proto#L38 Args: operation (google.longrunning.operations_pb2.Operation): The operation. operations_client (google.api_core.operations_v1.OperationsClient): The operations client. result_type (:func:`type`): The protobuf result type. grpc_metadata (Optional[List[Tuple[str, str]]]): Additional metadata to pass to the rpc. kwargs: Keyword args passed into the :class:`Operation` constructor. Returns: ~.api_core.operation.Operation: The operation future to track the given operation. rK)rBrCZ get_operationrDZcancel_operationr)rZoperations_clientrrLrrrrrr from_gapicLsrN)N)N)N)N)r3rBrZgoogle.api_corerrZgoogle.api_core.futurerZgoogle.longrunningrZgoogle.protobufrZ google.rpcrZ PollingFuturerr?rArErIrJrMrNrrrrs"          &