Google Cloud Support v2 API - Class AttachmentName (1.3.0)

public sealed class AttachmentName : IResourceName, IEquatable<AttachmentName>

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

Resource name for the Attachment resource.

Inheritance

object > AttachmentName

Implements

IResourceName, IEquatable AttachmentName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Support.V2

Assembly

Google.Cloud.Support.V2.dll

Constructors

AttachmentName(string, string, string)

public AttachmentName(string organizationId, string caseId, string attachmentId)

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

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.
`attachmentId`	`string` The `Attachment` ID. Must not be `null` or empty.

Properties

AttachmentId

public string AttachmentId { get; }

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

Property Value
Type	Description
`string`

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 AttachmentName.ResourceNameType Type { get; }

The AttachmentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AttachmentNameResourceNameType`

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

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

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.
`attachmentId`	`string` The `Attachment` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AttachmentName with pattern `organizations/{organization}/cases/{case}/attachments/{attachment_id}`.

FormatOrganizationCaseAttachment(string, string, string)

public static string FormatOrganizationCaseAttachment(string organizationId, string caseId, string attachmentId)

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

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.
`attachmentId`	`string` The `Attachment` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AttachmentName with pattern `organizations/{organization}/cases/{case}/attachments/{attachment_id}`.

FormatProjectCaseAttachment(string, string, string)

public static string FormatProjectCaseAttachment(string projectId, string caseId, string attachmentId)

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

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.
`attachmentId`	`string` The `Attachment` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AttachmentName with pattern `projects/{project}/cases/{case}/attachments/{attachment_id}`.

FromOrganizationCaseAttachment(string, string, string)

public static AttachmentName FromOrganizationCaseAttachment(string organizationId, string caseId, string attachmentId)

Creates a AttachmentName with the pattern organizations/{organization}/cases/{case}/attachments/{attachment_id}.

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.
`attachmentId`	`string` The `Attachment` ID. Must not be `null` or empty.

Returns
Type	Description
`AttachmentName`	A new instance of AttachmentName constructed from the provided ids.

FromProjectCaseAttachment(string, string, string)

public static AttachmentName FromProjectCaseAttachment(string projectId, string caseId, string attachmentId)

Creates a AttachmentName with the pattern projects/{project}/cases/{case}/attachments/{attachment_id}.

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.
`attachmentId`	`string` The `Attachment` ID. Must not be `null` or empty.

Returns
Type	Description
`AttachmentName`	A new instance of AttachmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AttachmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AttachmentName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`AttachmentName`	A new instance of AttachmentName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static AttachmentName Parse(string attachmentName)

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

Parameter
Name	Description
`attachmentName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`AttachmentName`	The parsed AttachmentName if successful.

Remarks

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

organizations/{organization}/cases/{case}/attachments/{attachment_id}
projects/{project}/cases/{case}/attachments/{attachment_id}

Parse(string, bool)

public static AttachmentName Parse(string attachmentName, bool allowUnparsed)

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

Parameters
Name	Description
`attachmentName`	`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
`AttachmentName`	The parsed AttachmentName if successful.

Remarks

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

organizations/{organization}/cases/{case}/attachments/{attachment_id}
projects/{project}/cases/{case}/attachments/{attachment_id}

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

object.ToString()

TryParse(string, out AttachmentName)

public static bool TryParse(string attachmentName, out AttachmentName result)

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

Parameters
Name	Description
`attachmentName`	`string` The resource name in string form. Must not be `null`.
`result`	`AttachmentName` When this method returns, the parsed AttachmentName, 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}/attachments/{attachment_id}
projects/{project}/cases/{case}/attachments/{attachment_id}

TryParse(string, bool, out AttachmentName)

public static bool TryParse(string attachmentName, bool allowUnparsed, out AttachmentName result)

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

Parameters
Name	Description
`attachmentName`	`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`	`AttachmentName` When this method returns, the parsed AttachmentName, 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}/attachments/{attachment_id}
projects/{project}/cases/{case}/attachments/{attachment_id}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AttachmentName, AttachmentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`AttachmentName` The first resource name to compare, or null.
`b`	`AttachmentName` 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 !=(AttachmentName, AttachmentName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`AttachmentName` The first resource name to compare, or null.
`b`	`AttachmentName` 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.