Represents a Profile.
Package
@google-cloud/cloudprofilerConstructors
(constructor)(properties)
constructor(properties?: google.devtools.cloudprofiler.v2.IProfile);Constructs a new Profile.
| Parameter | |
|---|---|
| Name | Description |
properties |
IProfile
Properties to set |
Properties
deployment
public deployment?: (google.devtools.cloudprofiler.v2.IDeployment|null);Profile deployment.
duration
public duration?: (google.protobuf.IDuration|null);Profile duration.
labels
public labels: { [k: string]: string };Profile labels.
name
public name: string;Profile name.
profileBytes
public profileBytes: (Uint8Array|string);Profile profileBytes.
profileType
public profileType: (google.devtools.cloudprofiler.v2.ProfileType|keyof typeof google.devtools.cloudprofiler.v2.ProfileType);Profile profileType.
Methods
create(properties)
public static create(properties?: google.devtools.cloudprofiler.v2.IProfile): google.devtools.cloudprofiler.v2.Profile;Creates a new Profile instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IProfile
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Profile | Profile instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.devtools.cloudprofiler.v2.Profile;Decodes a Profile 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 |
Profile | Profile |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.devtools.cloudprofiler.v2.Profile;Decodes a Profile message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Profile | Profile |
encode(message, writer)
public static encode(message: google.devtools.cloudprofiler.v2.IProfile, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Profile message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IProfile
Profile 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.devtools.cloudprofiler.v2.IProfile, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Profile message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IProfile
Profile 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.devtools.cloudprofiler.v2.Profile;Creates a Profile 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 |
Profile | Profile |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Profile
| 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 Profile to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.devtools.cloudprofiler.v2.Profile, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Profile message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Profile
Profile |
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 Profile message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|