Infrastructure Manager v1 API - Class PreviewName (1.4.0)

public sealed class PreviewName : IResourceName, IEquatable<PreviewName>

Reference documentation and code samples for the Infrastructure Manager v1 API class PreviewName.

Resource name for the Preview resource.

Inheritance

object > PreviewName

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Constructors

PreviewName(string, string, string)

public PreviewName(string projectId, string locationId, string previewId)

Constructs a new instance of a PreviewName class from the component parts of pattern projects/{project}/locations/{location}/previews/{preview}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

previewIdstring

The Preview 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
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

PreviewId

public string PreviewId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public PreviewName.ResourceNameType Type { get; }

The PreviewName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
PreviewNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string previewId)

Formats the IDs into the string representation of this PreviewName with pattern projects/{project}/locations/{location}/previews/{preview}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

previewIdstring

The Preview ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this PreviewName with pattern projects/{project}/locations/{location}/previews/{preview}.

FormatProjectLocationPreview(string, string, string)

public static string FormatProjectLocationPreview(string projectId, string locationId, string previewId)

Formats the IDs into the string representation of this PreviewName with pattern projects/{project}/locations/{location}/previews/{preview}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

previewIdstring

The Preview ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this PreviewName with pattern projects/{project}/locations/{location}/previews/{preview}.

FromProjectLocationPreview(string, string, string)

public static PreviewName FromProjectLocationPreview(string projectId, string locationId, string previewId)

Creates a PreviewName with the pattern projects/{project}/locations/{location}/previews/{preview}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

previewIdstring

The Preview ID. Must not be null or empty.

Returns
TypeDescription
PreviewName

A new instance of PreviewName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PreviewName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PreviewName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
PreviewName

A new instance of PreviewName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static PreviewName Parse(string previewName)

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

Parameter
NameDescription
previewNamestring

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

Returns
TypeDescription
PreviewName

The parsed PreviewName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/previews/{preview}

Parse(string, bool)

public static PreviewName Parse(string previewName, bool allowUnparsed)

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

Parameters
NameDescription
previewNamestring

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

allowUnparsedbool

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
TypeDescription
PreviewName

The parsed PreviewName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/previews/{preview}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out PreviewName)

public static bool TryParse(string previewName, out PreviewName result)

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

Parameters
NameDescription
previewNamestring

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

resultPreviewName

When this method returns, the parsed PreviewName, or null if parsing failed.

Returns
TypeDescription
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}/locations/{location}/previews/{preview}

TryParse(string, bool, out PreviewName)

public static bool TryParse(string previewName, bool allowUnparsed, out PreviewName result)

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

Parameters
NameDescription
previewNamestring

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

allowUnparsedbool

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.

resultPreviewName

When this method returns, the parsed PreviewName, or null if parsing failed.

Returns
TypeDescription
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}/locations/{location}/previews/{preview}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PreviewName, PreviewName)

public static bool operator ==(PreviewName a, PreviewName b)

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aPreviewName

The first resource name to compare, or null.

bPreviewName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(PreviewName, PreviewName)

public static bool operator !=(PreviewName a, PreviewName b)

Determines whether two specified resource names have different values.

Parameters
NameDescription
aPreviewName

The first resource name to compare, or null.

bPreviewName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.