Class HomepageExtensionPoint.Builder (2.55.0)

public static final class HomepageExtensionPoint.Builder extends GeneratedMessageV3.Builder<HomepageExtensionPoint.Builder> implements HomepageExtensionPointOrBuilder

Common format for declaring an add-on's home-page view.

Protobuf type google.apps.script.type.HomepageExtensionPoint

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HomepageExtensionPoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides

build()

public HomepageExtensionPoint build()
Returns
Type Description
HomepageExtensionPoint

buildPartial()

public HomepageExtensionPoint buildPartial()
Returns
Type Description
HomepageExtensionPoint

clear()

public HomepageExtensionPoint.Builder clear()
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides

clearEnabled()

public HomepageExtensionPoint.Builder clearEnabled()

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Returns
Type Description
HomepageExtensionPoint.Builder

clearField(Descriptors.FieldDescriptor field)

public HomepageExtensionPoint.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public HomepageExtensionPoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides

clearRunFunction()

public HomepageExtensionPoint.Builder clearRunFunction()

Required. The endpoint to execute when this extension point is activated.

string run_function = 1;

Returns
Type Description
HomepageExtensionPoint.Builder

This builder for chaining.

clone()

public HomepageExtensionPoint.Builder clone()
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides

getDefaultInstanceForType()

public HomepageExtensionPoint getDefaultInstanceForType()
Returns
Type Description
HomepageExtensionPoint

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnabled()

public BoolValue getEnabled()

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Returns
Type Description
BoolValue

The enabled.

getEnabledBuilder()

public BoolValue.Builder getEnabledBuilder()

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Returns
Type Description
Builder

getEnabledOrBuilder()

public BoolValueOrBuilder getEnabledOrBuilder()

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Returns
Type Description
BoolValueOrBuilder

getRunFunction()

public String getRunFunction()

Required. The endpoint to execute when this extension point is activated.

string run_function = 1;

Returns
Type Description
String

The runFunction.

getRunFunctionBytes()

public ByteString getRunFunctionBytes()

Required. The endpoint to execute when this extension point is activated.

string run_function = 1;

Returns
Type Description
ByteString

The bytes for runFunction.

hasEnabled()

public boolean hasEnabled()

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Returns
Type Description
boolean

Whether the enabled field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEnabled(BoolValue value)

public HomepageExtensionPoint.Builder mergeEnabled(BoolValue value)

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Parameter
Name Description
value BoolValue
Returns
Type Description
HomepageExtensionPoint.Builder

mergeFrom(HomepageExtensionPoint other)

public HomepageExtensionPoint.Builder mergeFrom(HomepageExtensionPoint other)
Parameter
Name Description
other HomepageExtensionPoint
Returns
Type Description
HomepageExtensionPoint.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HomepageExtensionPoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HomepageExtensionPoint.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HomepageExtensionPoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides

setEnabled(BoolValue value)

public HomepageExtensionPoint.Builder setEnabled(BoolValue value)

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Parameter
Name Description
value BoolValue
Returns
Type Description
HomepageExtensionPoint.Builder

setEnabled(BoolValue.Builder builderForValue)

public HomepageExtensionPoint.Builder setEnabled(BoolValue.Builder builderForValue)

Optional. If set to false, disable the home-page view in this context.

Defaults to true if unset.

If an add-ons custom home-page view is disabled, an autogenerated overview card will be provided for users instead.

.google.protobuf.BoolValue enabled = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
HomepageExtensionPoint.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public HomepageExtensionPoint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides

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

public HomepageExtensionPoint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides

setRunFunction(String value)

public HomepageExtensionPoint.Builder setRunFunction(String value)

Required. The endpoint to execute when this extension point is activated.

string run_function = 1;

Parameter
Name Description
value String

The runFunction to set.

Returns
Type Description
HomepageExtensionPoint.Builder

This builder for chaining.

setRunFunctionBytes(ByteString value)

public HomepageExtensionPoint.Builder setRunFunctionBytes(ByteString value)

Required. The endpoint to execute when this extension point is activated.

string run_function = 1;

Parameter
Name Description
value ByteString

The bytes for runFunction to set.

Returns
Type Description
HomepageExtensionPoint.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final HomepageExtensionPoint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HomepageExtensionPoint.Builder
Overrides