Class AppGatewayName (1.0.0-beta01)

public sealed class AppGatewayName : IResourceName, IEquatable<AppGatewayName>

Resource name for the AppGateway resource.

Inheritance

Object > AppGatewayName

Namespace

Google.Cloud.BeyondCorp.AppGateways.V1

Assembly

Google.Cloud.BeyondCorp.AppGateways.V1.dll

Constructors

AppGatewayName(String, String, String)

public AppGatewayName(string projectId, string locationId, string appGatewayId)

Constructs a new instance of a AppGatewayName class from the component parts of pattern projects/{project}/locations/{location}/appGateways/{app_gateway}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

appGatewayIdString

The AppGateway ID. Must not be null or empty.

Properties

AppGatewayId

public string AppGatewayId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public AppGatewayName.ResourceNameType Type { get; }

The AppGatewayName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AppGatewayName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String)

public static string Format(string projectId, string locationId, string appGatewayId)

Formats the IDs into the string representation of this AppGatewayName with pattern projects/{project}/locations/{location}/appGateways/{app_gateway}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

appGatewayIdString

The AppGateway ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AppGatewayName with pattern projects/{project}/locations/{location}/appGateways/{app_gateway}.

FormatProjectLocationAppGateway(String, String, String)

public static string FormatProjectLocationAppGateway(string projectId, string locationId, string appGatewayId)

Formats the IDs into the string representation of this AppGatewayName with pattern projects/{project}/locations/{location}/appGateways/{app_gateway}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

appGatewayIdString

The AppGateway ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AppGatewayName with pattern projects/{project}/locations/{location}/appGateways/{app_gateway}.

FromProjectLocationAppGateway(String, String, String)

public static AppGatewayName FromProjectLocationAppGateway(string projectId, string locationId, string appGatewayId)

Creates a AppGatewayName with the pattern projects/{project}/locations/{location}/appGateways/{app_gateway}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

appGatewayIdString

The AppGateway ID. Must not be null or empty.

Returns
TypeDescription
AppGatewayName

A new instance of AppGatewayName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AppGatewayName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AppGatewayName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AppGatewayName

A new instance of AppGatewayName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static AppGatewayName Parse(string appGatewayName)

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

Parameter
NameDescription
appGatewayNameString

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

Returns
TypeDescription
AppGatewayName

The parsed AppGatewayName if successful.

Remarks

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

  • projects/{project}/locations/{location}/appGateways/{app_gateway}

Parse(String, Boolean)

public static AppGatewayName Parse(string appGatewayName, bool allowUnparsed)

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

Parameters
NameDescription
appGatewayNameString

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

allowUnparsedBoolean

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
TypeDescription
AppGatewayName

The parsed AppGatewayName if successful.

Remarks

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

  • projects/{project}/locations/{location}/appGateways/{app_gateway}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out AppGatewayName)

public static bool TryParse(string appGatewayName, out AppGatewayName result)

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

Parameters
NameDescription
appGatewayNameString

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

resultAppGatewayName

When this method returns, the parsed AppGatewayName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/appGateways/{app_gateway}

TryParse(String, Boolean, out AppGatewayName)

public static bool TryParse(string appGatewayName, bool allowUnparsed, out AppGatewayName result)

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

Parameters
NameDescription
appGatewayNameString

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

allowUnparsedBoolean

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.

resultAppGatewayName

When this method returns, the parsed AppGatewayName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/appGateways/{app_gateway}
Or may be in any format if allowUnparsed is true.

Operators

Equality(AppGatewayName, AppGatewayName)

public static bool operator ==(AppGatewayName a, AppGatewayName b)
Parameters
NameDescription
aAppGatewayName
bAppGatewayName
Returns
TypeDescription
Boolean

Inequality(AppGatewayName, AppGatewayName)

public static bool operator !=(AppGatewayName a, AppGatewayName b)
Parameters
NameDescription
aAppGatewayName
bAppGatewayName
Returns
TypeDescription
Boolean