Vision AI v1 API - Class DraftName (1.0.0-beta01) 

public sealed class DraftName : IResourceName, IEquatable<DraftName>

Reference documentation and code samples for the Vision AI v1 API class DraftName.

Resource name for the Draft resource.

Inheritance

object > DraftName

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

DraftName(string, string, string, string)

public DraftName(string projectId, string locationId, string applicationId, string draftId)

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

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

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

DraftId

public string DraftId { get; }

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

The DraftName.ResourceNameType of the contained resource name.

Property Value
Type Description
DraftNameResourceNameType

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

public static string Format(string projectId, string locationId, string applicationId, string draftId)

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

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

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

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

FormatProjectLocationApplicationDraft(string, string, string, string)

public static string FormatProjectLocationApplicationDraft(string projectId, string locationId, string applicationId, string draftId)

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

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

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

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

FromProjectLocationApplicationDraft(string, string, string, string)

public static DraftName FromProjectLocationApplicationDraft(string projectId, string locationId, string applicationId, string draftId)

Creates a DraftName with the pattern projects/{project}/locations/{location}/applications/{application}/drafts/{draft}.

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

The Draft ID. Must not be null or empty.
Returns
Type Description
DraftName

A new instance of DraftName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DraftName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DraftName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
draftName string

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

The parsed DraftName if successful.
Remarks

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

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

Parse(string, bool)

public static DraftName Parse(string draftName, bool allowUnparsed)

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

Parameters
Name Description
draftName 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
DraftName

The parsed DraftName if successful.
Remarks

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

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

public static bool TryParse(string draftName, out DraftName result)

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

Parameters
Name Description
draftName string

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

When this method returns, the parsed DraftName, 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}/drafts/{draft}

TryParse(string, bool, out DraftName)

public static bool TryParse(string draftName, bool allowUnparsed, out DraftName result)

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

Parameters
Name Description
draftName 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 DraftName

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

Operators

operator ==(DraftName, DraftName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DraftName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DraftName

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

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.