App Hub v1 API - Class ApplicationName (1.0.0-beta02)

public sealed class ApplicationName : IResourceName, IEquatable<ApplicationName>

Reference documentation and code samples for the App Hub v1 API class ApplicationName.

Resource name for the Application resource.

Inheritance

object > ApplicationName

Namespace

Google.Cloud.AppHub.V1

Assembly

Google.Cloud.AppHub.V1.dll

Constructors

ApplicationName(string, string, string)

public ApplicationName(string projectId, string locationId, string applicationId)

Constructs a new instance of a ApplicationName class from the component parts of pattern projects/{project}/locations/{location}/applications/{application}

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.

applicationId string

The Application ID. Must not be null or empty.

Properties

ApplicationId

public string ApplicationId { get; }

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

The ApplicationName.ResourceNameType of the contained resource name.

Property Value
Type Description
ApplicationNameResourceNameType

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

Formats the IDs into the string representation of this ApplicationName with pattern projects/{project}/locations/{location}/applications/{application}.

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.

applicationId string

The Application ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ApplicationName with pattern projects/{project}/locations/{location}/applications/{application}.

FormatProjectLocationApplication(string, string, string)

public static string FormatProjectLocationApplication(string projectId, string locationId, string applicationId)

Formats the IDs into the string representation of this ApplicationName with pattern projects/{project}/locations/{location}/applications/{application}.

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.

applicationId string

The Application ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ApplicationName with pattern projects/{project}/locations/{location}/applications/{application}.

FromProjectLocationApplication(string, string, string)

public static ApplicationName FromProjectLocationApplication(string projectId, string locationId, string applicationId)

Creates a ApplicationName with the pattern projects/{project}/locations/{location}/applications/{application}.

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.

applicationId string

The Application ID. Must not be null or empty.

Returns
Type Description
ApplicationName

A new instance of ApplicationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ApplicationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ApplicationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ApplicationName

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

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

Parameter
Name Description
applicationName string

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

Returns
Type Description
ApplicationName

The parsed ApplicationName if successful.

Remarks

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

  • projects/{project}/locations/{location}/applications/{application}

Parse(string, bool)

public static ApplicationName Parse(string applicationName, bool allowUnparsed)

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

Parameters
Name Description
applicationName 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
ApplicationName

The parsed ApplicationName if successful.

Remarks

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

  • projects/{project}/locations/{location}/applications/{application}
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 ApplicationName)

public static bool TryParse(string applicationName, out ApplicationName result)

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

Parameters
Name Description
applicationName string

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

result ApplicationName

When this method returns, the parsed ApplicationName, 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}/applications/{application}

TryParse(string, bool, out ApplicationName)

public static bool TryParse(string applicationName, bool allowUnparsed, out ApplicationName result)

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

Parameters
Name Description
applicationName 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 ApplicationName

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

Operators

operator ==(ApplicationName, ApplicationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ApplicationName

The first resource name to compare, or null.

b ApplicationName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ApplicationName

The first resource name to compare, or null.

b ApplicationName

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.