Class protos.google.api.servicecontrol.v2.ResourceInfo (3.3.0)

Represents a ResourceInfo.

Package

@google-cloud/service-control

Constructors

(constructor)(properties)

constructor(properties?: google.api.servicecontrol.v2.IResourceInfo);

Constructs a new ResourceInfo.

Parameter
NameDescription
properties IResourceInfo

Properties to set

Properties

container

public container: string;

ResourceInfo container.

location

public location: string;

ResourceInfo location.

name

public name: string;

ResourceInfo name.

permission

public permission: string;

ResourceInfo permission.

type

public type: string;

ResourceInfo type.

Methods

create(properties)

public static create(properties?: google.api.servicecontrol.v2.IResourceInfo): google.api.servicecontrol.v2.ResourceInfo;

Creates a new ResourceInfo instance using the specified properties.

Parameter
NameDescription
properties IResourceInfo

Properties to set

Returns
TypeDescription
ResourceInfo

ResourceInfo instance

decode(reader, length)

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

Decodes a ResourceInfo message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
ResourceInfo

ResourceInfo

decodeDelimited(reader)

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

Decodes a ResourceInfo message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
ResourceInfo

ResourceInfo

encode(message, writer)

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

Encodes the specified ResourceInfo message. Does not implicitly messages.

Parameters
NameDescription
message IResourceInfo

ResourceInfo message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.api.servicecontrol.v2.IResourceInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IResourceInfo

ResourceInfo message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.api.servicecontrol.v2.ResourceInfo;

Creates a ResourceInfo message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
ResourceInfo

ResourceInfo

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ResourceInfo

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this ResourceInfo to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message ResourceInfo

ResourceInfo

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a ResourceInfo message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not