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

IResourceName

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 a ProjectName class from the component parts of pattern projects/{project}

Declaration

public ProjectName(string projectId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.

Properties

IsKnownPattern

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

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
System.String

Type

The ProjectName.ResourceNameType of the contained resource name.

Declaration

public ProjectName.ResourceNameType Type { get; }

Property Value

Type	Description
ProjectName.ResourceNameType

UnparsedResource

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

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

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 this ProjectName with pattern projects/{project}.

Declaration

public static string Format(string projectId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this ProjectName with pattern projects/{project}.

FormatProject(String)

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

Declaration

public static string FormatProject(string projectId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this ProjectName with pattern projects/{project}.

FromProject(String)

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

Declaration

public static ProjectName FromProject(string projectId)

Parameters

Type	Name	Description
System.String	projectId	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)

Creates a ProjectName containing an unparsed resource name.

Declaration

public static ProjectName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	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()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static ProjectName Parse(string projectName)

Parameters

Type	Name	Description
System.String	projectName	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, Boolean)

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

Declaration

public static ProjectName Parse(string projectName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	projectName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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()

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

IResourceName.ToString()

TryParse(String, out ProjectName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectName	The resource name in string form. Must not be null.
ProjectName	result	When this method returns, the parsed ProjectName, or null if parsing failed.

Returns

Type	Description
System.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)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
ProjectName	result	When this method returns, the parsed ProjectName, or null if parsing failed.

Returns

Type	Description
System.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)

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