com.google.devtools.cloudprofiler.v2

Interface ProfileOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Profile, Profile.Builder

public interface ProfileOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Input only.
Deployment	getDeployment() Deployment this profile corresponds to.
DeploymentOrBuilder	getDeploymentOrBuilder() Deployment this profile corresponds to.
com.google.protobuf.Duration	getDuration() Duration of the profiling session.
com.google.protobuf.DurationOrBuilder	getDurationOrBuilder() Duration of the profiling session.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Input only.
Map<String,String>	getLabelsMap() Input only.
String	getLabelsOrDefault(String key, String defaultValue) Input only.
String	getLabelsOrThrow(String key) Input only.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
com.google.protobuf.ByteString	getProfileBytes() Input only.
ProfileType	getProfileType() Type of profile.
int	getProfileTypeValue() Type of profile.
com.google.protobuf.Timestamp	getStartTime() Output only.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Output only.
boolean	hasDeployment() Deployment this profile corresponds to.
boolean	hasDuration() Duration of the profiling session.
boolean	hasStartTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

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

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

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

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

Returns:

The bytes for name.

getProfileTypeValue

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:

The enum numeric value on the wire for profileType.

getProfileType

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:

The profileType.

hasDeployment

boolean hasDeployment()

 Deployment this profile corresponds to.
 

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

Returns:

Whether the deployment field is set.

getDeployment

Deployment getDeployment()

 Deployment this profile corresponds to.
 

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

Returns:

The deployment.

getDeploymentOrBuilder

DeploymentOrBuilder getDeploymentOrBuilder()

 Deployment this profile corresponds to.
 

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

hasDuration

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:

Whether the duration field is set.

getDuration

com.google.protobuf.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:

The duration.

getDurationOrBuilder

com.google.protobuf.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;

getProfileBytes

com.google.protobuf.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:

The profileBytes.

getLabelsCount

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];

containsLabels

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];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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];

getLabelsOrDefault

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];

getLabelsOrThrow

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];

hasStartTime

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:

Whether the startTime field is set.

getStartTime

com.google.protobuf.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:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.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];