Cloud Dataplex v1 API - Class ChangeRequestName (3.15.0)

3.15.0 (latest) 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.0.0

public sealed class ChangeRequestName : IResourceName, IEquatable<ChangeRequestName>

Reference documentation and code samples for the Cloud Dataplex v1 API class ChangeRequestName.

Resource name for the ChangeRequest resource.

Inheritance

object > ChangeRequestName

Implements

IResourceName, IEquatableChangeRequestName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

ChangeRequestName(string, string, string)

public ChangeRequestName(string projectId, string locationId, string changeRequestId)

Constructs a new instance of a ChangeRequestName class from the component parts of pattern projects/{project}/locations/{location}/changeRequests/{change_request}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
changeRequestId	string The ChangeRequest ID. Must not be null or empty.

Properties

ChangeRequestId

public string ChangeRequestId { get; }

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

Property Value
Type	Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
string

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 ChangeRequestName.ResourceNameType Type { get; }

The ChangeRequestName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ChangeRequestNameResourceNameType

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

Format(string, string, string)

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

Formats the IDs into the string representation of this ChangeRequestName with pattern projects/{project}/locations/{location}/changeRequests/{change_request}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
changeRequestId	string The ChangeRequest ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ChangeRequestName with pattern projects/{project}/locations/{location}/changeRequests/{change_request}.

FormatProjectLocationChangeRequest(string, string, string)

public static string FormatProjectLocationChangeRequest(string projectId, string locationId, string changeRequestId)

Formats the IDs into the string representation of this ChangeRequestName with pattern projects/{project}/locations/{location}/changeRequests/{change_request}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
changeRequestId	string The ChangeRequest ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ChangeRequestName with pattern projects/{project}/locations/{location}/changeRequests/{change_request}.

FromProjectLocationChangeRequest(string, string, string)

public static ChangeRequestName FromProjectLocationChangeRequest(string projectId, string locationId, string changeRequestId)

Creates a ChangeRequestName with the pattern projects/{project}/locations/{location}/changeRequests/{change_request}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
changeRequestId	string The ChangeRequest ID. Must not be null or empty.

Returns
Type	Description
ChangeRequestName	A new instance of ChangeRequestName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ChangeRequestName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ChangeRequestName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
ChangeRequestName	A new instance of ChangeRequestName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static ChangeRequestName Parse(string changeRequestName)

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

Parameter
Name	Description
changeRequestName	string The resource name in string form. Must not be null.

Returns
Type	Description
ChangeRequestName	The parsed ChangeRequestName if successful.

Remarks

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

• projects/{project}/locations/{location}/changeRequests/{change_request}

Parse(string, bool)

public static ChangeRequestName Parse(string changeRequestName, bool allowUnparsed)

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

Parameters
Name	Description
changeRequestName	string The resource name in string form. Must not be null.
allowUnparsed	bool 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
Type	Description
ChangeRequestName	The parsed ChangeRequestName if successful.

Remarks

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

• projects/{project}/locations/{location}/changeRequests/{change_request}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

TryParse(string, out ChangeRequestName)

public static bool TryParse(string changeRequestName, out ChangeRequestName result)

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

Parameters
Name	Description
changeRequestName	string The resource name in string form. Must not be null.
result	ChangeRequestName When this method returns, the parsed ChangeRequestName, or null if parsing failed.

Returns
Type	Description
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}/changeRequests/{change_request}

TryParse(string, bool, out ChangeRequestName)

public static bool TryParse(string changeRequestName, bool allowUnparsed, out ChangeRequestName result)

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

Parameters
Name	Description
changeRequestName	string The resource name in string form. Must not be null.
allowUnparsed	bool 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.
result	ChangeRequestName When this method returns, the parsed ChangeRequestName, or null if parsing failed.

Returns
Type	Description
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}/changeRequests/{change_request}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ChangeRequestName, ChangeRequestName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	ChangeRequestName The first resource name to compare, or null.
b	ChangeRequestName The second resource name to compare, or null.

Returns
Type	Description
bool	true if the value of a is the same as the value of b; otherwise, false.

operator !=(ChangeRequestName, ChangeRequestName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	ChangeRequestName The first resource name to compare, or null.
b	ChangeRequestName The second resource name to compare, or null.

Returns
Type	Description
bool	true if the value of a is different from the value of b; otherwise, false.