Class protos.google.identity.accesscontextmanager.v1.ServicePerimeter (1.0.0)

Represents a ServicePerimeter.

Package

@google-cloud/access-context-manager

Constructors

(constructor)(properties)

constructor(properties?: google.identity.accesscontextmanager.v1.IServicePerimeter);

Constructs a new ServicePerimeter.

Parameter
NameDescription
properties IServicePerimeter

Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

ServicePerimeter createTime.

description

public description: string;

ServicePerimeter description.

name

public name: string;

ServicePerimeter name.

perimeterType

public perimeterType: (google.identity.accesscontextmanager.v1.ServicePerimeter.PerimeterType|keyof typeof google.identity.accesscontextmanager.v1.ServicePerimeter.PerimeterType);

ServicePerimeter perimeterType.

spec

public spec?: (google.identity.accesscontextmanager.v1.IServicePerimeterConfig|null);

ServicePerimeter spec.

status

public status?: (google.identity.accesscontextmanager.v1.IServicePerimeterConfig|null);

ServicePerimeter status.

title

public title: string;

ServicePerimeter title.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

ServicePerimeter updateTime.

useExplicitDryRunSpec

public useExplicitDryRunSpec: boolean;

ServicePerimeter useExplicitDryRunSpec.

Methods

create(properties)

public static create(properties?: google.identity.accesscontextmanager.v1.IServicePerimeter): google.identity.accesscontextmanager.v1.ServicePerimeter;

Creates a new ServicePerimeter instance using the specified properties.

Parameter
NameDescription
properties IServicePerimeter

Properties to set

Returns
TypeDescription
google.identity.accesscontextmanager.v1.ServicePerimeter

ServicePerimeter instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.identity.accesscontextmanager.v1.ServicePerimeter;

Decodes a ServicePerimeter message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.identity.accesscontextmanager.v1.ServicePerimeter

ServicePerimeter

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.identity.accesscontextmanager.v1.ServicePerimeter;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.identity.accesscontextmanager.v1.ServicePerimeter

ServicePerimeter

encode(message, writer)

public static encode(message: google.identity.accesscontextmanager.v1.IServicePerimeter, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ServicePerimeter message. Does not implicitly messages.

Parameters
NameDescription
message IServicePerimeter

ServicePerimeter 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.identity.accesscontextmanager.v1.IServicePerimeter, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IServicePerimeter

ServicePerimeter 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.identity.accesscontextmanager.v1.ServicePerimeter;

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

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

Plain object

Returns
TypeDescription
google.identity.accesscontextmanager.v1.ServicePerimeter

ServicePerimeter

toJSON()

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

Converts this ServicePerimeter to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.identity.accesscontextmanager.v1.ServicePerimeter

ServicePerimeter

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