Skip to content
Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Get-GDataTransfer

SYNOPSIS

Retrieves a data transfer request by its resource ID.

SYNTAX

One

Get-GDataTransfer [-DataTransferId] <String> [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

List

Get-GDataTransfer [-All] [[-CustomerId] <String>] [[-MaxResults] <Int32>] [[-NewOwnerUserId] <String>]
 [[-OldOwnerUserId] <String>] [[-Status] <String>] [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Retrieves a data transfer request by its resource ID.

EXAMPLES

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

PS C:\> Get-GDataTransfer -DataTransferId $SomeDataTransferIdString

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.

---------- EXAMPLE 2 ----------

PS C:\> Get-GDataTransfer -All

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

-DataTransferId

ID of the resource to be retrieved. This is returned in the response from the insert method.

Type: String
Parameter Sets: One
Aliases: 

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

-All

A switch to list all results

Type: SwitchParameter
Parameter Sets: List
Aliases: 

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

-CustomerId

Immutable ID of the Google Apps account.

Type: String
Parameter Sets: List
Aliases: 

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

-MaxResults

Maximum number of results to return. Default is 100.

Type: Int32
Parameter Sets: List
Aliases: 

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

-NewOwnerUserId

Destination user's profile ID.

Type: String
Parameter Sets: List
Aliases: 

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

-OldOwnerUserId

Source user's profile ID.

Type: String
Parameter Sets: List
Aliases: 

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

-Status

Status of the transfer.

Type: String
Parameter Sets: List
Aliases: 

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

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

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

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

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

INPUTS

System.String

ID of the resource to be retrieved. This is returned in the response from the insert method.

System.String

Immutable ID of the Google Apps account.

System.Int32

Maximum number of results to return. Default is 100.

System.String

Destination user's profile ID.

System.String

Source user's profile ID.

System.String

Status of the transfer.

OUTPUTS

NOTES

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

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally