Class Help

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

Implements

HelpOrBuilder

Fields

public static final int LINKS_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static Help getDefaultInstance()
Returns
TypeDescription
Help

getDefaultInstanceForType()

public Help getDefaultInstanceForType()
Returns
TypeDescription
Help

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
int
public List<Help.Link> getLinksList()

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

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.rpc.Help.LinkOrBuilder>

getParserForType()

public Parser<Help> getParserForType()
Returns
TypeDescription
Parser<Help>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static Help.Builder newBuilder()
Returns
TypeDescription
Help.Builder

newBuilder(Help prototype)

public static Help.Builder newBuilder(Help prototype)
Parameter
NameDescription
prototypeHelp
Returns
TypeDescription
Help.Builder

newBuilderForType()

public Help.Builder newBuilderForType()
Returns
TypeDescription
Help.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Help.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Help.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static Help parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Help
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Help parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Help
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Help parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Help
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Help parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Help
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Help parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Help
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Help parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Help
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Help parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Help
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Help parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Help
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Help parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Help
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Help parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Help
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Help parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Help
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Help parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Help
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Help> parser()
Returns
TypeDescription
Parser<Help>

toBuilder()

public Help.Builder toBuilder()
Returns
TypeDescription
Help.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException