Security Command Center v2 API - Class MuteConfigName (1.0.0-beta05)

public sealed class MuteConfigName : IResourceName, IEquatable<MuteConfigName>

Reference documentation and code samples for the Security Command Center v2 API class MuteConfigName.

Resource name for the MuteConfig resource.

Inheritance

object > MuteConfigName

Implements

IResourceName, IEquatable MuteConfigName

Inherited Members

object.GetType()

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

MuteConfigName(string, string)

public MuteConfigName(string organizationId, string muteConfigId)

Constructs a new instance of a MuteConfigName class from the component parts of pattern organizations/{organization}/muteConfigs/{mute_config}

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

Properties

FolderId

public string FolderId { get; }

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

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

MuteConfigId

public string MuteConfigId { get; }

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

Property Value
Type	Description
`string`

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

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

Property Value
Type	Description
`string`

Type

public MuteConfigName.ResourceNameType Type { get; }

The MuteConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`MuteConfigNameResourceNameType`

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)

public static string Format(string organizationId, string muteConfigId)

Formats the IDs into the string representation of this MuteConfigName with pattern organizations/{organization}/muteConfigs/{mute_config}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MuteConfigName with pattern `organizations/{organization}/muteConfigs/{mute_config}`.

FormatFolderLocationMuteConfig(string, string, string)

public static string FormatFolderLocationMuteConfig(string folderId, string locationId, string muteConfigId)

Formats the IDs into the string representation of this MuteConfigName with pattern folders/{folder}/locations/{location}/muteConfigs/{mute_config}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MuteConfigName with pattern `folders/{folder}/locations/{location}/muteConfigs/{mute_config}`.

FormatFolderMuteConfig(string, string)

public static string FormatFolderMuteConfig(string folderId, string muteConfigId)

Formats the IDs into the string representation of this MuteConfigName with pattern folders/{folder}/muteConfigs/{mute_config}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MuteConfigName with pattern `folders/{folder}/muteConfigs/{mute_config}`.

FormatOrganizationLocationMuteConfig(string, string, string)

public static string FormatOrganizationLocationMuteConfig(string organizationId, string locationId, string muteConfigId)

Formats the IDs into the string representation of this MuteConfigName with pattern organizations/{organization}/locations/{location}/muteConfigs/{mute_config}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MuteConfigName with pattern `organizations/{organization}/locations/{location}/muteConfigs/{mute_config}`.

FormatOrganizationMuteConfig(string, string)

public static string FormatOrganizationMuteConfig(string organizationId, string muteConfigId)

Formats the IDs into the string representation of this MuteConfigName with pattern organizations/{organization}/muteConfigs/{mute_config}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MuteConfigName with pattern `organizations/{organization}/muteConfigs/{mute_config}`.

FormatProjectLocationMuteConfig(string, string, string)

public static string FormatProjectLocationMuteConfig(string projectId, string locationId, string muteConfigId)

Formats the IDs into the string representation of this MuteConfigName with pattern projects/{project}/locations/{location}/muteConfigs/{mute_config}.

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.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MuteConfigName with pattern `projects/{project}/locations/{location}/muteConfigs/{mute_config}`.

FormatProjectMuteConfig(string, string)

public static string FormatProjectMuteConfig(string projectId, string muteConfigId)

Formats the IDs into the string representation of this MuteConfigName with pattern projects/{project}/muteConfigs/{mute_config}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MuteConfigName with pattern `projects/{project}/muteConfigs/{mute_config}`.

FromFolderLocationMuteConfig(string, string, string)

public static MuteConfigName FromFolderLocationMuteConfig(string folderId, string locationId, string muteConfigId)

Creates a MuteConfigName with the pattern folders/{folder}/locations/{location}/muteConfigs/{mute_config}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

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

FromFolderMuteConfig(string, string)

public static MuteConfigName FromFolderMuteConfig(string folderId, string muteConfigId)

Creates a MuteConfigName with the pattern folders/{folder}/muteConfigs/{mute_config}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

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

FromOrganizationLocationMuteConfig(string, string, string)

