BeyondCorp AppConnections v1 API - Class AppConnectionName (1.2.0) 

public sealed class AppConnectionName : IResourceName, IEquatable<AppConnectionName>

Reference documentation and code samples for the BeyondCorp AppConnections v1 API class AppConnectionName.

Resource name for the AppConnection resource.

Inheritance

object > AppConnectionName

Namespace

Google.Cloud.BeyondCorp.AppConnections.V1

Assembly

Google.Cloud.BeyondCorp.AppConnections.V1.dll

Constructors

AppConnectionName(string, string, string)

public AppConnectionName(string projectId, string locationId, string appConnectionId)

Constructs a new instance of a AppConnectionName class from the component parts of pattern projects/{project}/locations/{location}/appConnections/{app_connection}

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.
appConnectionId string

The AppConnection ID. Must not be null or empty.

Properties

AppConnectionId

public string AppConnectionId { get; }

The AppConnection 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 AppConnectionName.ResourceNameType Type { get; }

The AppConnectionName.ResourceNameType of the contained resource name.

Property Value
Type Description
AppConnectionNameResourceNameType

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

Formats the IDs into the string representation of this AppConnectionName with pattern projects/{project}/locations/{location}/appConnections/{app_connection}.

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.
appConnectionId string

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

The string representation of this AppConnectionName with pattern projects/{project}/locations/{location}/appConnections/{app_connection}.

FormatProjectLocationAppConnection(string, string, string)

public static string FormatProjectLocationAppConnection(string projectId, string locationId, string appConnectionId)

Formats the IDs into the string representation of this AppConnectionName with pattern projects/{project}/locations/{location}/appConnections/{app_connection}.

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.
appConnectionId string

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

The string representation of this AppConnectionName with pattern projects/{project}/locations/{location}/appConnections/{app_connection}.

FromProjectLocationAppConnection(string, string, string)

public static AppConnectionName FromProjectLocationAppConnection(string projectId, string locationId, string appConnectionId)

Creates a AppConnectionName with the pattern projects/{project}/locations/{location}/appConnections/{app_connection}.

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.
appConnectionId string

The AppConnection ID. Must not be null or empty.
Returns
Type Description
AppConnectionName

A new instance of AppConnectionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AppConnectionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AppConnectionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
appConnectionName string

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

The parsed AppConnectionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/appConnections/{app_connection}

Parse(string, bool)

public static AppConnectionName Parse(string appConnectionName, bool allowUnparsed)

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

Parameters
Name Description
appConnectionName 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
AppConnectionName

The parsed AppConnectionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/appConnections/{app_connection}
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 AppConnectionName)

public static bool TryParse(string appConnectionName, out AppConnectionName result)

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

Parameters
Name Description
appConnectionName string

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

When this method returns, the parsed AppConnectionName, 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}/appConnections/{app_connection}

TryParse(string, bool, out AppConnectionName)

public static bool TryParse(string appConnectionName, bool allowUnparsed, out AppConnectionName result)

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

Parameters
Name Description
appConnectionName 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 AppConnectionName

When this method returns, the parsed AppConnectionName, 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}/appConnections/{app_connection}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AppConnectionName, AppConnectionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AppConnectionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AppConnectionName

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

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.