# Notebooks V2 API - Class Google::Longrunning::Operation (v1.5.0)

1.5.0 (latest) 1.4.0 1.3.1 1.2.0 1.1.0 1.0.1 0.6.0 0.5.0 0.4.2 0.3.2 0.2.0 0.1.0 Reference documentation and code samples for the Notebooks V2 API class Google::Longrunning::Operation.

This resource represents a long-running operation that is the result of a
network API call.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #done

    def done() -> ::Boolean

**Returns**

- (::Boolean) --- If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

### #done=

    def done=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
**Returns**

- (::Boolean) --- If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

### #error

    def error() -> ::Google::Rpc::Status

**Returns**

- ([::Google::Rpc::Status](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Rpc-Status)) --- The error result of the operation in case of failure or cancellation.


  Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #error=

    def error=(value) -> ::Google::Rpc::Status

**Parameter**

- **value** ([::Google::Rpc::Status](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Rpc-Status)) --- The error result of the operation in case of failure or cancellation.


  Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Rpc::Status](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Rpc-Status)) --- The error result of the operation in case of failure or cancellation.


  Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #metadata

    def metadata() -> ::Google::Protobuf::Any

**Returns**

- ([::Google::Protobuf::Any](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Protobuf-Any)) --- Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

### #metadata=

    def metadata=(value) -> ::Google::Protobuf::Any

**Parameter**

- **value** ([::Google::Protobuf::Any](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Protobuf-Any)) --- Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
**Returns**

- ([::Google::Protobuf::Any](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Protobuf-Any)) --- Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

### #name

    def name() -> ::String

**Returns**

- (::String) --- The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
**Returns**

- (::String) --- The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

### #response

    def response() -> ::Google::Protobuf::Any

**Returns**

- ([::Google::Protobuf::Any](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Protobuf-Any)) --- The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.


  Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #response=

    def response=(value) -> ::Google::Protobuf::Any

**Parameter**

- **value** ([::Google::Protobuf::Any](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Protobuf-Any)) --- The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.


  Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Protobuf::Any](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Protobuf-Any)) --- The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.


  Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.