Class ApiConfigHandler.Builder (2.18.0)

public static final class ApiConfigHandler.Builder extends GeneratedMessageV3.Builder<ApiConfigHandler.Builder> implements ApiConfigHandlerOrBuilder

Google Cloud Endpoints configuration for API handlers.

Protobuf type google.appengine.v1.ApiConfigHandler

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ApiConfigHandler build()
Returns
TypeDescription
ApiConfigHandler

buildPartial()

public ApiConfigHandler buildPartial()
Returns
TypeDescription
ApiConfigHandler

clear()

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

clearAuthFailAction()

public ApiConfigHandler.Builder clearAuthFailAction()

Action to take when users access resources that require authentication. Defaults to redirect.

.google.appengine.v1.AuthFailAction auth_fail_action = 1;

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearLogin()

public ApiConfigHandler.Builder clearLogin()

Level of login required to access this resource. Defaults to optional.

.google.appengine.v1.LoginRequirement login = 2;

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearScript()

public ApiConfigHandler.Builder clearScript()

Path to the script from the application root directory.

string script = 3;

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

clearSecurityLevel()

public ApiConfigHandler.Builder clearSecurityLevel()

Security (HTTPS) enforcement for this URL.

.google.appengine.v1.SecurityLevel security_level = 4;

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

clearUrl()

public ApiConfigHandler.Builder clearUrl()

URL to serve the endpoint at.

string url = 5;

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

clone()

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

getAuthFailAction()

public AuthFailAction getAuthFailAction()

Action to take when users access resources that require authentication. Defaults to redirect.

.google.appengine.v1.AuthFailAction auth_fail_action = 1;

Returns
TypeDescription
AuthFailAction

The authFailAction.

getAuthFailActionValue()

public int getAuthFailActionValue()

Action to take when users access resources that require authentication. Defaults to redirect.

.google.appengine.v1.AuthFailAction auth_fail_action = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for authFailAction.

getDefaultInstanceForType()

public ApiConfigHandler getDefaultInstanceForType()
Returns
TypeDescription
ApiConfigHandler

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLogin()

public LoginRequirement getLogin()

Level of login required to access this resource. Defaults to optional.

.google.appengine.v1.LoginRequirement login = 2;

Returns
TypeDescription
LoginRequirement

The login.

getLoginValue()

public int getLoginValue()

Level of login required to access this resource. Defaults to optional.

.google.appengine.v1.LoginRequirement login = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for login.

getScript()

public String getScript()

Path to the script from the application root directory.

string script = 3;

Returns
TypeDescription
String

The script.

getScriptBytes()

public ByteString getScriptBytes()

Path to the script from the application root directory.

string script = 3;

Returns
TypeDescription
ByteString

The bytes for script.

getSecurityLevel()

public SecurityLevel getSecurityLevel()

Security (HTTPS) enforcement for this URL.

.google.appengine.v1.SecurityLevel security_level = 4;

Returns
TypeDescription
SecurityLevel

The securityLevel.

getSecurityLevelValue()

public int getSecurityLevelValue()

Security (HTTPS) enforcement for this URL.

.google.appengine.v1.SecurityLevel security_level = 4;

Returns
TypeDescription
int

The enum numeric value on the wire for securityLevel.

getUrl()

public String getUrl()

URL to serve the endpoint at.

string url = 5;

Returns
TypeDescription
String

The url.

getUrlBytes()

public ByteString getUrlBytes()

URL to serve the endpoint at.

string url = 5;

Returns
TypeDescription
ByteString

The bytes for url.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ApiConfigHandler other)

public ApiConfigHandler.Builder mergeFrom(ApiConfigHandler other)
Parameter
NameDescription
otherApiConfigHandler
Returns
TypeDescription
ApiConfigHandler.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ApiConfigHandler.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ApiConfigHandler.Builder
Overrides

setAuthFailAction(AuthFailAction value)

public ApiConfigHandler.Builder setAuthFailAction(AuthFailAction value)

Action to take when users access resources that require authentication. Defaults to redirect.

.google.appengine.v1.AuthFailAction auth_fail_action = 1;

Parameter
NameDescription
valueAuthFailAction

The authFailAction to set.

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

setAuthFailActionValue(int value)

public ApiConfigHandler.Builder setAuthFailActionValue(int value)

Action to take when users access resources that require authentication. Defaults to redirect.

.google.appengine.v1.AuthFailAction auth_fail_action = 1;

Parameter
NameDescription
valueint

The enum numeric value on the wire for authFailAction to set.

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setLogin(LoginRequirement value)

public ApiConfigHandler.Builder setLogin(LoginRequirement value)

Level of login required to access this resource. Defaults to optional.

.google.appengine.v1.LoginRequirement login = 2;

Parameter
NameDescription
valueLoginRequirement

The login to set.

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

setLoginValue(int value)

public ApiConfigHandler.Builder setLoginValue(int value)

Level of login required to access this resource. Defaults to optional.

.google.appengine.v1.LoginRequirement login = 2;

Parameter
NameDescription
valueint

The enum numeric value on the wire for login to set.

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

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

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

setScript(String value)

public ApiConfigHandler.Builder setScript(String value)

Path to the script from the application root directory.

string script = 3;

Parameter
NameDescription
valueString

The script to set.

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

setScriptBytes(ByteString value)

public ApiConfigHandler.Builder setScriptBytes(ByteString value)

Path to the script from the application root directory.

string script = 3;

Parameter
NameDescription
valueByteString

The bytes for script to set.

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

setSecurityLevel(SecurityLevel value)

public ApiConfigHandler.Builder setSecurityLevel(SecurityLevel value)

Security (HTTPS) enforcement for this URL.

.google.appengine.v1.SecurityLevel security_level = 4;

Parameter
NameDescription
valueSecurityLevel

The securityLevel to set.

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

setSecurityLevelValue(int value)

public ApiConfigHandler.Builder setSecurityLevelValue(int value)

Security (HTTPS) enforcement for this URL.

.google.appengine.v1.SecurityLevel security_level = 4;

Parameter
NameDescription
valueint

The enum numeric value on the wire for securityLevel to set.

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUrl(String value)

public ApiConfigHandler.Builder setUrl(String value)

URL to serve the endpoint at.

string url = 5;

Parameter
NameDescription
valueString

The url to set.

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.

setUrlBytes(ByteString value)

public ApiConfigHandler.Builder setUrlBytes(ByteString value)

URL to serve the endpoint at.

string url = 5;

Parameter
NameDescription
valueByteString

The bytes for url to set.

Returns
TypeDescription
ApiConfigHandler.Builder

This builder for chaining.