Class Help (2.14.3) 

public final class Help extends GeneratedMessageV3 implements HelpOrBuilder

Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

Protobuf type google.rpc.Help

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Help

Implements

HelpOrBuilder

Static Fields 

public static final int LINKS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Help getDefaultInstance()
Returns
Type Description
Help

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Help.Builder newBuilder()
Returns
Type Description
Help.Builder

newBuilder(Help prototype)

public static Help.Builder newBuilder(Help prototype)
Parameter
Name Description
prototype Help
Returns
Type Description
Help.Builder

parseDelimitedFrom(InputStream input)

public static Help parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Help
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Help parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Help
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Help parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Help
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Help parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Help
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Help parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Help
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Help parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Help
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Help parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Help
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Help parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Help
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Help parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Help
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Help parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Help
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Help parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Help
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Help parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Help
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Help> parser()
Returns
Type Description
Parser<Help>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Help getDefaultInstanceForType()
Returns
Type Description
Help

getLinks(int index)

public Help.Link getLinks(int index)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameter
Name Description
index int
Returns
Type Description
Help.Link

getLinksCount()

public int getLinksCount()

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Returns
Type Description
int

getLinksList()

public List<Help.Link> getLinksList()

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Returns
Type Description
List<Link>

getLinksOrBuilder(int index)

public Help.LinkOrBuilder getLinksOrBuilder(int index)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameter
Name Description
index int
Returns
Type Description
Help.LinkOrBuilder

getLinksOrBuilderList()

public List<? extends Help.LinkOrBuilder> getLinksOrBuilderList()

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Returns
Type Description
List<? extends com.google.rpc.Help.LinkOrBuilder>

getParserForType()

public Parser<Help> getParserForType()
Returns
Type Description
Parser<Help>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Help.Builder newBuilderForType()
Returns
Type Description
Help.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Help.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description