com.google.api.generator.gapic.model

Class Message

java.lang.Object

com.google.api.generator.gapic.model.Message

public abstract class Message
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Builder

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
static Message.Builder	builder()
abstract com.google.common.collect.ImmutableMap<String,Integer>	enumValues()
abstract com.google.common.collect.ImmutableMap<String,Field>	fieldMap()
abstract com.google.common.collect.ImmutableList<Field>	fields()
Field	findAndUnwrapPaginatedRepeatedField() Returns the first list repeated field in a message, unwrapped from its list type.
abstract String	fullProtoName()
boolean	hasResource()
boolean	isEnum()
abstract String	name()
abstract Map<String,String>	operationRequestFields()
abstract OperationResponse	operationResponse()
abstract com.google.common.collect.BiMap<String,String>	operationResponseFields()
abstract com.google.common.collect.ImmutableList<String>	outerNestedTypes()
abstract ResourceName	resource()
abstract Message.Builder	toBuilder()
abstract TypeNode	type()
void	validateField(String fieldName, Map<String,Message> messageTypes, TypeNode type) Validates if the field or fields exist in the message and the type of the leaf level field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Message

public Message()

Method Detail

name

public abstract String name()

fullProtoName

public abstract String fullProtoName()

fields

public abstract com.google.common.collect.ImmutableList<Field> fields()

enumValues

public abstract com.google.common.collect.ImmutableMap<String,Integer> enumValues()

type

public abstract TypeNode type()

fieldMap

public abstract com.google.common.collect.ImmutableMap<String,Field> fieldMap()

operationResponse

@Nullable
public abstract OperationResponse operationResponse()

operationRequestFields

public abstract Map<String,String> operationRequestFields()

operationResponseFields

public abstract com.google.common.collect.BiMap<String,String> operationResponseFields()

resource

@Nullable
public abstract ResourceName resource()

outerNestedTypes

public abstract com.google.common.collect.ImmutableList<String> outerNestedTypes()

toBuilder

public abstract Message.Builder toBuilder()

isEnum

public boolean isEnum()

hasResource

public boolean hasResource()

validateField

public void validateField(String fieldName,
                          Map<String,Message> messageTypes,
                          TypeNode type)

Validates if the field or fields exist in the message and the type of the leaf level field.

Parameters:

fieldName - The field name. For nested field, concatenate each field name with dot. For example: abc.def.ghi

messageTypes - All messages configured in a rpc service.

type - TypeNode The expected type for the leaf level field

findAndUnwrapPaginatedRepeatedField

@Nullable
public Field findAndUnwrapPaginatedRepeatedField()

Returns the first list repeated field in a message, unwrapped from its list type.

builder

public static Message.Builder builder()