Google Cloud Trace v2 API - Class SpanName (3.1.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

Implements

IResourceName, IEquatable<SpanName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`traceId`	`String` The `Trace` ID. Must not be `null` or empty.
`spanId`	`String` 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
Type	Description
`Boolean`

ProjectId

public string ProjectId { get; }

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

Property Value
Type	Description
`String`

SpanId

public string SpanId { get; }

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

Property Value
Type	Description
`String`

TraceId

public string TraceId { get; }

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

Property Value
Type	Description
`String`

Type

public SpanName.ResourceNameType Type { get; }

The SpanName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SpanName.ResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`traceId`	`String` The `Trace` ID. Must not be `null` or empty.
`spanId`	`String` The `Span` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`traceId`	`String` The `Trace` ID. Must not be `null` or empty.
`spanId`	`String` The `Span` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`traceId`	`String` The `Trace` ID. Must not be `null` or empty.
`spanId`	`String` The `Span` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`SpanName`	A new instance of SpanName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static SpanName Parse(string spanName)

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

Parameter
Name	Description
`spanName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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, Boolean)

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
Name	Description
`spanName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
Type	Description
`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
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
`spanName`	`String` The resource name in string form. Must not be `null`.
`result`	`SpanName` When this method returns, the parsed SpanName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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, Boolean, 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
Name	Description
`spanName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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.
`result`	`SpanName` When this method returns, the parsed SpanName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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

Equality(SpanName, SpanName)

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

Parameters
Name	Description
`a`	`SpanName`
`b`	`SpanName`

Returns
Type	Description
`Boolean`

Inequality(SpanName, SpanName)

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

Parameters
Name	Description
`a`	`SpanName`
`b`	`SpanName`

Returns
Type	Description
`Boolean`