com.google.api.services.healthcare.v1beta1.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.healthcare.v1beta1.model.OperationMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

OperationMetadata provides information about the operation execution. Returned in the long- running operation's metadata field.

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 Cloud Healthcare 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	getApiMethodName() The name of the API method that initiated the operation.
Boolean	getCancelRequested() Specifies if cancellation was requested for the operation.
ProgressCounter	getCounter()
String	getCreateTime() The time at which the operation was created by the API.
String	getEndTime() The time at which execution workloads were completed.
String	getLogsUrl() A link to audit and error logs in the log viewer.
OperationMetadata	set(String fieldName, Object value)
OperationMetadata	setApiMethodName(String apiMethodName) The name of the API method that initiated the operation.
OperationMetadata	setCancelRequested(Boolean cancelRequested) Specifies if cancellation was requested for the operation.
OperationMetadata	setCounter(ProgressCounter counter)
OperationMetadata	setCreateTime(String createTime) The time at which the operation was created by the API.
OperationMetadata	setEndTime(String endTime) The time at which execution workloads were completed.
OperationMetadata	setLogsUrl(String logsUrl) A link to audit and error logs in the log viewer.

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

getApiMethodName

public String getApiMethodName()

The name of the API method that initiated the operation.

Returns:

value or null for none

setApiMethodName

public OperationMetadata setApiMethodName(String apiMethodName)

The name of the API method that initiated the operation.

Parameters:

apiMethodName - apiMethodName or null for none

getCancelRequested

public Boolean getCancelRequested()

Specifies if cancellation was requested for the operation.

Returns:

value or null for none

setCancelRequested

public OperationMetadata setCancelRequested(Boolean cancelRequested)

Specifies if cancellation was requested for the operation.

Parameters:

cancelRequested - cancelRequested or null for none

getCounter

public ProgressCounter getCounter()

Returns:

value or null for none

setCounter

public OperationMetadata setCounter(ProgressCounter counter)

Parameters:

counter - counter or null for none

getCreateTime

public String getCreateTime()

The time at which the operation was created by the API.

Returns:

value or null for none

setCreateTime

public OperationMetadata setCreateTime(String createTime)

The time at which the operation was created by the API.

Parameters:

createTime - createTime or null for none

getEndTime

public String getEndTime()

The time at which execution workloads were completed. Some tasks will complete after this time such as logging audit logs.

Returns:

value or null for none

setEndTime

public OperationMetadata setEndTime(String endTime)

The time at which execution workloads were completed. Some tasks will complete after this time such as logging audit logs.

Parameters:

endTime - endTime or null for none

getLogsUrl

public String getLogsUrl()

A link to audit and error logs in the log viewer. Error logs are generated only by some operations, listed at [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The `end_time` specified in this URL may not match the end time on the metadata because logs are written asynchronously from execution.

Returns:

value or null for none

setLogsUrl

public OperationMetadata setLogsUrl(String logsUrl)

A link to audit and error logs in the log viewer. Error logs are generated only by some operations, listed at [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The `end_time` specified in this URL may not match the end time on the metadata because logs are written asynchronously from execution.

Parameters:

logsUrl - logsUrl 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