Class ProjectName (3.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ProjectName : IResourceName, IEquatable<ProjectName>

Resource name for the Project resource.

Inheritance

Object > ProjectName

Namespace

Grafeas.V1

Assembly

Grafeas.V1.dll

Constructors

ProjectName(String)

public ProjectName(string projectId)

Constructs a new instance of a ProjectName class from the component parts of pattern projects/{project}

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public ProjectName.ResourceNameType Type { get; }

The ProjectName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ProjectName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String)

public static string Format(string projectId)

Formats the IDs into the string representation of this ProjectName with pattern projects/{project}.

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ProjectName with pattern projects/{project}.

FormatProject(String)

public static string FormatProject(string projectId)

Formats the IDs into the string representation of this ProjectName with pattern projects/{project}.

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ProjectName with pattern projects/{project}.

FromProject(String)

public static ProjectName FromProject(string projectId)

Creates a ProjectName with the pattern projects/{project}.

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
ProjectName

A new instance of ProjectName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProjectName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProjectName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ProjectName

A new instance of ProjectName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ProjectName Parse(string projectName)

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

Parameter
NameDescription
projectNameString

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

Returns
TypeDescription
ProjectName

The parsed ProjectName if successful.

Remarks

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

  • projects/{project}

Parse(String, Boolean)

public static ProjectName Parse(string projectName, bool allowUnparsed)

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

Parameters
NameDescription
projectNameString

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

allowUnparsedBoolean

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

The parsed ProjectName if successful.

Remarks

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

  • projects/{project}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out ProjectName)

public static bool TryParse(string projectName, out ProjectName result)

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

Parameters
NameDescription
projectNameString

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

resultProjectName

When this method returns, the parsed ProjectName, or null if parsing failed.

Returns
TypeDescription
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}

TryParse(String, Boolean, out ProjectName)

public static bool TryParse(string projectName, bool allowUnparsed, out ProjectName result)

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

Parameters
NameDescription
projectNameString

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

allowUnparsedBoolean

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.

resultProjectName

When this method returns, the parsed ProjectName, or null if parsing failed.

Returns
TypeDescription
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}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ProjectName, ProjectName)

public static bool operator ==(ProjectName a, ProjectName b)
Parameters
NameDescription
aProjectName
bProjectName
Returns
TypeDescription
Boolean

Inequality(ProjectName, ProjectName)

public static bool operator !=(ProjectName a, ProjectName b)
Parameters
NameDescription
aProjectName
bProjectName
Returns
TypeDescription
Boolean