Google Cloud Support v2 API - Class CaseName (1.2.0) 

public sealed class CaseName : IResourceName, IEquatable<CaseName>

Reference documentation and code samples for the Google Cloud Support v2 API class CaseName.

Resource name for the Case resource.

Inheritance

object > CaseName

Namespace

Google.Cloud.Support.V2

Assembly

Google.Cloud.Support.V2.dll

Constructors

CaseName(string, string)

public CaseName(string organizationId, string caseId)

Constructs a new instance of a CaseName class from the component parts of pattern organizations/{organization}/cases/{case}

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
caseId string

The Case ID. Must not be null or empty.

Properties

CaseId

public string CaseId { get; }

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

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

Type

public CaseName.ResourceNameType Type { get; }

The CaseName.ResourceNameType of the contained resource name.

Property Value
Type Description
CaseNameResourceNameType

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 organizationId, string caseId)

Formats the IDs into the string representation of this CaseName with pattern organizations/{organization}/cases/{case}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
caseId string

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

The string representation of this CaseName with pattern organizations/{organization}/cases/{case}.

FormatOrganizationCase(string, string)

public static string FormatOrganizationCase(string organizationId, string caseId)

Formats the IDs into the string representation of this CaseName with pattern organizations/{organization}/cases/{case}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
caseId string

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

The string representation of this CaseName with pattern organizations/{organization}/cases/{case}.

FormatProjectCase(string, string)

public static string FormatProjectCase(string projectId, string caseId)

Formats the IDs into the string representation of this CaseName with pattern projects/{project}/cases/{case}.

Parameters
Name Description
projectId string

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

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

The string representation of this CaseName with pattern projects/{project}/cases/{case} .

FromOrganizationCase(string, string)

public static CaseName FromOrganizationCase(string organizationId, string caseId)

Creates a CaseName with the pattern organizations/{organization}/cases/{case}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
caseId string

The Case ID. Must not be null or empty.
Returns
Type Description
CaseName

A new instance of CaseName constructed from the provided ids.

FromProjectCase(string, string)

public static CaseName FromProjectCase(string projectId, string caseId)

Creates a CaseName with the pattern projects/{project}/cases/{case}.

Parameters
Name Description
projectId string

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

The Case ID. Must not be null or empty.
Returns
Type Description
CaseName

A new instance of CaseName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CaseName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CaseName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
caseName string

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

The parsed CaseName if successful.
Remarks

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

  • organizations/{organization}/cases/{case}
  • projects/{project}/cases/{case}

Parse(string, bool)

public static CaseName Parse(string caseName, bool allowUnparsed)

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

Parameters
Name Description
caseName 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
CaseName

The parsed CaseName if successful.
Remarks

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

  • organizations/{organization}/cases/{case}
  • projects/{project}/cases/{case}
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 CaseName)

public static bool TryParse(string caseName, out CaseName result)

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

Parameters
Name Description
caseName string

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

When this method returns, the parsed CaseName, 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:

  • organizations/{organization}/cases/{case}
  • projects/{project}/cases/{case}

TryParse(string, bool, out CaseName)

public static bool TryParse(string caseName, bool allowUnparsed, out CaseName result)

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

Parameters
Name Description
caseName 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 CaseName

When this method returns, the parsed CaseName, 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:

  • organizations/{organization}/cases/{case}
  • projects/{project}/cases/{case}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CaseName, CaseName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CaseName

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

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 !=(CaseName, CaseName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CaseName

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

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.