Class Help.Builder (2.9.1)

public static final class Help.Builder extends GeneratedMessageV3.Builder<Help.Builder> 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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

public Help.Builder addAllLinks(Iterable<? extends Help.Link> values)

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

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

Parameter
NameDescription
valuesIterable<? extends com.google.rpc.Help.Link>
Returns
TypeDescription
Help.Builder
public Help.Builder addLinks(Help.Link value)

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

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

Parameter
NameDescription
valueHelp.Link
Returns
TypeDescription
Help.Builder
public Help.Builder addLinks(Help.Link.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueHelp.Link.Builder
Returns
TypeDescription
Help.Builder
public Help.Builder addLinks(int index, Help.Link value)

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

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

Parameters
NameDescription
indexint
valueHelp.Link
Returns
TypeDescription
Help.Builder
public Help.Builder addLinks(int index, Help.Link.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueHelp.Link.Builder
Returns
TypeDescription
Help.Builder

addLinksBuilder()

public Help.Link.Builder addLinksBuilder()

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

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

Returns
TypeDescription
Help.Link.Builder

addLinksBuilder(int index)

public Help.Link.Builder addLinksBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Help.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Help.Builder
Overrides

build()

public Help build()
Returns
TypeDescription
Help

buildPartial()

public Help buildPartial()
Returns
TypeDescription
Help

clear()

public Help.Builder clear()
Returns
TypeDescription
Help.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Help.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Help.Builder
Overrides
public Help.Builder clearLinks()

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

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

Returns
TypeDescription
Help.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Help.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Help.Builder
Overrides

clone()

public Help.Builder clone()
Returns
TypeDescription
Help.Builder
Overrides

getDefaultInstanceForType()

public Help getDefaultInstanceForType()
Returns
TypeDescription
Help

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides
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

getLinksBuilder(int index)

public Help.Link.Builder getLinksBuilder(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.Builder

getLinksBuilderList()

public List<Help.Link.Builder> getLinksBuilderList()

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

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

Returns
TypeDescription
List<Builder>

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Help.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Help.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Help.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Help.Builder
Overrides

mergeFrom(Help other)

public Help.Builder mergeFrom(Help other)
Parameter
NameDescription
otherHelp
Returns
TypeDescription
Help.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Help.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Help.Builder
Overrides
public Help.Builder removeLinks(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.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Help.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Help.Builder
Overrides
public Help.Builder setLinks(int index, Help.Link value)

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

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

Parameters
NameDescription
indexint
valueHelp.Link
Returns
TypeDescription
Help.Builder
public Help.Builder setLinks(int index, Help.Link.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueHelp.Link.Builder
Returns
TypeDescription
Help.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Help.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Help.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Help.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Help.Builder
Overrides