public static MuteConfigName FromOrganizationLocationMuteConfig(string organizationId, string locationId, string muteConfigId)

Creates a MuteConfigName with the pattern organizations/{organization}/locations/{location}/muteConfigs/{mute_config}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

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

FromOrganizationMuteConfig(string, string)

public static MuteConfigName FromOrganizationMuteConfig(string organizationId, string muteConfigId)

Creates a MuteConfigName with the pattern organizations/{organization}/muteConfigs/{mute_config}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

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

FromProjectLocationMuteConfig(string, string, string)

public static MuteConfigName FromProjectLocationMuteConfig(string projectId, string locationId, string muteConfigId)

Creates a MuteConfigName with the pattern projects/{project}/locations/{location}/muteConfigs/{mute_config}.

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.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

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

FromProjectMuteConfig(string, string)

public static MuteConfigName FromProjectMuteConfig(string projectId, string muteConfigId)

Creates a MuteConfigName with the pattern projects/{project}/muteConfigs/{mute_config}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`muteConfigId`	`string` The `MuteConfig` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static MuteConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MuteConfigName containing an unparsed resource name.

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

Returns
Type	Description
`MuteConfigName`	A new instance of MuteConfigName 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 MuteConfigName Parse(string muteConfigName)

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

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

Returns
Type	Description
`MuteConfigName`	The parsed MuteConfigName if successful.

Remarks

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

organizations/{organization}/muteConfigs/{mute_config}
organizations/{organization}/locations/{location}/muteConfigs/{mute_config}
folders/{folder}/muteConfigs/{mute_config}
folders/{folder}/locations/{location}/muteConfigs/{mute_config}
projects/{project}/muteConfigs/{mute_config}
projects/{project}/locations/{location}/muteConfigs/{mute_config}

Parse(string, bool)

public static MuteConfigName Parse(string muteConfigName, bool allowUnparsed)

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

Parameters
Name	Description
`muteConfigName`	`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
`MuteConfigName`	The parsed MuteConfigName if successful.

Remarks

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

organizations/{organization}/muteConfigs/{mute_config}
organizations/{organization}/locations/{location}/muteConfigs/{mute_config}
folders/{folder}/muteConfigs/{mute_config}
folders/{folder}/locations/{location}/muteConfigs/{mute_config}
projects/{project}/muteConfigs/{mute_config}
projects/{project}/locations/{location}/muteConfigs/{mute_config}

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

public static bool TryParse(string muteConfigName, out MuteConfigName result)

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

Parameters
Name	Description
`muteConfigName`	`string` The resource name in string form. Must not be `null`.
`result`	`MuteConfigName` When this method returns, the parsed MuteConfigName, 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:

organizations/{organization}/muteConfigs/{mute_config}
organizations/{organization}/locations/{location}/muteConfigs/{mute_config}
folders/{folder}/muteConfigs/{mute_config}
folders/{folder}/locations/{location}/muteConfigs/{mute_config}
projects/{project}/muteConfigs/{mute_config}
projects/{project}/locations/{location}/muteConfigs/{mute_config}

TryParse(string, bool, out MuteConfigName)

public static bool TryParse(string muteConfigName, bool allowUnparsed, out MuteConfigName result)

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

Parameters
Name	Description
`muteConfigName`	`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`	`MuteConfigName` When this method returns, the parsed MuteConfigName, 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:

organizations/{organization}/muteConfigs/{mute_config}
organizations/{organization}/locations/{location}/muteConfigs/{mute_config}
folders/{folder}/muteConfigs/{mute_config}
folders/{folder}/locations/{location}/muteConfigs/{mute_config}
projects/{project}/muteConfigs/{mute_config}
projects/{project}/locations/{location}/muteConfigs/{mute_config}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MuteConfigName, MuteConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`MuteConfigName` The first resource name to compare, or null.
`b`	`MuteConfigName` 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 !=(MuteConfigName, MuteConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`MuteConfigName` The first resource name to compare, or null.
`b`	`MuteConfigName` 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.