Interface ProfileOrBuilder (2.46.0)

public interface ProfileOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

getDeployment()

public abstract Deployment getDeployment()

Deployment this profile corresponds to.

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

Returns
Type Description
Deployment

The deployment.

getDeploymentOrBuilder()

public abstract DeploymentOrBuilder getDeploymentOrBuilder()

Deployment this profile corresponds to.

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

Returns
Type Description
DeploymentOrBuilder

getDuration()

public abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getProfileBytes()

public abstract 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 abstract 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 abstract 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.

getStartTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.