public sealed class AspectTypeName : IResourceName, IEquatable<AspectTypeName>
Reference documentation and code samples for the Cloud Dataplex v1 API class AspectTypeName.
Resource name for the AspectType
resource.
Namespace
Google.Cloud.Dataplex.V1Assembly
Google.Cloud.Dataplex.V1.dll
Constructors
AspectTypeName(string, string, string)
public AspectTypeName(string projectId, string locationId, string aspectTypeId)
Constructs a new instance of a AspectTypeName class from the component parts of pattern
projects/{project}/locations/{location}/aspectTypes/{aspect_type}
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
aspectTypeId | string The |
Properties
AspectTypeId
public string AspectTypeId { get; }
The AspectType
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 AspectTypeName.ResourceNameType Type { get; }
The AspectTypeName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
AspectTypeNameResourceNameType |
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 aspectTypeId)
Formats the IDs into the string representation of this AspectTypeName with pattern
projects/{project}/locations/{location}/aspectTypes/{aspect_type}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
aspectTypeId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this AspectTypeName with pattern
|
FormatProjectLocationAspectType(string, string, string)
public static string FormatProjectLocationAspectType(string projectId, string locationId, string aspectTypeId)
Formats the IDs into the string representation of this AspectTypeName with pattern
projects/{project}/locations/{location}/aspectTypes/{aspect_type}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
aspectTypeId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this AspectTypeName with pattern
|
FromProjectLocationAspectType(string, string, string)
public static AspectTypeName FromProjectLocationAspectType(string projectId, string locationId, string aspectTypeId)
Creates a AspectTypeName with the pattern
projects/{project}/locations/{location}/aspectTypes/{aspect_type}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
aspectTypeId | string The |
Returns | |
---|---|
Type | Description |
AspectTypeName | A new instance of AspectTypeName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static AspectTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a AspectTypeName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
AspectTypeName | A new instance of AspectTypeName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static AspectTypeName Parse(string aspectTypeName)
Parses the given resource name string into a new AspectTypeName instance.
Parameter | |
---|---|
Name | Description |
aspectTypeName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
AspectTypeName | The parsed AspectTypeName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/aspectTypes/{aspect_type}
Parse(string, bool)
public static AspectTypeName Parse(string aspectTypeName, bool allowUnparsed)
Parses the given resource name string into a new AspectTypeName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
aspectTypeName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
AspectTypeName | The parsed AspectTypeName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/aspectTypes/{aspect_type}
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. |
TryParse(string, out AspectTypeName)
public static bool TryParse(string aspectTypeName, out AspectTypeName result)
Tries to parse the given resource name string into a new AspectTypeName instance.
Parameters | |
---|---|
Name | Description |
aspectTypeName | string The resource name in string form. Must not be |
result | AspectTypeName When this method returns, the parsed AspectTypeName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/aspectTypes/{aspect_type}
TryParse(string, bool, out AspectTypeName)
public static bool TryParse(string aspectTypeName, bool allowUnparsed, out AspectTypeName result)
Tries to parse the given resource name string into a new AspectTypeName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
aspectTypeName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | AspectTypeName When this method returns, the parsed AspectTypeName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/aspectTypes/{aspect_type}
allowUnparsed
is true
.
Operators
operator ==(AspectTypeName, AspectTypeName)
public static bool operator ==(AspectTypeName a, AspectTypeName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a | AspectTypeName The first resource name to compare, or null. |
b | AspectTypeName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool | true if the value of |
operator !=(AspectTypeName, AspectTypeName)
public static bool operator !=(AspectTypeName a, AspectTypeName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a | AspectTypeName The first resource name to compare, or null. |
b | AspectTypeName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool | true if the value of |