Gemini Enterprise for Customer Experience v1 API - Class AppVersionName (1.0.0-beta01) 

public sealed class AppVersionName : IResourceName, IEquatable<AppVersionName>

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1 API class AppVersionName.

Resource name for the AppVersion resource.

Inheritance

object > AppVersionName

Namespace

Google.Cloud.Ces.V1

Assembly

Google.Cloud.Ces.V1.dll

Constructors

AppVersionName(string, string, string, string)

public AppVersionName(string projectId, string locationId, string appId, string versionId)

Constructs a new instance of a AppVersionName class from the component parts of pattern projects/{project}/locations/{location}/apps/{app}/versions/{version}

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

The App ID. Must not be null or empty.
versionId string

The Version ID. Must not be null or empty.

Properties

AppId

public string AppId { get; }

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

The AppVersionName.ResourceNameType of the contained resource name.

Property Value
Type Description
AppVersionNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

VersionId

public string VersionId { get; }

The Version ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string appId, string versionId)

Formats the IDs into the string representation of this AppVersionName with pattern projects/{project}/locations/{location}/apps/{app}/versions/{version}.

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

The App ID. Must not be null or empty.
versionId string

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

The string representation of this AppVersionName with pattern projects/{project}/locations/{location}/apps/{app}/versions/{version}.

FormatProjectLocationAppVersion(string, string, string, string)

public static string FormatProjectLocationAppVersion(string projectId, string locationId, string appId, string versionId)

Formats the IDs into the string representation of this AppVersionName with pattern projects/{project}/locations/{location}/apps/{app}/versions/{version}.

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

The App ID. Must not be null or empty.
versionId string

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

The string representation of this AppVersionName with pattern projects/{project}/locations/{location}/apps/{app}/versions/{version}.

FromProjectLocationAppVersion(string, string, string, string)

public static AppVersionName FromProjectLocationAppVersion(string projectId, string locationId, string appId, string versionId)

Creates a AppVersionName with the pattern projects/{project}/locations/{location}/apps/{app}/versions/{version}.

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

The App ID. Must not be null or empty.
versionId string

The Version ID. Must not be null or empty.
Returns
Type Description
AppVersionName

A new instance of AppVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AppVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AppVersionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
appVersionName string

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

The parsed AppVersionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/versions/{version}

Parse(string, bool)

public static AppVersionName Parse(string appVersionName, bool allowUnparsed)

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

Parameters
Name Description
appVersionName 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
AppVersionName

The parsed AppVersionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/versions/{version}
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 AppVersionName)

public static bool TryParse(string appVersionName, out AppVersionName result)

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

Parameters
Name Description
appVersionName string

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

When this method returns, the parsed AppVersionName, 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}/apps/{app}/versions/{version}

TryParse(string, bool, out AppVersionName)

public static bool TryParse(string appVersionName, bool allowUnparsed, out AppVersionName result)

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

Parameters
Name Description
appVersionName 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 AppVersionName

When this method returns, the parsed AppVersionName, 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}/apps/{app}/versions/{version}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AppVersionName, AppVersionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AppVersionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AppVersionName

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

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.