Skip to content

New GReportsChannelObj

Spencer Varney edited this page Dec 8, 2016 · 2 revisions

New-GReportsChannelObj

SYNOPSIS

Creates a new Reports API Channel object.

SYNTAX

New-GReportsChannelObj [[-Address] <String>] [[-Expiration] <Int64>] [[-Id] <String>]
 [[-Params__] <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [[-Payload] <Boolean>]
 [[-ResourceId] <String>] [[-ResourceUri] <String>] [[-Token] <String>] [[-Type] <String>] [-WhatIf] [-Confirm]

DESCRIPTION

This provides a Cmdlet-Based approach to creating a Channel object which may be required as a parameter for some other Cmdlets in the Reports API category.

You could alternately create this object by calling New-Object -TypeName Google.Apis.admin.Reports.reports_v1.Data.Channel

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> New-GRepChannelObj

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-Address

The address where notifications are delivered for this channel.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Expiration

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

Type: Int64
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Id

A UUID or similar unique string that identifies this channel.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Params__

Additional parameters controlling delivery channel behavior. Optional.

Type: System.Collections.Generic.IDictionary`2[System.String,System.String]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Payload

A Boolean value to indicate whether payload is wanted. Optional.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 4
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceId

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 5
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceUri

A version-specific identifier for the watched resource.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 6
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Token

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 7
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Type

The type of delivery mechanism used for this channel.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 8
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

{{Fill Confirm Description}}

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

{{Fill WhatIf Description}}

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

System.String

The address where notifications are delivered for this channel.

System.Int64

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

System.String

A UUID or similar unique string that identifies this channel.

Additional parameters controlling delivery channel behavior. Optional.

System.Boolean

A Boolean value to indicate whether payload is wanted. Optional.

System.String

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

System.String

A version-specific identifier for the watched resource.

System.String

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

System.String

The type of delivery mechanism used for this channel.

OUTPUTS

Google.Apis.admin.Reports.reports_v1.Data.Channel

NOTES

Part of the gShell Project, relating to the Google Reports API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally