Google Cloud Monitoring v3 API - Class ServiceLevelObjectiveName (3.5.0)

public sealed class ServiceLevelObjectiveName : IResourceName, IEquatable<ServiceLevelObjectiveName>

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

Resource name for the ServiceLevelObjective resource.

Inheritance

object > ServiceLevelObjectiveName

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

ServiceLevelObjectiveName(string, string, string)

public ServiceLevelObjectiveName(string projectId, string serviceId, string serviceLevelObjectiveId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

serviceLevelObjectiveIdstring

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

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

ServiceLevelObjectiveId

public string ServiceLevelObjectiveId { get; }

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

Property Value
TypeDescription
string

Type

public ServiceLevelObjectiveName.ResourceNameType Type { get; }

The ServiceLevelObjectiveName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ServiceLevelObjectiveNameResourceNameType

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 serviceId, string serviceLevelObjectiveId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

serviceLevelObjectiveIdstring

The ServiceLevelObjective ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ServiceLevelObjectiveName with pattern projects/{project}/services/{service}/serviceLevelObjectives/{service_level_objective}.

FormatFolderServiceServiceLevelObjective(string, string, string)

public static string FormatFolderServiceServiceLevelObjective(string folderId, string serviceId, string serviceLevelObjectiveId)

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

Parameters
NameDescription
folderIdstring

The Folder ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

serviceLevelObjectiveIdstring

The ServiceLevelObjective ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ServiceLevelObjectiveName with pattern folders/{folder}/services/{service}/serviceLevelObjectives/{service_level_objective}.

FormatOrganizationServiceServiceLevelObjective(string, string, string)

public static string FormatOrganizationServiceServiceLevelObjective(string organizationId, string serviceId, string serviceLevelObjectiveId)

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

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

serviceLevelObjectiveIdstring

The ServiceLevelObjective ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ServiceLevelObjectiveName with pattern organizations/{organization}/services/{service}/serviceLevelObjectives/{service_level_objective}.

FormatProjectServiceServiceLevelObjective(string, string, string)

public static string FormatProjectServiceServiceLevelObjective(string projectId, string serviceId, string serviceLevelObjectiveId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

serviceLevelObjectiveIdstring

The ServiceLevelObjective ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ServiceLevelObjectiveName with pattern projects/{project}/services/{service}/serviceLevelObjectives/{service_level_objective}.

FromFolderServiceServiceLevelObjective(string, string, string)

public static ServiceLevelObjectiveName FromFolderServiceServiceLevelObjective(string folderId, string serviceId, string serviceLevelObjectiveId)

Creates a ServiceLevelObjectiveName with the pattern folders/{folder}/services/{service}/serviceLevelObjectives/{service_level_objective}.

Parameters
NameDescription
folderIdstring

The Folder ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

serviceLevelObjectiveIdstring

The ServiceLevelObjective ID. Must not be null or empty.

Returns
TypeDescription
ServiceLevelObjectiveName

A new instance of ServiceLevelObjectiveName constructed from the provided ids.

FromOrganizationServiceServiceLevelObjective(string, string, string)

public static ServiceLevelObjectiveName FromOrganizationServiceServiceLevelObjective(string organizationId, string serviceId, string serviceLevelObjectiveId)

Creates a ServiceLevelObjectiveName with the pattern organizations/{organization}/services/{service}/serviceLevelObjectives/{service_level_objective}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

serviceLevelObjectiveIdstring

The ServiceLevelObjective ID. Must not be null or empty.

Returns
TypeDescription
ServiceLevelObjectiveName

A new instance of ServiceLevelObjectiveName constructed from the provided ids.

FromProjectServiceServiceLevelObjective(string, string, string)

public static ServiceLevelObjectiveName FromProjectServiceServiceLevelObjective(string projectId, string serviceId, string serviceLevelObjectiveId)

Creates a ServiceLevelObjectiveName with the pattern projects/{project}/services/{service}/serviceLevelObjectives/{service_level_objective}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

serviceLevelObjectiveIdstring

The ServiceLevelObjective ID. Must not be null or empty.

Returns
TypeDescription
ServiceLevelObjectiveName

A new instance of ServiceLevelObjectiveName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServiceLevelObjectiveName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServiceLevelObjectiveName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ServiceLevelObjectiveName

A new instance of ServiceLevelObjectiveName 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 ServiceLevelObjectiveName Parse(string serviceLevelObjectiveName)

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

Parameter
NameDescription
serviceLevelObjectiveNamestring

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

Returns
TypeDescription
ServiceLevelObjectiveName

The parsed ServiceLevelObjectiveName if successful.

Remarks

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

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

Parse(string, bool)

public static ServiceLevelObjectiveName Parse(string serviceLevelObjectiveName, bool allowUnparsed)

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

Parameters
NameDescription
serviceLevelObjectiveNamestring

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
ServiceLevelObjectiveName

The parsed ServiceLevelObjectiveName if successful.

Remarks

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

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

public static bool TryParse(string serviceLevelObjectiveName, out ServiceLevelObjectiveName result)

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

Parameters
NameDescription
serviceLevelObjectiveNamestring

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

resultServiceLevelObjectiveName

When this method returns, the parsed ServiceLevelObjectiveName, 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}/services/{service}/serviceLevelObjectives/{service_level_objective}
  • organizations/{organization}/services/{service}/serviceLevelObjectives/{service_level_objective}
  • folders/{folder}/services/{service}/serviceLevelObjectives/{service_level_objective}

TryParse(string, bool, out ServiceLevelObjectiveName)

public static bool TryParse(string serviceLevelObjectiveName, bool allowUnparsed, out ServiceLevelObjectiveName result)

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

Parameters
NameDescription
serviceLevelObjectiveNamestring

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.

resultServiceLevelObjectiveName

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

Operators

operator ==(ServiceLevelObjectiveName, ServiceLevelObjectiveName)

public static bool operator ==(ServiceLevelObjectiveName a, ServiceLevelObjectiveName b)
Parameters
NameDescription
aServiceLevelObjectiveName
bServiceLevelObjectiveName
Returns
TypeDescription
bool

operator !=(ServiceLevelObjectiveName, ServiceLevelObjectiveName)

public static bool operator !=(ServiceLevelObjectiveName a, ServiceLevelObjectiveName b)
Parameters
NameDescription
aServiceLevelObjectiveName
bServiceLevelObjectiveName
Returns
TypeDescription
bool