Send feedback
Class Help (2.61.3)
Stay organized with collections
Save and categorize content based on your preferences.
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
LINKS_FIELD_NUMBER
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 ()
newBuilder()
public static Help . Builder newBuilder ()
newBuilder(Help prototype)
public static Help . Builder newBuilder ( Help prototype )
Parameter
Name Description
prototypeHelp
public static Help parseDelimitedFrom ( InputStream input )
Returns
Type Description
Help
public static Help parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Help
parseFrom(byte[] data)
public static Help parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Help
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Help parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Help
parseFrom(ByteString data)
public static Help parseFrom ( ByteString data )
Returns
Type Description
Help
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Help parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Help
public static Help parseFrom ( CodedInputStream input )
Returns
Type Description
Help
public static Help parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Help
public static Help parseFrom ( InputStream input )
Returns
Type Description
Help
public static Help parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Help
parseFrom(ByteBuffer data)
public static Help parseFrom ( ByteBuffer data )
Returns
Type Description
Help
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Help parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Help
parser()
public static Parser<Help> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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
indexint
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;
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
indexint
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 ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Help . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Help . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Help . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-10 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-10 UTC."],[],[]]
