Class Profile (2.31.0)

public final class Profile extends GeneratedMessageV3 implements ProfileOrBuilder

Profile resource.

Protobuf type google.devtools.cloudprofiler.v2.Profile

Implements

ProfileOrBuilder

Static Fields

DEPLOYMENT_FIELD_NUMBER

public static final int DEPLOYMENT_FIELD_NUMBER
Field Value
TypeDescription
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROFILE_BYTES_FIELD_NUMBER

public static final int PROFILE_BYTES_FIELD_NUMBER
Field Value
TypeDescription
int

PROFILE_TYPE_FIELD_NUMBER

public static final int PROFILE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Profile getDefaultInstance()
Returns
TypeDescription
Profile

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Profile.Builder newBuilder()
Returns
TypeDescription
Profile.Builder

newBuilder(Profile prototype)

public static Profile.Builder newBuilder(Profile prototype)
Parameter
NameDescription
prototypeProfile
Returns
TypeDescription
Profile.Builder

parseDelimitedFrom(InputStream input)

public static Profile parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Profile
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Profile parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Profile
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Profile parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Profile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Profile parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Profile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Profile parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Profile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Profile parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Profile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Profile parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Profile
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Profile parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Profile
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Profile parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Profile
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Profile parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Profile
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Profile parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Profile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Profile parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Profile
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Profile> parser()
Returns
TypeDescription
Parser<Profile>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits.

map<string, string> labels = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Profile getDefaultInstanceForType()
Returns
TypeDescription
Profile

getDeployment()

public Deployment getDeployment()

Deployment this profile corresponds to.

.google.devtools.cloudprofiler.v2.Deployment deployment = 3;

Returns
TypeDescription
Deployment

The deployment.

getDeploymentOrBuilder()

public DeploymentOrBuilder getDeploymentOrBuilder()

Deployment this profile corresponds to.

.google.devtools.cloudprofiler.v2.Deployment deployment = 3;

Returns
TypeDescription
DeploymentOrBuilder

getDuration()

public Duration getDuration()

Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).

.google.protobuf.Duration duration = 4;

Returns
TypeDescription
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).

.google.protobuf.Duration duration = 4;

Returns
TypeDescription
DurationOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits.

map<string, string> labels = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits.

map<string, string> labels = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits.

map<string, string> labels = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits.

map<string, string> labels = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Output only. Opaque, server-assigned, unique ID for this profile.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Opaque, server-assigned, unique ID for this profile.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Profile> getParserForType()
Returns
TypeDescription
Parser<Profile>
Overrides

getProfileBytes()

public ByteString getProfileBytes()

Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.

bytes profile_bytes = 5 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ByteString

The profileBytes.

getProfileType()

public ProfileType getProfileType()

Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server.

.google.devtools.cloudprofiler.v2.ProfileType profile_type = 2;

Returns
TypeDescription
ProfileType

The profileType.

getProfileTypeValue()

public int getProfileTypeValue()

Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server.

.google.devtools.cloudprofiler.v2.ProfileType profile_type = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for profileType.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDeployment()

public boolean hasDeployment()

Deployment this profile corresponds to.

.google.devtools.cloudprofiler.v2.Deployment deployment = 3;

Returns
TypeDescription
boolean

Whether the deployment field is set.

hasDuration()

public boolean hasDuration()

Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).

.google.protobuf.Duration duration = 4;

Returns
TypeDescription
boolean

Whether the duration field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Profile.Builder newBuilderForType()
Returns
TypeDescription
Profile.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Profile.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Profile.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Profile.Builder toBuilder()
Returns
TypeDescription
Profile.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException