Observability v1 API - Class TraceScopeName (1.0.0-beta01) 

public sealed class TraceScopeName : IResourceName, IEquatable<TraceScopeName>

Reference documentation and code samples for the Observability v1 API class TraceScopeName.

Resource name for the TraceScope resource.

Inheritance

object > TraceScopeName

Namespace

Google.Cloud.Observability.V1

Assembly

Google.Cloud.Observability.V1.dll

Constructors

TraceScopeName(string, string, string)

public TraceScopeName(string projectId, string locationId, string traceScopeId)

Constructs a new instance of a TraceScopeName class from the component parts of pattern projects/{project}/locations/{location}/traceScopes/{trace_scope}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
traceScopeId string

The TraceScope 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
bool

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

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

TraceScopeId

public string TraceScopeId { get; }

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

Property Value
Type Description
string

Type

public TraceScopeName.ResourceNameType Type { get; }

The TraceScopeName.ResourceNameType of the contained resource name.

Property Value
Type Description
TraceScopeNameResourceNameType

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 locationId, string traceScopeId)

Formats the IDs into the string representation of this TraceScopeName with pattern projects/{project}/locations/{location}/traceScopes/{trace_scope}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
traceScopeId string

The TraceScope ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this TraceScopeName with pattern projects/{project}/locations/{location}/traceScopes/{trace_scope}.

FormatProjectLocationTraceScope(string, string, string)

public static string FormatProjectLocationTraceScope(string projectId, string locationId, string traceScopeId)

Formats the IDs into the string representation of this TraceScopeName with pattern projects/{project}/locations/{location}/traceScopes/{trace_scope}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
traceScopeId string

The TraceScope ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this TraceScopeName with pattern projects/{project}/locations/{location}/traceScopes/{trace_scope}.

FromProjectLocationTraceScope(string, string, string)

public static TraceScopeName FromProjectLocationTraceScope(string projectId, string locationId, string traceScopeId)

Creates a TraceScopeName with the pattern projects/{project}/locations/{location}/traceScopes/{trace_scope}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
traceScopeId string

The TraceScope ID. Must not be null or empty.
Returns
Type Description
TraceScopeName

A new instance of TraceScopeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TraceScopeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TraceScopeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
TraceScopeName

A new instance of TraceScopeName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static TraceScopeName Parse(string traceScopeName)

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

Parameter
Name Description
traceScopeName string

The resource name in string form. Must not be null.
Returns
Type Description
TraceScopeName

The parsed TraceScopeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/traceScopes/{trace_scope}

Parse(string, bool)

public static TraceScopeName Parse(string traceScopeName, bool allowUnparsed)

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

Parameters
Name Description
traceScopeName string

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

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
TraceScopeName

The parsed TraceScopeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/traceScopes/{trace_scope}

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

TryParse(string, out TraceScopeName)

public static bool TryParse(string traceScopeName, out TraceScopeName result)

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

Parameters
Name Description
traceScopeName string

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

When this method returns, the parsed TraceScopeName, or null if parsing failed.
Returns
Type Description
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}/locations/{location}/traceScopes/{trace_scope}

TryParse(string, bool, out TraceScopeName)

public static bool TryParse(string traceScopeName, bool allowUnparsed, out TraceScopeName result)

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

Parameters
Name Description
traceScopeName string

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

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 TraceScopeName

When this method returns, the parsed TraceScopeName, or null if parsing failed.
Returns
Type Description
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}/locations/{location}/traceScopes/{trace_scope}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TraceScopeName, TraceScopeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TraceScopeName

The first resource name to compare, or null.
b TraceScopeName

The second resource name to compare, or null.
Returns
Type Description
bool

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

operator !=(TraceScopeName, TraceScopeName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TraceScopeName

The first resource name to compare, or null.
b TraceScopeName

The second resource name to compare, or null.
Returns
Type Description
bool

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