Represents an UrlMap.
Package
@google-cloud/appengine-adminConstructors
(constructor)(properties)
constructor(properties?: google.appengine.v1.IUrlMap);Constructs a new UrlMap.
| Parameter | |
|---|---|
| Name | Description |
properties |
IUrlMap
Properties to set |
Properties
apiEndpoint
public apiEndpoint?: (google.appengine.v1.IApiEndpointHandler|null);UrlMap apiEndpoint.
authFailAction
public authFailAction: (google.appengine.v1.AuthFailAction|keyof typeof google.appengine.v1.AuthFailAction);UrlMap authFailAction.
handlerType
public handlerType?: ("staticFiles"|"script"|"apiEndpoint");UrlMap handlerType.
login
public login: (google.appengine.v1.LoginRequirement|keyof typeof google.appengine.v1.LoginRequirement);UrlMap login.
redirectHttpResponseCode
public redirectHttpResponseCode: (google.appengine.v1.UrlMap.RedirectHttpResponseCode|keyof typeof google.appengine.v1.UrlMap.RedirectHttpResponseCode);UrlMap redirectHttpResponseCode.
script
public script?: (google.appengine.v1.IScriptHandler|null);UrlMap script.
securityLevel
public securityLevel: (google.appengine.v1.SecurityLevel|keyof typeof google.appengine.v1.SecurityLevel);UrlMap securityLevel.
staticFiles
public staticFiles?: (google.appengine.v1.IStaticFilesHandler|null);UrlMap staticFiles.
urlRegex
public urlRegex: string;UrlMap urlRegex.
Methods
create(properties)
public static create(properties?: google.appengine.v1.IUrlMap): google.appengine.v1.UrlMap;Creates a new UrlMap instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IUrlMap
Properties to set |
| Returns | |
|---|---|
| Type | Description |
UrlMap | UrlMap instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.appengine.v1.UrlMap;Decodes an UrlMap 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 |
UrlMap | UrlMap |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.appengine.v1.UrlMap;Decodes an UrlMap message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
UrlMap | UrlMap |
encode(message, writer)
public static encode(message: google.appengine.v1.IUrlMap, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified UrlMap message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IUrlMap
UrlMap 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.IUrlMap, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified UrlMap message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IUrlMap
UrlMap 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.UrlMap;Creates an UrlMap 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 |
UrlMap | UrlMap |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for UrlMap
| 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 UrlMap to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.appengine.v1.UrlMap, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an UrlMap message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
UrlMap
UrlMap |
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 UrlMap message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|