Class protos.google.cloud.securitycenter.v1.Resource (8.11.0)

Represents a Resource.

Package

@google-cloud/security-center

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.securitycenter.v1.IResource);

Constructs a new Resource.

Parameter
Name Description
properties IResource

Properties to set

Properties

awsMetadata

public awsMetadata?: (google.cloud.securitycenter.v1.IAwsMetadata|null);

Resource awsMetadata.

azureMetadata

public azureMetadata?: (google.cloud.securitycenter.v1.IAzureMetadata|null);

Resource azureMetadata.

cloudProvider

public cloudProvider: (google.cloud.securitycenter.v1.CloudProvider|keyof typeof google.cloud.securitycenter.v1.CloudProvider);

Resource cloudProvider.

cloudProviderMetadata

public cloudProviderMetadata?: ("awsMetadata"|"azureMetadata");

Resource cloudProviderMetadata.

displayName

public displayName: string;

Resource displayName.

folders

public folders: google.cloud.securitycenter.v1.IFolder[];

Resource folders.

location

public location: string;

Resource location.

name

public name: string;

Resource name.

organization

public organization: string;

Resource organization.

parent

public parent: string;

Resource parent.

parentDisplayName

public parentDisplayName: string;

Resource parentDisplayName.

project

public project: string;

Resource project.

projectDisplayName

public projectDisplayName: string;

Resource projectDisplayName.

resourcePath

public resourcePath?: (google.cloud.securitycenter.v1.IResourcePath|null);

Resource resourcePath.

resourcePathString

public resourcePathString: string;

Resource resourcePathString.

service

public service: string;

Resource service.

type

public type: string;

Resource type.

Methods

create(properties)

public static create(properties?: google.cloud.securitycenter.v1.IResource): google.cloud.securitycenter.v1.Resource;

Creates a new Resource instance using the specified properties.

Parameter
Name Description
properties IResource

Properties to set

Returns
Type Description
Resource

Resource instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.securitycenter.v1.Resource;

Decodes a Resource 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
Resource

Resource

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.securitycenter.v1.Resource;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Resource

Resource

encode(message, writer)

public static encode(message: google.cloud.securitycenter.v1.IResource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Resource message. Does not implicitly messages.

Parameters
Name Description
message IResource

Resource 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.securitycenter.v1.IResource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IResource

Resource 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.securitycenter.v1.Resource;

Creates a Resource 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
Resource

Resource

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Resource

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Resource

Resource

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 Resource 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