Represents a BasicAuthentication.
Package
@google-cloud/monitoringConstructors
(constructor)(properties)
constructor(properties?: google.monitoring.v3.UptimeCheckConfig.HttpCheck.IBasicAuthentication);
Constructs a new BasicAuthentication.
Parameter | |
---|---|
Name | Description |
properties |
IBasicAuthentication
Properties to set |
Properties
password
public password: string;
BasicAuthentication password.
username
public username: string;
BasicAuthentication username.
Methods
create(properties)
public static create(properties?: google.monitoring.v3.UptimeCheckConfig.HttpCheck.IBasicAuthentication): google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication;
Creates a new BasicAuthentication instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IBasicAuthentication
Properties to set |
Returns | |
---|---|
Type | Description |
BasicAuthentication | BasicAuthentication instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication;
Decodes a BasicAuthentication 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 |
BasicAuthentication | BasicAuthentication |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication;
Decodes a BasicAuthentication message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
BasicAuthentication | BasicAuthentication |
encode(message, writer)
public static encode(message: google.monitoring.v3.UptimeCheckConfig.HttpCheck.IBasicAuthentication, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified BasicAuthentication message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IBasicAuthentication
BasicAuthentication 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.monitoring.v3.UptimeCheckConfig.HttpCheck.IBasicAuthentication, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified BasicAuthentication message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IBasicAuthentication
BasicAuthentication 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.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication;
Creates a BasicAuthentication 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 |
BasicAuthentication | BasicAuthentication |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for BasicAuthentication
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 BasicAuthentication to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a BasicAuthentication message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
BasicAuthentication
BasicAuthentication |
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 a BasicAuthentication message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|