Represents an ApiConfigHandler.
Package
@google-cloud/appengine-adminConstructors
(constructor)(properties)
constructor(properties?: google.appengine.v1.IApiConfigHandler);
Constructs a new ApiConfigHandler.
Parameter | |
---|---|
Name | Description |
properties |
IApiConfigHandler
Properties to set |
Properties
authFailAction
public authFailAction: (google.appengine.v1.AuthFailAction|keyof typeof google.appengine.v1.AuthFailAction);
ApiConfigHandler authFailAction.
login
public login: (google.appengine.v1.LoginRequirement|keyof typeof google.appengine.v1.LoginRequirement);
ApiConfigHandler login.
script
public script: string;
ApiConfigHandler script.
securityLevel
public securityLevel: (google.appengine.v1.SecurityLevel|keyof typeof google.appengine.v1.SecurityLevel);
ApiConfigHandler securityLevel.
url
public url: string;
ApiConfigHandler url.
Methods
create(properties)
public static create(properties?: google.appengine.v1.IApiConfigHandler): google.appengine.v1.ApiConfigHandler;
Creates a new ApiConfigHandler instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IApiConfigHandler
Properties to set |
Returns | |
---|---|
Type | Description |
ApiConfigHandler | ApiConfigHandler instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.appengine.v1.ApiConfigHandler;
Decodes an ApiConfigHandler message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
ApiConfigHandler | ApiConfigHandler |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.appengine.v1.ApiConfigHandler;
Decodes an ApiConfigHandler message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
ApiConfigHandler | ApiConfigHandler |
encode(message, writer)
public static encode(message: google.appengine.v1.IApiConfigHandler, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified ApiConfigHandler message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IApiConfigHandler
ApiConfigHandler message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.appengine.v1.IApiConfigHandler, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified ApiConfigHandler message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IApiConfigHandler
ApiConfigHandler message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.appengine.v1.ApiConfigHandler;
Creates an ApiConfigHandler message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
ApiConfigHandler | ApiConfigHandler |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for ApiConfigHandler
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this ApiConfigHandler to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.appengine.v1.ApiConfigHandler, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an ApiConfigHandler message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
ApiConfigHandler
ApiConfigHandler |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies an ApiConfigHandler message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|