api_function_getgithubactionsinput

Get-GitHubActionsInput

• Type: Function
• In Version: >= v0.3.0

Description

# Parameter Set: All
Get-GitHubActionsInput -All [-EmptyStringAsNull] [-Trim]

# Parameter Set: One (Default)
Get-GitHubActionsInput [-Name] <String> [-Mandatory] [-MandatoryMessage <String>] [-EmptyStringAsNull] [-Trim]

# Parameter Set: Prefix
Get-GitHubActionsInput -NamePrefix <String> [-EmptyStringAsNull] [-Trim]

# Parameter Set: Suffix
Get-GitHubActionsInput -NameSuffix <String> [-EmptyStringAsNull] [-Trim]

Get input.

Parameter

All

<Switch> Whether to get all of the inputs.

• Parameter Set: All
• Position: Named
• Accept Pipeline Input By Property Name: False ❌

EmptyStringAsNull

[Optional] <Switch> Whether to assume empty string value of the input(s) as $Null.

• Parameter Set:
  • All
  • One
  • Prefix
  • Suffix
• Position: Named
• Accept Pipeline Input By Property Name: False ❌
• Alias:
  • (>= v1.1.0) AssumeEmptyStringAsNull

Mandatory

[Optional] <Switch> Whether the input is mandatory; If mandatory but not exist, will throw an error.

• Parameter Set: One
• Position: Named
• Accept Pipeline Input By Property Name: False ❌
• Alias:
  • Require
  • Required

MandatoryMessage

[Optional] <String> Message when the input is mandatory but not exist; Placeholder {0} will represent current input name.

• Parameter Set: One
• Default Value:

  'Input `{0}` is not defined!'
  #=> Input `foo_bar` is not defined!

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌
• Accept Wildcard Characters: False ❌
• Alias:
  • RequiredMessage
  • RequireMessage

Name

<String> Name of the input.

• Parameter Set: One
• Position: 0
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌
• Accept Wildcard Characters: False ❌
• Alias:
  • Key

NamePrefix

<String> Name of the inputs start with.

• Parameter Set: Prefix
• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌
• Accept Wildcard Characters: False ❌
• Alias:
  • KeyPrefix
  • KeyStartWith
  • NameStartWith
  • Prefix
  • PrefixKey
  • PrefixName
  • StartWith
  • StartWithKey
  • StartWithName

NameSuffix

<String> Name of the inputs end with.

• Parameter Set: Suffix
• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌
• Accept Wildcard Characters: False ❌
• Alias:
  • EndWith
  • EndWithKey
  • EndWithName
  • KeyEndWith
  • KeySuffix
  • NameEndWith
  • Suffix
  • SuffixKey
  • SuffixName

Trim

[Optional] <Switch> Whether to trim the value of the input(s).

• Parameter Set:
  • All
  • One
  • Prefix
  • Suffix
• Position: Named
• Accept Pipeline Input By Property Name: False ❌

Output

• All: <Hashtable> Inputs.
• One: <String> Value of the input.
• Prefix: <Hashtable> Inputs.
• Suffix: <Hashtable> Inputs.