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.
Namespace
Google.Api.Gax.ResourceNamesAssembly
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 |
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-null
if 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 |
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 |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ProjectName with pattern |
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 |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ProjectName with pattern |
FromProject(string)
public static ProjectName FromProject(string projectId)
Creates a ProjectName with the pattern projects/{project}
.
Parameter | |
---|---|
Name | Description |
projectId |
string The |
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 |
Returns | |
---|---|
Type | Description |
ProjectName |
A new instance of ProjectName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
ProjectName |
The parsed ProjectName if successful. |
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 |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
ProjectName |
The parsed ProjectName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}
allowUnparsed
is true
.
ToString()
public override string ToString()
Returns | |
---|---|
Type | Description |
string |
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 |
result |
ProjectName When this method returns, the parsed ProjectName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 |
allowUnparsed |
bool If |
result |
ProjectName When this method returns, the parsed ProjectName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}
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 |