com.google.api.generator.gapic.model

Class RegionTag

java.lang.Object

com.google.api.generator.gapic.model.RegionTag

public abstract class RegionTag
extends Object

This model represents a code sample region tag. Matching region start and end region tag comments are used to determine the boundaries of code snippets to be used in documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionTag.Builder
static class	RegionTag.RegionTagRegion

Constructor Summary

Constructors

Constructor and Description
RegionTag()

Method Summary

Modifier and Type	Method and Description
abstract String	apiShortName()
abstract String	apiVersion()
static RegionTag.Builder	builder()
String	generate() Method to generate region tag comment text
static CommentStatement	generateTag(RegionTag.RegionTagRegion regionTagRegion, String regionTagContent)
abstract Boolean	isAsynchronous()
abstract String	overloadDisambiguation()
abstract String	rpcName()
abstract String	serviceName()
abstract RegionTag.Builder	toBuilder()
RegionTag	withApiShortName(String apiShortName) Helper method to easily update region tag apiShortName.
RegionTag	withApiVersion(String apiVersion) Helper method to easily update region tag apiVersion.
RegionTag	withOverloadDisambiguation(String overloadDisambiguation) Helper method to easily update region tag overloadDisambiguation.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionTag

public RegionTag()

Method Detail

apiShortName

public abstract String apiShortName()

apiVersion

public abstract String apiVersion()

serviceName

public abstract String serviceName()

rpcName

public abstract String rpcName()

overloadDisambiguation

public abstract String overloadDisambiguation()

isAsynchronous

public abstract Boolean isAsynchronous()

builder

public static RegionTag.Builder builder()

toBuilder

public abstract RegionTag.Builder toBuilder()

withApiVersion

public final RegionTag withApiVersion(String apiVersion)

Helper method to easily update region tag apiVersion.

Parameters:

apiVersion - String to replace region tag apiVersion

Returns:

RegionTag with updated apiVersion

withApiShortName

public final RegionTag withApiShortName(String apiShortName)

Helper method to easily update region tag apiShortName.

Parameters:

apiShortName - String to replace region tag apiShortName

Returns:

RegionTag with updated apiShortName

withOverloadDisambiguation

public final RegionTag withOverloadDisambiguation(String overloadDisambiguation)

Helper method to easily update region tag overloadDisambiguation.

Parameters:

overloadDisambiguation - String to replace region tag overloadDisambiguation

Returns:

RegionTag with updated overloadDisambiguation

generate

public String generate()

Method to generate region tag comment text

Returns:

region tag comment text

generateTag

public static CommentStatement generateTag(RegionTag.RegionTagRegion regionTagRegion,
                                           String regionTagContent)