Google Cloud Monitoring v3 API - Class ServiceName (3.2.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ServiceName : IResourceName, IEquatable<ServiceName>

Reference documentation and code samples for the Google Cloud Monitoring v3 API class ServiceName.

Resource name for the Service resource.

Inheritance

Object > ServiceName

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

ServiceName(String, String)

public ServiceName(string projectId, string serviceId)

Constructs a new instance of a ServiceName class from the component parts of pattern projects/{project}/services/{service}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

serviceIdString

The Service 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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

OrganizationId

public string OrganizationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

ServiceId

public string ServiceId { get; }

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

Property Value
TypeDescription
String

Type

public ServiceName.ResourceNameType Type { get; }

The ServiceName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ServiceName.ResourceNameType

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)

public static string Format(string projectId, string serviceId)

Formats the IDs into the string representation of this ServiceName with pattern projects/{project}/services/{service}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

serviceIdString

The Service ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ServiceName with pattern projects/{project}/services/{service}.

FormatFolderService(String, String)

public static string FormatFolderService(string folderId, string serviceId)

Formats the IDs into the string representation of this ServiceName with pattern folders/{folder}/services/{service}.

Parameters
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

serviceIdString

The Service ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ServiceName with pattern folders/{folder}/services/{service}.

FormatOrganizationService(String, String)

public static string FormatOrganizationService(string organizationId, string serviceId)

Formats the IDs into the string representation of this ServiceName with pattern organizations/{organization}/services/{service}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

serviceIdString

The Service ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ServiceName with pattern organizations/{organization}/services/{service}.

FormatProjectService(String, String)

public static string FormatProjectService(string projectId, string serviceId)

Formats the IDs into the string representation of this ServiceName with pattern projects/{project}/services/{service}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

serviceIdString

The Service ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ServiceName with pattern projects/{project}/services/{service}.

FromFolderService(String, String)

public static ServiceName FromFolderService(string folderId, string serviceId)

Creates a ServiceName with the pattern folders/{folder}/services/{service}.

Parameters
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

serviceIdString

The Service ID. Must not be null or empty.

Returns
TypeDescription
ServiceName

A new instance of ServiceName constructed from the provided ids.

FromOrganizationService(String, String)

public static ServiceName FromOrganizationService(string organizationId, string serviceId)

Creates a ServiceName with the pattern organizations/{organization}/services/{service}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

serviceIdString

The Service ID. Must not be null or empty.

Returns
TypeDescription
ServiceName

A new instance of ServiceName constructed from the provided ids.

FromProjectService(String, String)

public static ServiceName FromProjectService(string projectId, string serviceId)

Creates a ServiceName with the pattern projects/{project}/services/{service}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

serviceIdString

The Service ID. Must not be null or empty.

Returns
TypeDescription
ServiceName

A new instance of ServiceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServiceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServiceName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ServiceName

A new instance of ServiceName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ServiceName Parse(string serviceName)

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

Parameter
NameDescription
serviceNameString

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

Returns
TypeDescription
ServiceName

The parsed ServiceName if successful.

Remarks

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

  • projects/{project}/services/{service}
  • organizations/{organization}/services/{service}
  • folders/{folder}/services/{service}

Parse(String, Boolean)

public static ServiceName Parse(string serviceName, bool allowUnparsed)

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

Parameters
NameDescription
serviceNameString

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

allowUnparsedBoolean

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
ServiceName

The parsed ServiceName if successful.

Remarks

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

  • projects/{project}/services/{service}
  • organizations/{organization}/services/{service}
  • folders/{folder}/services/{service}
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 ServiceName)

public static bool TryParse(string serviceName, out ServiceName result)

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

Parameters
NameDescription
serviceNameString

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

resultServiceName

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

Returns
TypeDescription
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}/services/{service}
  • organizations/{organization}/services/{service}
  • folders/{folder}/services/{service}

TryParse(String, Boolean, out ServiceName)

public static bool TryParse(string serviceName, bool allowUnparsed, out ServiceName result)

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

Parameters
NameDescription
serviceNameString

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

allowUnparsedBoolean

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.

resultServiceName

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

Returns
TypeDescription
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}/services/{service}
  • organizations/{organization}/services/{service}
  • folders/{folder}/services/{service}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ServiceName, ServiceName)

public static bool operator ==(ServiceName a, ServiceName b)
Parameters
NameDescription
aServiceName
bServiceName
Returns
TypeDescription
Boolean

Inequality(ServiceName, ServiceName)

public static bool operator !=(ServiceName a, ServiceName b)
Parameters
NameDescription
aServiceName
bServiceName
Returns
TypeDescription
Boolean