public final class Help extends GeneratedMessage 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.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,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 |
prototype |
Help
|
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 |
data |
byte[]
|
| 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 |
obj |
Object
|
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
|
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 |
index |
int
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Help.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Help.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Help.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides