Parallelstore v1 API - Class AddressName (1.0.0-beta01)

public sealed class AddressName : IResourceName, IEquatable<AddressName>

Reference documentation and code samples for the Parallelstore v1 API class AddressName.

Resource name for the Address resource.

Inheritance

object > AddressName

Implements

IResourceName, IEquatable AddressName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Parallelstore.V1

Assembly

Google.Cloud.Parallelstore.V1.dll

Constructors

AddressName(string, string, string)

public AddressName(string projectId, string regionId, string addressId)

Constructs a new instance of a AddressName class from the component parts of pattern projects/{project}/regions/{region}/addresses/{address}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`addressId`	`string` The `Address` ID. Must not be `null` or empty.

Properties

AddressId

public string AddressId { get; }

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

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`

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`

RegionId

public string RegionId { get; }

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

Property Value
Type	Description
`string`

Type

public AddressName.ResourceNameType Type { get; }

The AddressName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AddressNameResourceNameType`

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 regionId, string addressId)

Formats the IDs into the string representation of this AddressName with pattern projects/{project}/regions/{region}/addresses/{address}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`addressId`	`string` The `Address` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AddressName with pattern `projects/{project}/regions/{region}/addresses/{address}`.

FormatProjectRegionAddress(string, string, string)

public static string FormatProjectRegionAddress(string projectId, string regionId, string addressId)

Formats the IDs into the string representation of this AddressName with pattern projects/{project}/regions/{region}/addresses/{address}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`addressId`	`string` The `Address` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AddressName with pattern `projects/{project}/regions/{region}/addresses/{address}`.

FromProjectRegionAddress(string, string, string)

public static AddressName FromProjectRegionAddress(string projectId, string regionId, string addressId)

Creates a AddressName with the pattern projects/{project}/regions/{region}/addresses/{address}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`addressId`	`string` The `Address` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static AddressName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AddressName containing an unparsed resource name.

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

Returns
Type	Description
`AddressName`	A new instance of AddressName 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 AddressName Parse(string addressName)

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

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

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

Remarks

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

projects/{project}/regions/{region}/addresses/{address}

Parse(string, bool)

public static AddressName Parse(string addressName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/regions/{region}/addresses/{address}

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

public static bool TryParse(string addressName, out AddressName result)

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

Parameters
Name	Description
`addressName`	`string` The resource name in string form. Must not be `null`.
`result`	`AddressName` When this method returns, the parsed AddressName, 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}/regions/{region}/addresses/{address}

TryParse(string, bool, out AddressName)

public static bool TryParse(string addressName, bool allowUnparsed, out AddressName result)

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

Parameters
Name	Description
`addressName`	`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`	`AddressName` When this method returns, the parsed AddressName, 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}/regions/{region}/addresses/{address}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AddressName, AddressName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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