Class ProjectName (4.4.0) 

public sealed class ProjectName : IResourceName, IEquatable<ProjectName>

Resource name for the 'project' resource which is widespread across Google Cloud Platform. While most resource names are generated on a per-API basis, many APIs use a project resource, and it's useful to be able to pass values from one API to another.

Inheritance

object > ProjectName

Namespace

Google.Api.Gax.ResourceNames

Assembly

Google.Api.Gax.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
Name Description
projectId string

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
Type Description
bool

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

The ProjectName.ResourceNameType of the contained resource name.

Property Value
Type Description
ProjectNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

Methods

Equals(ProjectName)

public bool Equals(ProjectName other)
Parameter
Name Description
other ProjectName
Returns
Type Description
bool

Equals(object)

public override bool Equals(object obj)
Parameter
Name Description
obj object
Returns
Type Description
bool
Overrides

Format(string)

public static string Format(string projectId)

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

Parameter
Name Description
projectId string

The Project ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId string

The Project ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId string

The Project ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of ProjectName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

Parse(string)

public static ProjectName Parse(string projectName)

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

Parameter
Name Description
projectName string

The resource name in string form. Must not be null.
Returns
Type Description
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, bool)

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
Name Description
projectName 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
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()
Returns
Type Description
string
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
Name Description
projectName string

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

When this method returns, the parsed ProjectName, 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}

TryParse(string, bool, 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
Name Description
projectName 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 ProjectName

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

Operators

operator ==(ProjectName, ProjectName)

public static bool operator ==(ProjectName a, ProjectName b)
Parameters
Name Description
a ProjectName
b ProjectName
Returns
Type Description
bool

operator !=(ProjectName, ProjectName)

public static bool operator !=(ProjectName a, ProjectName b)
Parameters
Name Description
a ProjectName
b ProjectName
Returns
Type Description
bool