Network Connectivity v1beta API - Class SACAttachmentName (1.0.0-beta01) 

public sealed class SACAttachmentName : IResourceName, IEquatable<SACAttachmentName>

Reference documentation and code samples for the Network Connectivity v1beta API class SACAttachmentName.

Resource name for the SACAttachment resource.

Inheritance

object > SACAttachmentName

Namespace

Google.Cloud.NetworkConnectivity.V1Beta

Assembly

Google.Cloud.NetworkConnectivity.V1Beta.dll

Constructors

SACAttachmentName(string, string, string)

public SACAttachmentName(string projectId, string locationId, string sacAttachmentId)

Constructs a new instance of a SACAttachmentName class from the component parts of pattern projects/{project}/locations/{location}/sacAttachments/{sac_attachment}

Parameters
Name Description
projectId string

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

The Location ID. Must not be null or empty.
sacAttachmentId string

The SacAttachment ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

SacAttachmentId

public string SacAttachmentId { get; }

The SacAttachment ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public SACAttachmentName.ResourceNameType Type { get; }

The SACAttachmentName.ResourceNameType of the contained resource name.

Property Value
Type Description
SACAttachmentNameResourceNameType

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 locationId, string sacAttachmentId)

Formats the IDs into the string representation of this SACAttachmentName with pattern projects/{project}/locations/{location}/sacAttachments/{sac_attachment}.

Parameters
Name Description
projectId string

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

The Location ID. Must not be null or empty.
sacAttachmentId string

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

The string representation of this SACAttachmentName with pattern projects/{project}/locations/{location}/sacAttachments/{sac_attachment}.

FormatProjectLocationSacAttachment(string, string, string)

public static string FormatProjectLocationSacAttachment(string projectId, string locationId, string sacAttachmentId)

Formats the IDs into the string representation of this SACAttachmentName with pattern projects/{project}/locations/{location}/sacAttachments/{sac_attachment}.

Parameters
Name Description
projectId string

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

The Location ID. Must not be null or empty.
sacAttachmentId string

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

The string representation of this SACAttachmentName with pattern projects/{project}/locations/{location}/sacAttachments/{sac_attachment}.

FromProjectLocationSacAttachment(string, string, string)

public static SACAttachmentName FromProjectLocationSacAttachment(string projectId, string locationId, string sacAttachmentId)

Creates a SACAttachmentName with the pattern projects/{project}/locations/{location}/sacAttachments/{sac_attachment}.

Parameters
Name Description
projectId string

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

The Location ID. Must not be null or empty.
sacAttachmentId string

The SacAttachment ID. Must not be null or empty.
Returns
Type Description
SACAttachmentName

A new instance of SACAttachmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SACAttachmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SACAttachmentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
sACAttachmentName string

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

The parsed SACAttachmentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sacAttachments/{sac_attachment}

Parse(string, bool)

public static SACAttachmentName Parse(string sACAttachmentName, bool allowUnparsed)

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

Parameters
Name Description
sACAttachmentName 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
SACAttachmentName

The parsed SACAttachmentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sacAttachments/{sac_attachment}

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 SACAttachmentName)

public static bool TryParse(string sACAttachmentName, out SACAttachmentName result)

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

Parameters
Name Description
sACAttachmentName string

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

When this method returns, the parsed SACAttachmentName, 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}/locations/{location}/sacAttachments/{sac_attachment}

TryParse(string, bool, out SACAttachmentName)

public static bool TryParse(string sACAttachmentName, bool allowUnparsed, out SACAttachmentName result)

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

Parameters
Name Description
sACAttachmentName 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 SACAttachmentName

When this method returns, the parsed SACAttachmentName, 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}/locations/{location}/sacAttachments/{sac_attachment}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SACAttachmentName, SACAttachmentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SACAttachmentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SACAttachmentName

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

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.