Class protos.google.api.apikeys.v2.Restrictions (0.1.3)

Represents a Restrictions.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.api.apikeys.v2.IRestrictions);

Constructs a new Restrictions.

Parameter

Name	Description
properties	`IRestrictions` Properties to set

Properties

androidKeyRestrictions

public androidKeyRestrictions?: (google.api.apikeys.v2.IAndroidKeyRestrictions|null);

Restrictions androidKeyRestrictions.

apiTargets

public apiTargets: google.api.apikeys.v2.IApiTarget[];

Restrictions apiTargets.

browserKeyRestrictions

public browserKeyRestrictions?: (google.api.apikeys.v2.IBrowserKeyRestrictions|null);

Restrictions browserKeyRestrictions.

clientRestrictions

public clientRestrictions?: ("browserKeyRestrictions"|"serverKeyRestrictions"|"androidKeyRestrictions"|"iosKeyRestrictions");

Restrictions clientRestrictions.

iosKeyRestrictions

public iosKeyRestrictions?: (google.api.apikeys.v2.IIosKeyRestrictions|null);

Restrictions iosKeyRestrictions.

serverKeyRestrictions

public serverKeyRestrictions?: (google.api.apikeys.v2.IServerKeyRestrictions|null);

Restrictions serverKeyRestrictions.

Methods

create(properties)

public static create(properties?: google.api.apikeys.v2.IRestrictions): google.api.apikeys.v2.Restrictions;

Creates a new Restrictions instance using the specified properties.

Parameter

Name	Description
properties	`IRestrictions` Properties to set

Returns

Type	Description
google.api.apikeys.v2.Restrictions	Restrictions instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.apikeys.v2.Restrictions;

Decodes a Restrictions 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.api.apikeys.v2.Restrictions	Restrictions

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.apikeys.v2.Restrictions;

Decodes a Restrictions 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.api.apikeys.v2.Restrictions	Restrictions

encode(message, writer)

public static encode(message: google.api.apikeys.v2.IRestrictions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Restrictions message. Does not implicitly messages.

Parameters

Name	Description
message	`IRestrictions` Restrictions 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.api.apikeys.v2.IRestrictions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IRestrictions` Restrictions 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.api.apikeys.v2.Restrictions;

Creates a Restrictions 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.api.apikeys.v2.Restrictions	Restrictions

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Restrictions

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 Restrictions to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.api.apikeys.v2.Restrictions, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`google.api.apikeys.v2.Restrictions` Restrictions
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 Restrictions 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