Security Command Center v2 API - Class SourceName (1.3.0) 

public sealed class SourceName : IResourceName, IEquatable<SourceName>

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

Resource name for the Source resource.

Inheritance

object > SourceName

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

SourceName(string, string)

public SourceName(string organizationId, string sourceId)

Constructs a new instance of a SourceName class from the component parts of pattern organizations/{organization}/sources/{source}

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
sourceId string

The Source 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

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

SourceId

public string SourceId { get; }

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

Property Value
Type Description
string

Type

public SourceName.ResourceNameType Type { get; }

The SourceName.ResourceNameType of the contained resource name.

Property Value
Type Description
SourceNameResourceNameType

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

Formats the IDs into the string representation of this SourceName with pattern organizations/{organization}/sources/{source}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
sourceId string

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

The string representation of this SourceName with pattern organizations/{organization}/sources/{source}.

FormatFolderSource(string, string)

public static string FormatFolderSource(string folderId, string sourceId)

Formats the IDs into the string representation of this SourceName with pattern folders/{folder}/sources/{source}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
sourceId string

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

The string representation of this SourceName with pattern folders/{folder}/sources/{source} .

FormatOrganizationSource(string, string)

public static string FormatOrganizationSource(string organizationId, string sourceId)

Formats the IDs into the string representation of this SourceName with pattern organizations/{organization}/sources/{source}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
sourceId string

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

The string representation of this SourceName with pattern organizations/{organization}/sources/{source}.

FormatProjectSource(string, string)

public static string FormatProjectSource(string projectId, string sourceId)

Formats the IDs into the string representation of this SourceName with pattern projects/{project}/sources/{source}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
sourceId string

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

The string representation of this SourceName with pattern projects/{project}/sources/{source}.

FromFolderSource(string, string)

public static SourceName FromFolderSource(string folderId, string sourceId)

Creates a SourceName with the pattern folders/{folder}/sources/{source}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
sourceId string

The Source ID. Must not be null or empty.
Returns
Type Description
SourceName

A new instance of SourceName constructed from the provided ids.

FromOrganizationSource(string, string)

public static SourceName FromOrganizationSource(string organizationId, string sourceId)

Creates a SourceName with the pattern organizations/{organization}/sources/{source}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
sourceId string

The Source ID. Must not be null or empty.
Returns
Type Description
SourceName

A new instance of SourceName constructed from the provided ids.

FromProjectSource(string, string)

public static SourceName FromProjectSource(string projectId, string sourceId)

Creates a SourceName with the pattern projects/{project}/sources/{source}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
sourceId string

The Source ID. Must not be null or empty.
Returns
Type Description
SourceName

A new instance of SourceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SourceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SourceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of SourceName 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 SourceName Parse(string sourceName)

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

Parameter
Name Description
sourceName string

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

The parsed SourceName if successful.
Remarks

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

  • organizations/{organization}/sources/{source}
  • folders/{folder}/sources/{source}
  • projects/{project}/sources/{source}

Parse(string, bool)

public static SourceName Parse(string sourceName, bool allowUnparsed)

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

Parameters
Name Description
sourceName 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
SourceName

The parsed SourceName if successful.
Remarks

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

  • organizations/{organization}/sources/{source}
  • folders/{folder}/sources/{source}
  • projects/{project}/sources/{source}
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 SourceName)

public static bool TryParse(string sourceName, out SourceName result)

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

Parameters
Name Description
sourceName string

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

When this method returns, the parsed SourceName, 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}/sources/{source}
  • folders/{folder}/sources/{source}
  • projects/{project}/sources/{source}

TryParse(string, bool, out SourceName)

public static bool TryParse(string sourceName, bool allowUnparsed, out SourceName result)

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

Parameters
Name Description
sourceName 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 SourceName

When this method returns, the parsed SourceName, 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}/sources/{source}
  • folders/{folder}/sources/{source}
  • projects/{project}/sources/{source}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SourceName, SourceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SourceName

The first resource name to compare, or null.
b SourceName

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 !=(SourceName, SourceName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SourceName

The first resource name to compare, or null.
b SourceName

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.