Table of Contents

Class GoogleLongRunningOperation

Namespace
GenerativeAI.Types
Assembly
GenerativeAI.dll

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

public class GoogleLongRunningOperation
Inheritance
GoogleLongRunningOperation
Derived
Inherited Members
Extension Methods

Properties

Done

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.

[JsonPropertyName("done")]
public bool? Done { get; set; }

Property Value

bool?

Error

The error result of the operation in case of failure or cancellation.

[JsonPropertyName("error")]
public GoogleRpcStatus? Error { get; set; }

Property Value

GoogleRpcStatus

Metadata

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.

[JsonPropertyName("metadata")]
public IDictionary<string, object>? Metadata { get; set; }

Property Value

IDictionary<string, object>

Name

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}.

[JsonPropertyName("name")]
public string? Name { get; set; }

Property Value

string

OperationName

Gets or sets the operation name for tracking purposes.

[JsonPropertyName("operationName")]
public string? OperationName { get; set; }

Property Value

string

Response

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.

[JsonPropertyName("response")]
public IDictionary<string, object>? Response { get; set; }

Property Value

IDictionary<string, object>