Class Profile (2.52.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
Type Description
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROFILE_BYTES_FIELD_NUMBER

public static final int PROFILE_BYTES_FIELD_NUMBER
Field Value
Type Description
int

PROFILE_TYPE_FIELD_NUMBER

public static final int PROFILE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Profile getDefaultInstance()
Returns
Type Description
Profile

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Profile.Builder newBuilder()
Returns
Type Description
Profile.Builder

newBuilder(Profile prototype)

public static Profile.Builder newBuilder(Profile prototype)
Parameter
Name Description
prototype Profile
Returns
Type Description
Profile.Builder

parseDelimitedFrom(InputStream input)

public static Profile parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Profile
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Profile parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Profile
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Profile parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Profile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Profile parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Profile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Profile parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Profile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Profile parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Profile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Profile parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Profile
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Profile parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Profile
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Profile parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Profile
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Profile parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Profile
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Profile parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Profile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Profile parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Profile
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Profile> parser()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Profile getDefaultInstanceForType()
Returns
Type Description
Profile

getDeployment()

public Deployment getDeployment()

Deployment this profile corresponds to.

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

Returns
Type Description
Deployment

The deployment.

getDeploymentOrBuilder()

public DeploymentOrBuilder getDeploymentOrBuilder()

Deployment this profile corresponds to.

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

Returns
Type Description
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
Type Description
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
Type Description
DurationOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Profile> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for profileType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Output only. Start time for the profile. This output is only present in response from the ListProfiles method.

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. Start time for the profile. This output is only present in response from the ListProfiles method.

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasDeployment()

public boolean hasDeployment()

Deployment this profile corresponds to.

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

Returns
Type Description
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
Type Description
boolean

Whether the duration field is set.

hasStartTime()

public boolean hasStartTime()

Output only. Start time for the profile. This output is only present in response from the ListProfiles method.

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Profile.Builder newBuilderForType()
Returns
Type Description
Profile.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Profile.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Profile.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Profile.Builder toBuilder()
Returns
Type Description
Profile.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException