BeyondCorp v1 API - Class AppConnectorName (1.0.0)

public sealed class AppConnectorName : IResourceName, IEquatable<AppConnectorName>

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

Resource name for the AppConnector resource.

Inheritance

Object > AppConnectorName

Implements

IResourceName, IEquatable<AppConnectorName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.BeyondCorp.AppConnections.V1

Assembly

Google.Cloud.BeyondCorp.AppConnections.V1.dll

Constructors

AppConnectorName(String, String, String)

public AppConnectorName(string projectId, string locationId, string appConnectorId)

Constructs a new instance of a AppConnectorName class from the component parts of pattern projects/{project}/locations/{location}/appConnectors/{app_connector}

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.
appConnectorId	`String` The `AppConnector` ID. Must not be `null` or empty.

Properties

AppConnectorId

public string AppConnectorId { get; }

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

The AppConnectorName.ResourceNameType of the contained resource name.

Property Value

Type	Description
AppConnectorName.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 appConnectorId)

Formats the IDs into the string representation of this AppConnectorName with pattern projects/{project}/locations/{location}/appConnectors/{app_connector}.

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.
appConnectorId	`String` The `AppConnector` ID. Must not be `null` or empty.

Returns

Type	Description
String	The string representation of this AppConnectorName with pattern `projects/{project}/locations/{location}/appConnectors/{app_connector}`.

FormatProjectLocationAppConnector(String, String, String)

public static string FormatProjectLocationAppConnector(string projectId, string locationId, string appConnectorId)

Formats the IDs into the string representation of this AppConnectorName with pattern projects/{project}/locations/{location}/appConnectors/{app_connector}.

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.
appConnectorId	`String` The `AppConnector` ID. Must not be `null` or empty.

Returns

Type	Description
String	The string representation of this AppConnectorName with pattern `projects/{project}/locations/{location}/appConnectors/{app_connector}`.

FromProjectLocationAppConnector(String, String, String)

public static AppConnectorName FromProjectLocationAppConnector(string projectId, string locationId, string appConnectorId)

Creates a AppConnectorName with the pattern projects/{project}/locations/{location}/appConnectors/{app_connector}.

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.
appConnectorId	`String` The `AppConnector` ID. Must not be `null` or empty.

Returns

Type	Description
AppConnectorName	A new instance of AppConnectorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AppConnectorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AppConnectorName containing an unparsed resource name.

Parameter

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

Returns

Type	Description
AppConnectorName	A new instance of AppConnectorName 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 AppConnectorName Parse(string appConnectorName)

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

Parameter

Name	Description
appConnectorName	`String` The resource name in string form. Must not be `null`.

Returns

Type	Description
AppConnectorName	The parsed AppConnectorName if successful.

Remarks

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

projects/{project}/locations/{location}/appConnectors/{app_connector}

Parse(String, Boolean)

public static AppConnectorName Parse(string appConnectorName, bool allowUnparsed)

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

Parameters

Name	Description
appConnectorName	`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
AppConnectorName	The parsed AppConnectorName if successful.

Remarks

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

projects/{project}/locations/{location}/appConnectors/{app_connector}

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

public static bool TryParse(string appConnectorName, out AppConnectorName result)

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

Parameters

Name	Description
appConnectorName	`String` The resource name in string form. Must not be `null`.
result	`AppConnectorName` When this method returns, the parsed AppConnectorName, 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}/appConnectors/{app_connector}

TryParse(String, Boolean, out AppConnectorName)

public static bool TryParse(string appConnectorName, bool allowUnparsed, out AppConnectorName result)

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

Parameters

Name	Description
appConnectorName	`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	`AppConnectorName` When this method returns, the parsed AppConnectorName, 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}/appConnectors/{app_connector}

Or may be in any format if allowUnparsed is true.

Operators

Equality(AppConnectorName, AppConnectorName)

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

Parameters

Name	Description
a	`AppConnectorName`
b	`AppConnectorName`

Returns

Type	Description
Boolean

Inequality(AppConnectorName, AppConnectorName)

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

Parameters

Name	Description
a	`AppConnectorName`
b	`AppConnectorName`

Returns

Type	Description
Boolean