Container: example(s) for long-running operations

[DazWilkin]

Please provide (reference) an example for converting container_v1.types.Operation into api_core.operation.Operation.

create_cluster (and other methods in the Cloud Client Library) return (long-running) Operation(s).

I assumed (hoped) this would be google.api_core.operation.Operation that I could operation.result() but, the method turns google.cloud.container_v1.types.Operation

[Spanner's Python Library, for example, returns google.api_core.operation.Operation in this case]

I'm struggling to connect this with (presumably?) Long-Running Operations documented in Core.

I'm unable to new an OperationsClient. The Example suggests operations_v1.OperationsClient() but this errors with TypeError: __init__() takes at least 2 arguments (1 given).

It's unclear what channel (grpc.Channel) I should provide.

Is this the correct approach? Having triggered the cluster creation, I'd like to track its progress to completion.

[theacodes]

/cc @lukesneeringer There's a configuration you can enable in your gapic config to make libraries automatically wrap the operation with the high-level class.

[lukesneeringer]

Yep, we should add that and then this just magically works for @DazWilkin. What API is it?

[theacodes]

Container

…

On Thu, Aug 9, 2018 at 12:29 PM Luke Sneeringer ***@***.***> wrote: Yep, we should add that and then this just magically works for @DazWilkin <https://github.com/DazWilkin>. What API is it? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <https://github.com/GoogleCloudPlatform/google-cloud-python/issues/5780#issuecomment-411870143>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAPUc1uTt-GhW89pTygamMoAGQabOyquks5uPI2PgaJpZM4V2Meo> .

[DazWilkin]

Ooh.... thanks @theacodes @lukesneeringer

[tseaver]

@lukesneeringer Ping?

[tseaver]

@lukesneeringer PR googleapis/google-cloud-python#6084 will automate the codegen for google-cloud-container, but somebody still needs to make the change to the upstream GAPIC config to get the operations wrapped.

[busunkim96]

Waiting to hear back from some ACTools folks who know more about this, but here's what I understand about the situation at the moment.

The generator will add the google.api_core.operation.Operation wrapper when the method complies with https://google.aip.dev/151. This API does not, perhaps because it is an older API that was written before the guidelines existed.

The LROs (see CreateCluster) in the service return an Operation message are defined inside the Container Service.

  rpc CreateCluster(CreateClusterRequest) returns (Operation) {
    option (google.api.http) = {
      post: "/v1/{parent=projects/*/locations/*}/clusters"
      body: "*"
      additional_bindings {
        post: "/v1/projects/{project_id}/zones/{zone}/clusters"
        body: "*"
      }
    };
    option (google.api.method_signature) = "project_id,zone,cluster";
    option (google.api.method_signature) = "parent,cluster";
  }

Compare this to an API that uses that follows the AIP:

https://github.com/googleapis/googleapis/blob/eabe7c0fde64b1451df6ea171b2009238b0df07c/google/cloud/speech/v1/cloud_speech.proto#L51-L67

  rpc LongRunningRecognize(LongRunningRecognizeRequest) returns (google.longrunning.Operation) {
    option (google.api.http) = {
      post: "/v1/speech:longrunningrecognize"
      body: "*"
    };
    option (google.api.method_signature) = "config,audio";
    option (google.longrunning.operation_info) = {
      response_type: "LongRunningRecognizeResponse"
      metadata_type: "LongRunningRecognizeMetadata"
    };
  }

https://github.com/googleapis/python-speech/blob/b4700a60569cb917f176ae1f504dadac1edb6ae8/google/cloud/speech_v1/services/speech/client.py#L492-L504