Google Cloud Support v2beta API - Class EmailMessageName (1.0.0-beta02) 

public sealed class EmailMessageName : IResourceName, IEquatable<EmailMessageName>

Reference documentation and code samples for the Google Cloud Support v2beta API class EmailMessageName.

Resource name for the EmailMessage resource.

Inheritance

object > EmailMessageName

Namespace

Google.Cloud.Support.V2Beta

Assembly

Google.Cloud.Support.V2Beta.dll

Constructors

EmailMessageName(string, string, string)

public EmailMessageName(string projectId, string caseId, string emailMessageId)

Constructs a new instance of a EmailMessageName class from the component parts of pattern projects/{project}/cases/{case}/emailMessages/{email_message}

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.
emailMessageId string

The EmailMessage 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

EmailMessageId

public string EmailMessageId { get; }

The EmailMessage 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 EmailMessageName.ResourceNameType Type { get; }

The EmailMessageName.ResourceNameType of the contained resource name.

Property Value
Type Description
EmailMessageNameResourceNameType

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

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

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.
emailMessageId string

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

The string representation of this EmailMessageName with pattern projects/{project}/cases/{case}/emailMessages/{email_message}.

FormatOrganizationCaseEmailMessage(string, string, string)

public static string FormatOrganizationCaseEmailMessage(string organizationId, string caseId, string emailMessageId)

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

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.
emailMessageId string

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

The string representation of this EmailMessageName with pattern organizations/{organization}/cases/{case}/emailMessages/{email_message}.

FormatProjectCaseEmailMessage(string, string, string)

public static string FormatProjectCaseEmailMessage(string projectId, string caseId, string emailMessageId)

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

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.
emailMessageId string

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

The string representation of this EmailMessageName with pattern projects/{project}/cases/{case}/emailMessages/{email_message}.

FromOrganizationCaseEmailMessage(string, string, string)

public static EmailMessageName FromOrganizationCaseEmailMessage(string organizationId, string caseId, string emailMessageId)

Creates a EmailMessageName with the pattern organizations/{organization}/cases/{case}/emailMessages/{email_message}.

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.
emailMessageId string

The EmailMessage ID. Must not be null or empty.
Returns
Type Description
EmailMessageName

A new instance of EmailMessageName constructed from the provided ids.

FromProjectCaseEmailMessage(string, string, string)

public static EmailMessageName FromProjectCaseEmailMessage(string projectId, string caseId, string emailMessageId)

Creates a EmailMessageName with the pattern projects/{project}/cases/{case}/emailMessages/{email_message}.

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.
emailMessageId string

The EmailMessage ID. Must not be null or empty.
Returns
Type Description
EmailMessageName

A new instance of EmailMessageName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EmailMessageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EmailMessageName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
emailMessageName string

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

The parsed EmailMessageName if successful.
Remarks

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

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

Parse(string, bool)

public static EmailMessageName Parse(string emailMessageName, bool allowUnparsed)

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

Parameters
Name Description
emailMessageName 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
EmailMessageName

The parsed EmailMessageName if successful.
Remarks

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

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

public static bool TryParse(string emailMessageName, out EmailMessageName result)

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

Parameters
Name Description
emailMessageName string

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

When this method returns, the parsed EmailMessageName, 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}/cases/{case}/emailMessages/{email_message}
  • organizations/{organization}/cases/{case}/emailMessages/{email_message}

TryParse(string, bool, out EmailMessageName)

public static bool TryParse(string emailMessageName, bool allowUnparsed, out EmailMessageName result)

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

Parameters
Name Description
emailMessageName 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 EmailMessageName

When this method returns, the parsed EmailMessageName, 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}/cases/{case}/emailMessages/{email_message}
  • organizations/{organization}/cases/{case}/emailMessages/{email_message}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EmailMessageName, EmailMessageName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EmailMessageName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EmailMessageName

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

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.