Class StoredInfoTypeName

public sealed class StoredInfoTypeName : IResourceName, IEquatable<StoredInfoTypeName>

Resource name for the StoredInfoType resource.

Inheritance

Object > StoredInfoTypeName

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

StoredInfoTypeName(String, String)

public StoredInfoTypeName(string organizationId, string storedInfoTypeId)

Constructs a new instance of a StoredInfoTypeName class from the component parts of pattern organizations/{organization}/storedInfoTypes/{stored_info_type}

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

storedInfoTypeIdString

The StoredInfoType 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
Boolean

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

StoredInfoTypeId

public string StoredInfoTypeId { get; }

The StoredInfoType ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

Type

public StoredInfoTypeName.ResourceNameType Type { get; }

The StoredInfoTypeName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
StoredInfoTypeName.ResourceNameType

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)

public static string Format(string organizationId, string storedInfoTypeId)

Formats the IDs into the string representation of this StoredInfoTypeName with pattern organizations/{organization}/storedInfoTypes/{stored_info_type}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

storedInfoTypeIdString

The StoredInfoType ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this StoredInfoTypeName with pattern organizations/{organization}/storedInfoTypes/{stored_info_type}.

FormatOrganizationLocationStoredInfoType(String, String, String)

public static string FormatOrganizationLocationStoredInfoType(string organizationId, string locationId, string storedInfoTypeId)

Formats the IDs into the string representation of this StoredInfoTypeName with pattern organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

storedInfoTypeIdString

The StoredInfoType ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this StoredInfoTypeName with pattern organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}.

FormatOrganizationStoredInfoType(String, String)

public static string FormatOrganizationStoredInfoType(string organizationId, string storedInfoTypeId)

Formats the IDs into the string representation of this StoredInfoTypeName with pattern organizations/{organization}/storedInfoTypes/{stored_info_type}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

storedInfoTypeIdString

The StoredInfoType ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this StoredInfoTypeName with pattern organizations/{organization}/storedInfoTypes/{stored_info_type}.

FormatProjectLocationStoredInfoType(String, String, String)

public static string FormatProjectLocationStoredInfoType(string projectId, string locationId, string storedInfoTypeId)

Formats the IDs into the string representation of this StoredInfoTypeName with pattern projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

storedInfoTypeIdString

The StoredInfoType ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this StoredInfoTypeName with pattern projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}.

FormatProjectStoredInfoType(String, String)

public static string FormatProjectStoredInfoType(string projectId, string storedInfoTypeId)

Formats the IDs into the string representation of this StoredInfoTypeName with pattern projects/{project}/storedInfoTypes/{stored_info_type}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

storedInfoTypeIdString

The StoredInfoType ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this StoredInfoTypeName with pattern projects/{project}/storedInfoTypes/{stored_info_type}.

FromOrganizationLocationStoredInfoType(String, String, String)

public static StoredInfoTypeName FromOrganizationLocationStoredInfoType(string organizationId, string locationId, string storedInfoTypeId)

Creates a StoredInfoTypeName with the pattern organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

storedInfoTypeIdString

The StoredInfoType ID. Must not be null or empty.

Returns
TypeDescription
StoredInfoTypeName

A new instance of StoredInfoTypeName constructed from the provided ids.

FromOrganizationStoredInfoType(String, String)

public static StoredInfoTypeName FromOrganizationStoredInfoType(string organizationId, string storedInfoTypeId)

Creates a StoredInfoTypeName with the pattern organizations/{organization}/storedInfoTypes/{stored_info_type}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

storedInfoTypeIdString

The StoredInfoType ID. Must not be null or empty.

Returns
TypeDescription
StoredInfoTypeName

A new instance of StoredInfoTypeName constructed from the provided ids.

FromProjectLocationStoredInfoType(String, String, String)

public static StoredInfoTypeName FromProjectLocationStoredInfoType(string projectId, string locationId, string storedInfoTypeId)

Creates a StoredInfoTypeName with the pattern projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

storedInfoTypeIdString

The StoredInfoType ID. Must not be null or empty.

Returns
TypeDescription
StoredInfoTypeName

A new instance of StoredInfoTypeName constructed from the provided ids.

FromProjectStoredInfoType(String, String)

public static StoredInfoTypeName FromProjectStoredInfoType(string projectId, string storedInfoTypeId)

Creates a StoredInfoTypeName with the pattern projects/{project}/storedInfoTypes/{stored_info_type}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

storedInfoTypeIdString

The StoredInfoType ID. Must not be null or empty.

Returns
TypeDescription
StoredInfoTypeName

A new instance of StoredInfoTypeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static StoredInfoTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a StoredInfoTypeName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
StoredInfoTypeName

A new instance of StoredInfoTypeName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static StoredInfoTypeName Parse(string storedInfoTypeName)

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

Parameter
NameDescription
storedInfoTypeNameString

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

Returns
TypeDescription
StoredInfoTypeName

The parsed StoredInfoTypeName if successful.

Remarks

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

  • organizations/{organization}/storedInfoTypes/{stored_info_type}
  • projects/{project}/storedInfoTypes/{stored_info_type}
  • organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}
  • projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}

Parse(String, Boolean)

public static StoredInfoTypeName Parse(string storedInfoTypeName, bool allowUnparsed)

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

Parameters
NameDescription
storedInfoTypeNameString

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

allowUnparsedBoolean

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
StoredInfoTypeName

The parsed StoredInfoTypeName if successful.

Remarks

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

  • organizations/{organization}/storedInfoTypes/{stored_info_type}
  • projects/{project}/storedInfoTypes/{stored_info_type}
  • organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}
  • projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}
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 StoredInfoTypeName)

public static bool TryParse(string storedInfoTypeName, out StoredInfoTypeName result)

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

Parameters
NameDescription
storedInfoTypeNameString

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

resultStoredInfoTypeName

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

Returns
TypeDescription
Boolean

true if the name was parsed successfully; false otherwise.

Remarks

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

  • organizations/{organization}/storedInfoTypes/{stored_info_type}
  • projects/{project}/storedInfoTypes/{stored_info_type}
  • organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}
  • projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}

TryParse(String, Boolean, out StoredInfoTypeName)

public static bool TryParse(string storedInfoTypeName, bool allowUnparsed, out StoredInfoTypeName result)

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

Parameters
NameDescription
storedInfoTypeNameString

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

allowUnparsedBoolean

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.

resultStoredInfoTypeName

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

Returns
TypeDescription
Boolean

true if the name was parsed successfully; false otherwise.

Remarks

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

  • organizations/{organization}/storedInfoTypes/{stored_info_type}
  • projects/{project}/storedInfoTypes/{stored_info_type}
  • organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}
  • projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}
Or may be in any format if allowUnparsed is true.

Operators

Equality(StoredInfoTypeName, StoredInfoTypeName)

public static bool operator ==(StoredInfoTypeName a, StoredInfoTypeName b)
Parameters
NameDescription
aStoredInfoTypeName
bStoredInfoTypeName
Returns
TypeDescription
Boolean

Inequality(StoredInfoTypeName, StoredInfoTypeName)

public static bool operator !=(StoredInfoTypeName a, StoredInfoTypeName b)
Parameters
NameDescription
aStoredInfoTypeName
bStoredInfoTypeName
Returns
TypeDescription
Boolean