com.google.api.services.notebooks.v1.model

Class OperationMetadata

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.notebooks.v1.model.OperationMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class OperationMetadata
extends com.google.api.client.json.GenericJson

Represents the metadata of the long-running operation.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Notebooks API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
OperationMetadata()

Method Summary

Modifier and Type	Method and Description
OperationMetadata	clone()
String	getApiVersion() API version used to start the operation.
String	getCreateTime() The time the operation was created.
String	getEndpoint() API endpoint name of this operation.
String	getEndTime() The time the operation finished running.
Boolean	getRequestedCancellation() Identifies whether the user has requested cancellation of the operation.
String	getStatusMessage() Human-readable status of the operation, if any.
String	getTarget() Server-defined resource path for the target of the operation.
String	getVerb() Name of the verb executed by the operation.
OperationMetadata	set(String fieldName, Object value)
OperationMetadata	setApiVersion(String apiVersion) API version used to start the operation.
OperationMetadata	setCreateTime(String createTime) The time the operation was created.
OperationMetadata	setEndpoint(String endpoint) API endpoint name of this operation.
OperationMetadata	setEndTime(String endTime) The time the operation finished running.
OperationMetadata	setRequestedCancellation(Boolean requestedCancellation) Identifies whether the user has requested cancellation of the operation.
OperationMetadata	setStatusMessage(String statusMessage) Human-readable status of the operation, if any.
OperationMetadata	setTarget(String target) Server-defined resource path for the target of the operation.
OperationMetadata	setVerb(String verb) Name of the verb executed by the operation.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

OperationMetadata

public OperationMetadata()

Method Detail

getApiVersion

public String getApiVersion()

API version used to start the operation.

Returns:

value or null for none

setApiVersion

public OperationMetadata setApiVersion(String apiVersion)

API version used to start the operation.

Parameters:

apiVersion - apiVersion or null for none

getCreateTime

public String getCreateTime()

The time the operation was created.

Returns:

value or null for none

setCreateTime

public OperationMetadata setCreateTime(String createTime)

The time the operation was created.

Parameters:

createTime - createTime or null for none

getEndTime

public String getEndTime()

The time the operation finished running.

Returns:

value or null for none

setEndTime

public OperationMetadata setEndTime(String endTime)

The time the operation finished running.

Parameters:

endTime - endTime or null for none

getEndpoint

public String getEndpoint()

API endpoint name of this operation.

Returns:

value or null for none

setEndpoint

public OperationMetadata setEndpoint(String endpoint)

API endpoint name of this operation.

Parameters:

endpoint - endpoint or null for none

getRequestedCancellation

public Boolean getRequestedCancellation()

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

Returns:

value or null for none

setRequestedCancellation

public OperationMetadata setRequestedCancellation(Boolean requestedCancellation)

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

Parameters:

requestedCancellation - requestedCancellation or null for none

getStatusMessage

public String getStatusMessage()

Human-readable status of the operation, if any.

Returns:

value or null for none

setStatusMessage

public OperationMetadata setStatusMessage(String statusMessage)

Human-readable status of the operation, if any.

Parameters:

statusMessage - statusMessage or null for none

getTarget

public String getTarget()

Server-defined resource path for the target of the operation.

Returns:

value or null for none

setTarget

public OperationMetadata setTarget(String target)

Server-defined resource path for the target of the operation.

Parameters:

target - target or null for none

getVerb

public String getVerb()

Name of the verb executed by the operation.

Returns:

value or null for none

setVerb

public OperationMetadata setVerb(String verb)

Name of the verb executed by the operation.

Parameters:

verb - verb or null for none

set

public OperationMetadata set(String fieldName,
                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public OperationMetadata clone()

Overrides:

clone in class com.google.api.client.json.GenericJson