Class protos.google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest (2.2.1)

Represents an UpdateKeyRequest.

Package

@google-cloud/recaptcha-enterprise!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest);

Constructs a new UpdateKeyRequest.

Parameter
Name Description
properties google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest

Properties to set

Properties

key

public key?: (google.cloud.recaptchaenterprise.v1beta1.IKey|null);

UpdateKeyRequest key.

Property Value
Type Description
(google.cloud.recaptchaenterprise.v1beta1.IKey|null)

updateMask

public updateMask?: (google.protobuf.IFieldMask|null);

UpdateKeyRequest updateMask.

Property Value
Type Description
(google.protobuf.IFieldMask|null)

Methods

create(properties)

public static create(properties?: google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest): google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest;

Creates a new UpdateKeyRequest instance using the specified properties.

Parameter
Name Description
properties google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest

Properties to set
Returns
Type Description
google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest

UpdateKeyRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest;

Decodes an UpdateKeyRequest message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest

UpdateKeyRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest;

Decodes an UpdateKeyRequest message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest

UpdateKeyRequest

encode(message, writer)

public static encode(message: google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UpdateKeyRequest message. Does not implicitly messages.

Parameters
Name Description
message google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest

UpdateKeyRequest 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.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UpdateKeyRequest message, length delimited. Does not implicitly messages.

Parameters
Name Description
message google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest

UpdateKeyRequest 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.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest;

Creates an UpdateKeyRequest 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
google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest

UpdateKeyRequest

toJSON()

public toJSON(): { [k: string]: any };

Converts this UpdateKeyRequest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an UpdateKeyRequest message. Also converts values to other types if specified.

Parameters
Name Description
message google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest

UpdateKeyRequest
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 UpdateKeyRequest message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not