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

Class Sample

java.lang.Object

com.google.api.generator.gapic.model.Sample

public abstract class Sample
extends Object

This model represents a generated code sample. It contains the information needed to generate a sample file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Sample.Builder

Constructor Summary

Constructors

Constructor	Description
Sample()

Method Summary

Modifier and Type	Method	Description
abstract List<Statement>	body()
static Sample.Builder	builder()
abstract List<CommentStatement>	fileHeader()
abstract boolean	isCanonical()
abstract String	name()
abstract RegionTag	regionTag()
abstract Sample.Builder	toBuilder()
abstract List<AssignmentExpr>	variableAssignments()
final Sample	withHeader(List<CommentStatement> header)	Helper method to easily update Sample's license header.
final Sample	withRegionTag(RegionTag regionTag)	Helper method to easily update Sample's region tag.

Methods inherited from class java.lang.Object

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

Constructor Details

Sample

public Sample()

Method Details

body

public abstract List<Statement> body()

variableAssignments

public abstract List<AssignmentExpr> variableAssignments()

fileHeader

public abstract List<CommentStatement> fileHeader()

regionTag

public abstract RegionTag regionTag()

name

public abstract String name()

isCanonical

public abstract boolean isCanonical()

builder

public static Sample.Builder builder()

toBuilder

public abstract Sample.Builder toBuilder()

withHeader

public final Sample withHeader(List<CommentStatement> header)

Helper method to easily update Sample's license header.

Parameters:

header - List of CommentStatement to replace Sample's header

Returns:

Sample with updated header

withRegionTag

public final Sample withRegionTag(RegionTag regionTag)

Helper method to easily update Sample's region tag.

Parameters:

regionTag - RegionTag to replace Sample's header

Returns:

Sample with updated region tag.