BeyondCorp v1 API - Class AppConnectionName (1.0.0)

public sealed class AppConnectionName : IResourceName, IEquatable<AppConnectionName>

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

Resource name for the AppConnection resource.

Inheritance

Object > AppConnectionName

Implements

IResourceName, IEquatable<AppConnectionName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`AppConnectionName.ResourceNameType`

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
`Int32`

Overrides

Object.GetHashCode()

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, Boolean)

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`	`Boolean` 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

Object.ToString()

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
`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}/appConnections/{app_connection}

TryParse(String, Boolean, 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`	`Boolean` 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
`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}/appConnections/{app_connection}

Or may be in any format if allowUnparsed is true.

Operators

Equality(AppConnectionName, AppConnectionName)

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

Parameters
Name	Description
`a`	`AppConnectionName`
`b`	`AppConnectionName`

Returns
Type	Description
`Boolean`

Inequality(AppConnectionName, AppConnectionName)

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

Parameters
Name	Description
`a`	`AppConnectionName`
`b`	`AppConnectionName`

Returns
Type	Description
`Boolean`