API Gateway v1 API - Class GatewayName (2.3.0)

public sealed class GatewayName : IResourceName, IEquatable<GatewayName>

Reference documentation and code samples for the API Gateway v1 API class GatewayName.

Resource name for the Gateway resource.

Inheritance

object > GatewayName

Implements

IResourceName, IEquatable GatewayName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Constructors

GatewayName(string, string, string)

public GatewayName(string projectId, string locationId, string gatewayId)

Constructs a new instance of a GatewayName class from the component parts of pattern projects/{project}/locations/{location}/gateways/{gateway}

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

Properties

GatewayId

public string GatewayId { get; }

The Gateway 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`

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`

Type

public GatewayName.ResourceNameType Type { get; }

The GatewayName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`GatewayNameResourceNameType`

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

Formats the IDs into the string representation of this GatewayName with pattern projects/{project}/locations/{location}/gateways/{gateway}.

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

Returns
Type	Description
`string`	The string representation of this GatewayName with pattern `projects/{project}/locations/{location}/gateways/{gateway}`.

FormatProjectLocationGateway(string, string, string)

public static string FormatProjectLocationGateway(string projectId, string locationId, string gatewayId)

Formats the IDs into the string representation of this GatewayName with pattern projects/{project}/locations/{location}/gateways/{gateway}.

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

Returns
Type	Description
`string`	The string representation of this GatewayName with pattern `projects/{project}/locations/{location}/gateways/{gateway}`.

FromProjectLocationGateway(string, string, string)

public static GatewayName FromProjectLocationGateway(string projectId, string locationId, string gatewayId)

Creates a GatewayName with the pattern projects/{project}/locations/{location}/gateways/{gateway}.

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

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

FromUnparsed(UnparsedResourceName)

public static GatewayName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GatewayName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/gateways/{gateway}

Parse(string, bool)

public static GatewayName Parse(string gatewayName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/gateways/{gateway}

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

public static bool TryParse(string gatewayName, out GatewayName result)

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

Parameters
Name	Description
`gatewayName`	`string` The resource name in string form. Must not be `null`.
`result`	`GatewayName` When this method returns, the parsed GatewayName, 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}/gateways/{gateway}

TryParse(string, bool, out GatewayName)

public static bool TryParse(string gatewayName, bool allowUnparsed, out GatewayName result)

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

Parameters
Name	Description
`gatewayName`	`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`	`GatewayName` When this method returns, the parsed GatewayName, 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}/gateways/{gateway}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(GatewayName, GatewayName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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