public sealed class TemplatedResourceName : IResourceName, IEquatable<TemplatedResourceName>Class for representing and working with resource names.
Namespace
Google.Api.GaxAssembly
Google.Api.Gax.dll
Remarks
A resource name is represented by a PathTemplate, an assignment of resource IDs to parameters in the template, and an optional service name. This class allows the service name and resource IDs to be modified, but only within the same template.
Constructors
TemplatedResourceName(PathTemplate, String[])
public TemplatedResourceName(PathTemplate template, params string[] resourceIds)Creates a resource name with the given template and resource IDs.
The resource IDs are cloned, so later changes to resourceIds
are ignored. This constructor does not populate the ServiceName property,
but that can be set after construction.
| Parameters | |
|---|---|
| Name | Description |
template | PathTemplateThe template for the new resource name. Must not be null. |
resourceIds | String[]The resource IDs to populate template parameters with. Must not be null. |
Properties
IsKnownPattern
public bool IsKnownPattern { get; }Whether this instance contains a resource name with a known pattern.
| Property Value | |
|---|---|
| Type | Description |
Boolean | |
Item[Int32]
public string this[int index] { get; set; }Gets or sets the identifier for the specified parameter index.
| Parameter | |
|---|---|
| Name | Description |
index | Int32The index of the parameter value to retrieve. |
| Property Value | |
|---|---|
| Type | Description |
String | The identifier within the resource name at the given parameter index. |
Item[String]
public string this[string parameterName] { get; set; }Gets or sets the identifier for the specified parameter name.
| Parameter | |
|---|---|
| Name | Description |
parameterName | StringThe name of the parameter value to retrieve. |
| Property Value | |
|---|---|
| Type | Description |
String | The identifier within the resource name with the given parameter name. |
ServiceName
public string ServiceName { get; set; }The service name part of this resource name, or null if no service name is specified.
| Property Value | |
|---|---|
| Type | Description |
String | |
Template
public PathTemplate Template { get; }The template this resource name is associated with. Never null.
| Property Value | |
|---|---|
| Type | Description |
PathTemplate | |
Methods
Clone()
public TemplatedResourceName Clone()Creates a clone of this resource name, which is then independent of the original.
| Returns | |
|---|---|
| Type | Description |
TemplatedResourceName | A clone of this resource name. |
Equals(TemplatedResourceName)
public bool Equals(TemplatedResourceName other)| Parameter | |
|---|---|
| Name | Description |
other | TemplatedResourceName |
| Returns | |
|---|---|
| Type | Description |
Boolean | |
Equals(Object)
public override bool Equals(object obj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
Boolean | |
GetHashCode()
public override int GetHashCode()| Returns | |
|---|---|
| Type | Description |
Int32 | |
ToString()
public override string ToString()Returns a string representation of this resource name, expanding the template parameters with the resource IDs and prepending the service name (if present).
| Returns | |
|---|---|
| Type | Description |
String | A string representation of this resource name. |
Operators
Equality(TemplatedResourceName, TemplatedResourceName)
public static bool operator ==(TemplatedResourceName a, TemplatedResourceName b)| Parameters | |
|---|---|
| Name | Description |
a | TemplatedResourceName |
b | TemplatedResourceName |
| Returns | |
|---|---|
| Type | Description |
Boolean | |
Inequality(TemplatedResourceName, TemplatedResourceName)
public static bool operator !=(TemplatedResourceName a, TemplatedResourceName b)| Parameters | |
|---|---|
| Name | Description |
a | TemplatedResourceName |
b | TemplatedResourceName |
| Returns | |
|---|---|
| Type | Description |
Boolean | |