Class TraceScope.Builder (0.3.0)

public static final class TraceScope.Builder extends GeneratedMessage.Builder<TraceScope.Builder> 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 Methods

getDescriptor()

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

Methods

addAllResourceNames(Iterable<String> values)

public TraceScope.Builder addAllResourceNames(Iterable<String> values)

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
values Iterable<String>

The resourceNames to add.

Returns
Type Description
TraceScope.Builder

This builder for chaining.

addResourceNames(String value)

public TraceScope.Builder addResourceNames(String value)

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
value String

The resourceNames to add.

Returns
Type Description
TraceScope.Builder

This builder for chaining.

addResourceNamesBytes(ByteString value)

public TraceScope.Builder addResourceNamesBytes(ByteString value)

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
value ByteString

The bytes of the resourceNames to add.

Returns
Type Description
TraceScope.Builder

This builder for chaining.

build()

public TraceScope build()
Returns
Type Description
TraceScope

buildPartial()

public TraceScope buildPartial()
Returns
Type Description
TraceScope

clear()

public TraceScope.Builder clear()
Returns
Type Description
TraceScope.Builder
Overrides

clearCreateTime()

public TraceScope.Builder clearCreateTime()

Output only. The creation timestamp of the trace scope.

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

Returns
Type Description
TraceScope.Builder

clearDescription()

public TraceScope.Builder clearDescription()

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
TraceScope.Builder

This builder for chaining.

clearName()

public TraceScope.Builder clearName()

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
TraceScope.Builder

This builder for chaining.

clearResourceNames()

public TraceScope.Builder clearResourceNames()

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
TraceScope.Builder

This builder for chaining.

clearUpdateTime()

public TraceScope.Builder clearUpdateTime()

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
TraceScope.Builder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The creation timestamp of the trace scope.

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

Returns
Type Description
Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public TraceScope.Builder mergeCreateTime(Timestamp value)

Output only. The creation timestamp of the trace scope.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TraceScope.Builder

mergeFrom(TraceScope other)

public TraceScope.Builder mergeFrom(TraceScope other)
Parameter
Name Description
other TraceScope
Returns
Type Description
TraceScope.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TraceScope.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TraceScope.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TraceScope.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TraceScope.Builder
Overrides

mergeUpdateTime(Timestamp value)

public TraceScope.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TraceScope.Builder

setCreateTime(Timestamp value)

public TraceScope.Builder setCreateTime(Timestamp value)

Output only. The creation timestamp of the trace scope.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TraceScope.Builder

setCreateTime(Timestamp.Builder builderForValue)

public TraceScope.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The creation timestamp of the trace scope.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TraceScope.Builder

setDescription(String value)

public TraceScope.Builder setDescription(String value)

Optional. Describes this trace scope.

The maximum length of the description is 8000 characters.

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
TraceScope.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public TraceScope.Builder setDescriptionBytes(ByteString value)

Optional. Describes this trace scope.

The maximum length of the description is 8000 characters.

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
TraceScope.Builder

This builder for chaining.

setName(String value)

public TraceScope.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
TraceScope.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TraceScope.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
TraceScope.Builder

This builder for chaining.

setResourceNames(int index, String value)

public TraceScope.Builder setResourceNames(int index, String value)

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) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The resourceNames to set.

Returns
Type Description
TraceScope.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public TraceScope.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TraceScope.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public TraceScope.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TraceScope.Builder