Class TraceScope (0.3.0)

public final class TraceScope extends GeneratedMessage implements TraceScopeOrBuilder

A trace scope is a collection of resources whose traces are queried together.

Protobuf type google.cloud.observability.v1.TraceScope

Implements

TraceScopeOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_NAMES_FIELD_NUMBER

public static final int RESOURCE_NAMES_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TraceScope getDefaultInstance()
Returns
Type Description
TraceScope

getDescriptor()

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

newBuilder()

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

newBuilder(TraceScope prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<TraceScope> parser()
Returns
Type Description
Parser<TraceScope>

Methods

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation timestamp of the trace scope.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation timestamp of the trace scope.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public TraceScope getDefaultInstanceForType()
Returns
Type Description
TraceScope

getDescription()

public String getDescription()

Optional. Describes this trace scope.

The maximum length of the description is 8000 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Describes this trace scope.

The maximum length of the description is 8000 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getName()

public String getName()

Identifier. The resource name of the trace scope.

For example:

projects/my-project/locations/global/traceScopes/my-trace-scope

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the trace scope.

For example:

projects/my-project/locations/global/traceScopes/my-trace-scope

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<TraceScope> getParserForType()
Returns
Type Description
Parser<TraceScope>
Overrides

getResourceNames(int index)

public String getResourceNames(int index)

Required. Names of the projects that are included in this trace scope.

  • projects/[PROJECT_ID]

    A trace scope can include a maximum of 20 projects.

repeated string resource_names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The resourceNames at the given index.

getResourceNamesBytes(int index)

public ByteString getResourceNamesBytes(int index)

Required. Names of the projects that are included in this trace scope.

  • projects/[PROJECT_ID]

    A trace scope can include a maximum of 20 projects.

repeated string resource_names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the resourceNames at the given index.

getResourceNamesCount()

public int getResourceNamesCount()

Required. Names of the projects that are included in this trace scope.

  • projects/[PROJECT_ID]

    A trace scope can include a maximum of 20 projects.

repeated string resource_names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of resourceNames.

getResourceNamesList()

public ProtocolStringList getResourceNamesList()

Required. Names of the projects that are included in this trace scope.

  • projects/[PROJECT_ID]

    A trace scope can include a maximum of 20 projects.

repeated string resource_names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the resourceNames.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last update timestamp of the trace scope.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last update timestamp of the trace scope.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation timestamp of the trace scope.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last update timestamp of the trace scope.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected TraceScope.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TraceScope.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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