Package com.google.api.generator.gapic.model

Class Method

java.lang.Object

com.google.api.generator.gapic.model.Method

public abstract class Method
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Method.Builder
static class	Method.Stream

Constructor Summary

Constructors

Constructor	Description
Method()

Method Summary

Modifier and Type	Method	Description
static Method.Builder	builder()
abstract String	description()
boolean	hasDescription()
boolean	hasHttpBindings()
boolean	hasLro()
boolean	hasRoutingHeaderParams()
abstract HttpBindings	httpBindings()
abstract TypeNode	inputType()
abstract boolean	isBatching()
abstract boolean	isDeprecated()
boolean	isMixin()
boolean	isOperationPollingMethod()
boolean	isPaged()
boolean	isSupportedByTransport(Transport transport)	Determines if method is both eligible and enabled for the Transport.
abstract LongrunningOperation	lro()
abstract com.google.common.collect.ImmutableList<List<MethodArgument>>	methodSignatures()
abstract String	mixedInApiName()
abstract String	name()
abstract boolean	operationPollingMethod()
abstract TypeNode	outputType()
abstract String	pageSizeFieldName()
abstract RoutingHeaderRule	routingHeaderRule()
boolean	shouldSetParamsExtractor()
abstract Method.Stream	stream()
abstract Method.Builder	toBuilder()
static Method.Stream	toStream(boolean isClientStreaming, boolean isServerStreaming)

Methods inherited from class java.lang.Object

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

Constructor Detail

Method

public Method()

Method Detail

name

public abstract String name()

stream

public abstract Method.Stream stream()

inputType

public abstract TypeNode inputType()

outputType

public abstract TypeNode outputType()

isBatching

public abstract boolean isBatching()

isPaged

public boolean isPaged()

pageSizeFieldName

@Nullable
public abstract String pageSizeFieldName()

isDeprecated

public abstract boolean isDeprecated()

lro

@Nullable
public abstract LongrunningOperation lro()

description

@Nullable
public abstract String description()

mixedInApiName

@Nullable
public abstract String mixedInApiName()

httpBindings

@Nullable
public abstract HttpBindings httpBindings()

routingHeaderRule

@Nullable
public abstract RoutingHeaderRule routingHeaderRule()

methodSignatures

public abstract com.google.common.collect.ImmutableList<List<MethodArgument>> methodSignatures()

operationPollingMethod

public abstract boolean operationPollingMethod()

hasLro

public boolean hasLro()

hasDescription

public boolean hasDescription()

hasHttpBindings

public boolean hasHttpBindings()

hasRoutingHeaderParams

public boolean hasRoutingHeaderParams()

shouldSetParamsExtractor

public boolean shouldSetParamsExtractor()

isMixin

public boolean isMixin()

isOperationPollingMethod

public boolean isOperationPollingMethod()

isSupportedByTransport

public boolean isSupportedByTransport(Transport transport)

Determines if method is both eligible and enabled for the Transport. GRPC+REST Transport is not supported as each transport's sub composers will invoke this method the specific transport (GRPC or REST)

Parameters:

transport - Expects either GRPC or REST Transport

Returns:

boolean if method should be generated for the transport

toBuilder

public abstract Method.Builder toBuilder()

builder

public static Method.Builder builder()

toStream

public static Method.Stream toStream(boolean isClientStreaming,
                                     boolean isServerStreaming)