Class TimeSeriesName (3.1.0) 

public sealed class TimeSeriesName : IResourceName, IEquatable<TimeSeriesName>

Resource name for the TimeSeries resource.

Inheritance

Object > TimeSeriesName

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

TimeSeriesName(String, String)

public TimeSeriesName(string projectId, string timeSeriesId)

Constructs a new instance of a TimeSeriesName class from the component parts of pattern projects/{project}/timeSeries/{time_series}

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
timeSeriesId String

The TimeSeries ID. Must not be null or empty.

Properties

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
Boolean

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
String

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
String

TimeSeriesId

public string TimeSeriesId { get; }

The TimeSeries ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
String

Type

public TimeSeriesName.ResourceNameType Type { get; }

The TimeSeriesName.ResourceNameType of the contained resource name.

Property Value
Type Description
TimeSeriesName.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)

public static string Format(string projectId, string timeSeriesId)

Formats the IDs into the string representation of this TimeSeriesName with pattern projects/{project}/timeSeries/{time_series}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
timeSeriesId String

The TimeSeries ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this TimeSeriesName with pattern projects/{project}/timeSeries/{time_series}.

FormatFolderTimeSeries(String, String)

public static string FormatFolderTimeSeries(string folderId, string timeSeriesId)

Formats the IDs into the string representation of this TimeSeriesName with pattern folders/{folder}/timeSeries/{time_series}.

Parameters
Name Description
folderId String

The Folder ID. Must not be null or empty.
timeSeriesId String

The TimeSeries ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this TimeSeriesName with pattern folders/{folder}/timeSeries/{time_series}.

FormatOrganizationTimeSeries(String, String)

public static string FormatOrganizationTimeSeries(string organizationId, string timeSeriesId)

Formats the IDs into the string representation of this TimeSeriesName with pattern organizations/{organization}/timeSeries/{time_series}.

Parameters
Name Description
organizationId String

The Organization ID. Must not be null or empty.
timeSeriesId String

The TimeSeries ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this TimeSeriesName with pattern organizations/{organization}/timeSeries/{time_series}.

FormatProjectTimeSeries(String, String)

public static string FormatProjectTimeSeries(string projectId, string timeSeriesId)

Formats the IDs into the string representation of this TimeSeriesName with pattern projects/{project}/timeSeries/{time_series}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
timeSeriesId String

The TimeSeries ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this TimeSeriesName with pattern projects/{project}/timeSeries/{time_series}.

FromFolderTimeSeries(String, String)

public static TimeSeriesName FromFolderTimeSeries(string folderId, string timeSeriesId)

Creates a TimeSeriesName with the pattern folders/{folder}/timeSeries/{time_series}.

Parameters
Name Description
folderId String

The Folder ID. Must not be null or empty.
timeSeriesId String

The TimeSeries ID. Must not be null or empty.
Returns
Type Description
TimeSeriesName

A new instance of TimeSeriesName constructed from the provided ids.

FromOrganizationTimeSeries(String, String)

public static TimeSeriesName FromOrganizationTimeSeries(string organizationId, string timeSeriesId)

Creates a TimeSeriesName with the pattern organizations/{organization}/timeSeries/{time_series}.

Parameters
Name Description
organizationId String

The Organization ID. Must not be null or empty.
timeSeriesId String

The TimeSeries ID. Must not be null or empty.
Returns
Type Description
TimeSeriesName

A new instance of TimeSeriesName constructed from the provided ids.

FromProjectTimeSeries(String, String)

public static TimeSeriesName FromProjectTimeSeries(string projectId, string timeSeriesId)

Creates a TimeSeriesName with the pattern projects/{project}/timeSeries/{time_series}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
timeSeriesId String

The TimeSeries ID. Must not be null or empty.
Returns
Type Description
TimeSeriesName

A new instance of TimeSeriesName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TimeSeriesName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TimeSeriesName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of TimeSeriesName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static TimeSeriesName Parse(string timeSeriesName)

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

Parameter
Name Description
timeSeriesName String

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

The parsed TimeSeriesName if successful.
Remarks

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

  • projects/{project}/timeSeries/{time_series}
  • organizations/{organization}/timeSeries/{time_series}
  • folders/{folder}/timeSeries/{time_series}

Parse(String, Boolean)

public static TimeSeriesName Parse(string timeSeriesName, bool allowUnparsed)

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

Parameters
Name Description
timeSeriesName 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
TimeSeriesName

The parsed TimeSeriesName if successful.
Remarks

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

  • projects/{project}/timeSeries/{time_series}
  • organizations/{organization}/timeSeries/{time_series}
  • folders/{folder}/timeSeries/{time_series}
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 TimeSeriesName)

public static bool TryParse(string timeSeriesName, out TimeSeriesName result)

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

Parameters
Name Description
timeSeriesName String

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

When this method returns, the parsed TimeSeriesName, 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}/timeSeries/{time_series}
  • organizations/{organization}/timeSeries/{time_series}
  • folders/{folder}/timeSeries/{time_series}

TryParse(String, Boolean, out TimeSeriesName)

public static bool TryParse(string timeSeriesName, bool allowUnparsed, out TimeSeriesName result)

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

Parameters
Name Description
timeSeriesName 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 TimeSeriesName

When this method returns, the parsed TimeSeriesName, 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}/timeSeries/{time_series}
  • organizations/{organization}/timeSeries/{time_series}
  • folders/{folder}/timeSeries/{time_series}
Or may be in any format if allowUnparsed is true.

Operators

Equality(TimeSeriesName, TimeSeriesName)

public static bool operator ==(TimeSeriesName a, TimeSeriesName b)
Parameters
Name Description
a TimeSeriesName
b TimeSeriesName
Returns
Type Description
Boolean

Inequality(TimeSeriesName, TimeSeriesName)

public static bool operator !=(TimeSeriesName a, TimeSeriesName b)
Parameters
Name Description
a TimeSeriesName
b TimeSeriesName
Returns
Type Description
Boolean