target.apidocs.com.google.api.services.dataflow.model.StructuredMessage.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dataflow Show documentation

There is a newer version: v1b4-rev7-1.20.0

Show newest version







StructuredMessage (Dataflow API v1b3-rev20231112-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dataflow.model
Class StructuredMessage



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.dataflow.model.StructuredMessage













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class StructuredMessage
extends com.google.api.client.json.GenericJson
A rich message format, including a human readable string, a key for identifying the message, and
 structured data associated with the message for programmatic consumption.

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


StructuredMessage() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


StructuredMessage
clone() 


String
getMessageKey()
Identifier for this message type.



String
getMessageText()
Human-readable version of message.



List<Parameter>
getParameters()
The structured data associated with this message.



StructuredMessage
set(String fieldName,
   Object value) 


StructuredMessage
setMessageKey(String messageKey)
Identifier for this message type.



StructuredMessage
setMessageText(String messageText)
Human-readable version of message.



StructuredMessage
setParameters(List<Parameter> parameters)
The structured data associated with this message.







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





StructuredMessage
public StructuredMessage()









Method Detail





getMessageKey
public String getMessageKey()
Identifier for this message type. Used by external systems to internationalize or personalize
 message.

Returns:
value or null for none








setMessageKey
public StructuredMessage setMessageKey(String messageKey)
Identifier for this message type. Used by external systems to internationalize or personalize
 message.

Parameters:
messageKey - messageKey or null for none








getMessageText
public String getMessageText()
Human-readable version of message.

Returns:
value or null for none








setMessageText
public StructuredMessage setMessageText(String messageText)
Human-readable version of message.

Parameters:
messageText - messageText or null for none








getParameters
public List<Parameter> getParameters()
The structured data associated with this message.

Returns:
value or null for none








setParameters
public StructuredMessage setParameters(List<Parameter> parameters)
The structured data associated with this message.

Parameters:
parameters - parameters or null for none








set
public StructuredMessage set(String fieldName,
                             Object value)

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








clone
public StructuredMessage clone()

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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.

Modifier and Type	Method and Description
`StructuredMessage`	`clone()`
`String`	`getMessageKey()` Identifier for this message type.
`String`	`getMessageText()` Human-readable version of message.
`List<Parameter>`	`getParameters()` The structured data associated with this message.
`StructuredMessage`	`set(String fieldName, Object value)`
`StructuredMessage`	`setMessageKey(String messageKey)` Identifier for this message type.
`StructuredMessage`	`setMessageText(String messageText)` Human-readable version of message.
`StructuredMessage`	`setParameters(List<Parameter> parameters)` The structured data associated with this message.