BigQuery Data Policy v1 API - Class DataPolicyName (1.0.0) 

public sealed class DataPolicyName : IResourceName, IEquatable<DataPolicyName>

Reference documentation and code samples for the BigQuery Data Policy v1 API class DataPolicyName.

Resource name for the DataPolicy resource.

Inheritance

object > DataPolicyName

Namespace

GoogleGoogle.CloudGoogle.Cloud.BigQueryGoogle.Cloud.BigQuery.DataPoliciesV1

Assembly

Google.Cloud.BigQuery.DataPolicies.V1.dll

Constructors

DataPolicyName(string, string, string)

public DataPolicyName(string projectId, string locationId, string dataPolicyId)

Constructs a new instance of a DataPolicyName class from the component parts of pattern projects/{project}/locations/{location}/dataPolicies/{data_policy}

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.
dataPolicyId string

The DataPolicy ID. Must not be null or empty.

Properties

DataPolicyId

public string DataPolicyId { get; }

The DataPolicy 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 DataPolicyName.ResourceNameType Type { get; }

The DataPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
DataPolicyNameResourceNameType

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 dataPolicyId)

Formats the IDs into the string representation of this DataPolicyName with pattern projects/{project}/locations/{location}/dataPolicies/{data_policy}.

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.
dataPolicyId string

The DataPolicy ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DataPolicyName with pattern projects/{project}/locations/{location}/dataPolicies/{data_policy}.

FormatProjectLocationDataPolicy(string, string, string)

public static string FormatProjectLocationDataPolicy(string projectId, string locationId, string dataPolicyId)

Formats the IDs into the string representation of this DataPolicyName with pattern projects/{project}/locations/{location}/dataPolicies/{data_policy}.

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.
dataPolicyId string

The DataPolicy ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DataPolicyName with pattern projects/{project}/locations/{location}/dataPolicies/{data_policy}.

FromProjectLocationDataPolicy(string, string, string)

public static DataPolicyName FromProjectLocationDataPolicy(string projectId, string locationId, string dataPolicyId)

Creates a DataPolicyName with the pattern projects/{project}/locations/{location}/dataPolicies/{data_policy}.

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.
dataPolicyId string

The DataPolicy ID. Must not be null or empty.
Returns
Type Description
DataPolicyName

A new instance of DataPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DataPolicyName

A new instance of DataPolicyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static DataPolicyName Parse(string dataPolicyName)

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

Parameter
Name Description
dataPolicyName string

The resource name in string form. Must not be null.
Returns
Type Description
DataPolicyName

The parsed DataPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataPolicies/{data_policy}

Parse(string, bool)

public static DataPolicyName Parse(string dataPolicyName, bool allowUnparsed)

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

Parameters
Name Description
dataPolicyName 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
DataPolicyName

The parsed DataPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataPolicies/{data_policy}
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

TryParse(string, out DataPolicyName)

public static bool TryParse(string dataPolicyName, out DataPolicyName result)

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

Parameters
Name Description
dataPolicyName string

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

When this method returns, the parsed DataPolicyName, 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}/dataPolicies/{data_policy}

TryParse(string, bool, out DataPolicyName)

public static bool TryParse(string dataPolicyName, bool allowUnparsed, out DataPolicyName result)

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

Parameters
Name Description
dataPolicyName 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 DataPolicyName

When this method returns, the parsed DataPolicyName, 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}/dataPolicies/{data_policy}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataPolicyName, DataPolicyName)

public static bool operator ==(DataPolicyName a, DataPolicyName b)
Parameters
Name Description
a DataPolicyName
b DataPolicyName
Returns
Type Description
bool

operator !=(DataPolicyName, DataPolicyName)

public static bool operator !=(DataPolicyName a, DataPolicyName b)
Parameters
Name Description
a DataPolicyName
b DataPolicyName
Returns
Type Description
bool