Class 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
System.Object
ProjectName
Implements
System.IEquatable<ProjectName>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Api.Gax.ResourceNames
Assembly: Google.Api.Gax.dll
Syntax
public sealed class ProjectName : IResourceName, IEquatable<ProjectName>

Constructors

ProjectName(String)

Constructs a new instance of the ProjectName resource name class from its component parts.

Declaration
public ProjectName(string projectId)
Parameters
Type Name Description
System.String projectId

The project ID. Must not be null.

Properties

Kind

The kind of resource name.

Declaration
public ResourceNameKind Kind { get; }
Property Value
Type Description
ResourceNameKind
Implements

ProjectId

The project ID. Never null.

Declaration
public string ProjectId { get; }
Property Value
Type Description
System.String

Methods

Equals(ProjectName)

Declaration
public bool Equals(ProjectName other)
Parameters
Type Name Description
ProjectName other
Returns
Type Description
System.Boolean
Implements
System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

Format(String)

Formats the IDs into the string representation of the ProjectName.

Declaration
public static string Format(string projectId)
Parameters
Type Name Description
System.String projectId

The project ID. Must not be null.
Returns
Type Description
System.String

The string representation of the ProjectName.

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

Parse(String)

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

Declaration
public static ProjectName Parse(string projectName)
Parameters
Type Name Description
System.String projectName

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

The parsed ProjectName if successful.

ToString()

The string representation of the resource name.

Declaration
public override string ToString()
Returns
Type Description
System.String

The string representation of the resource name.
Overrides
System.Object.ToString()
Implements

TryParse(String, out ProjectName)

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

Declaration
public static bool TryParse(string projectName, out ProjectName result)
Parameters
Type Name Description
System.String projectName

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

When this method returns, the parsed ProjectName, or null if parsing fails.
Returns
Type Description
System.Boolean

true if the name was parsed successfully; false otherwise.
Remarks

This method still throws System.ArgumentNullException if projectName is null, as this would usually indicate a programming error rather than a data error.

Operators

Equality(ProjectName, ProjectName)

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

Inequality(ProjectName, ProjectName)

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