public sealed class SourceName : IResourceName, IEquatable<SourceName>
Resource name for the Source
resource.
Namespace
Google.Cloud.SecurityCenter.V1Assembly
Google.Cloud.SecurityCenter.V1.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 |
sourceId | String The |
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 |
Boolean |
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 |
SourceName.ResourceNameType |
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 |
sourceId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this SourceName with pattern
|
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 |
sourceId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this SourceName with pattern |
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 |
sourceId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this SourceName with pattern
|
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 |
sourceId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this SourceName with pattern
|
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 |
sourceId | String The |
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 |
sourceId | String The |
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 |
sourceId | String The |
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 |
Returns | |
---|---|
Type | Description |
SourceName | A new instance of SourceName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
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 |
Returns | |
---|---|
Type | Description |
SourceName | The parsed SourceName if successful. |
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, Boolean)
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 |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
SourceName | The parsed SourceName if successful. |
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}
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 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 |
result | SourceName When this method returns, the parsed SourceName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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, Boolean, 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 |
allowUnparsed | Boolean If |
result | SourceName When this method returns, the parsed SourceName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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}
allowUnparsed
is true
.
Operators
Equality(SourceName, SourceName)
public static bool operator ==(SourceName a, SourceName b)
Parameters | |
---|---|
Name | Description |
a | SourceName |
b | SourceName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(SourceName, SourceName)
public static bool operator !=(SourceName a, SourceName b)
Parameters | |
---|---|
Name | Description |
a | SourceName |
b | SourceName |
Returns | |
---|---|
Type | Description |
Boolean |