BeyondCorp AppConnections v1 API - Class AppConnectorName (1.3.0) 

public sealed class AppConnectorName : IResourceName, IEquatable<AppConnectorName>

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

Resource name for the AppConnector resource.

Inheritance

object > AppConnectorName

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

The AppConnectorName.ResourceNameType of the contained resource name.

Property Value
Type Description
AppConnectorNameResourceNameType

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
int
Overrides

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

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

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
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}/appConnectors/{app_connector}

TryParse(string, bool, 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 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 AppConnectorName

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

Operators

operator ==(AppConnectorName, AppConnectorName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AppConnectorName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AppConnectorName

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

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.