Google Cloud Trace v2 API - Class SpanName (3.5.0)

public sealed class SpanName : IResourceName, IEquatable<SpanName>

Reference documentation and code samples for the Google Cloud Trace v2 API class SpanName.

Resource name for the Span resource.

Inheritance

object > SpanName

Namespace

Google.Cloud.Trace.V2

Assembly

Google.Cloud.Trace.V2.dll

Constructors

SpanName(string, string, string)

public SpanName(string projectId, string traceId, string spanId)

Constructs a new instance of a SpanName class from the component parts of pattern projects/{project}/traces/{trace}/spans/{span}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

traceIdstring

The Trace ID. Must not be null or empty.

spanIdstring

The Span ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

SpanId

public string SpanId { get; }

The Span ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

TraceId

public string TraceId { get; }

The Trace ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Type

public SpanName.ResourceNameType Type { get; }

The SpanName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SpanNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string projectId, string traceId, string spanId)

Formats the IDs into the string representation of this SpanName with pattern projects/{project}/traces/{trace}/spans/{span}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

traceIdstring

The Trace ID. Must not be null or empty.

spanIdstring

The Span ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this SpanName with pattern projects/{project}/traces/{trace}/spans/{span}.

FormatProjectTraceSpan(string, string, string)

public static string FormatProjectTraceSpan(string projectId, string traceId, string spanId)

Formats the IDs into the string representation of this SpanName with pattern projects/{project}/traces/{trace}/spans/{span}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

traceIdstring

The Trace ID. Must not be null or empty.

spanIdstring

The Span ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this SpanName with pattern projects/{project}/traces/{trace}/spans/{span}.

FromProjectTraceSpan(string, string, string)

public static SpanName FromProjectTraceSpan(string projectId, string traceId, string spanId)

Creates a SpanName with the pattern projects/{project}/traces/{trace}/spans/{span}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

traceIdstring

The Trace ID. Must not be null or empty.

spanIdstring

The Span ID. Must not be null or empty.

Returns
TypeDescription
SpanName

A new instance of SpanName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SpanName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SpanName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
SpanName

A new instance of SpanName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static SpanName Parse(string spanName)

Parses the given resource name string into a new SpanName instance.

Parameter
NameDescription
spanNamestring

The resource name in string form. Must not be null.

Returns
TypeDescription
SpanName

The parsed SpanName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/traces/{trace}/spans/{span}

Parse(string, bool)

public static SpanName Parse(string spanName, bool allowUnparsed)

Parses the given resource name string into a new SpanName instance; optionally allowing an unparseable resource name.

Parameters
NameDescription
spanNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
TypeDescription
SpanName

The parsed SpanName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/traces/{trace}/spans/{span}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out SpanName)

public static bool TryParse(string spanName, out SpanName result)

Tries to parse the given resource name string into a new SpanName instance.

Parameters
NameDescription
spanNamestring

The resource name in string form. Must not be null.

resultSpanName

When this method returns, the parsed SpanName, or null if parsing failed.

Returns
TypeDescription
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/traces/{trace}/spans/{span}

TryParse(string, bool, out SpanName)

public static bool TryParse(string spanName, bool allowUnparsed, out SpanName result)

Tries to parse the given resource name string into a new SpanName instance; optionally allowing an unparseable resource name.

Parameters
NameDescription
spanNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

resultSpanName

When this method returns, the parsed SpanName, or null if parsing failed.

Returns
TypeDescription
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/traces/{trace}/spans/{span}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SpanName, SpanName)

public static bool operator ==(SpanName a, SpanName b)

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aSpanName

The first resource name to compare, or null.

bSpanName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(SpanName, SpanName)

public static bool operator !=(SpanName a, SpanName b)

Determines whether two specified resource names have different values.

Parameters
NameDescription
aSpanName

The first resource name to compare, or null.

bSpanName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.