Class AerialViewClient

AerialView client wrapper, for convenient use.

Inheritance

object

AerialViewClient

AerialViewClientImpl

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Maps.AerialView.V1

Assembly: Google.Maps.AerialView.V1.dll

Syntax

public abstract class AerialViewClient

Remarks

Service definition for the Aerial View API.

Properties

DefaultEndpoint

The default endpoint for the AerialView service, which is a host of "aerialview.googleapis.com" and a port of 443.

Declaration

public static string DefaultEndpoint { get; }

Property Value

Type	Description
string

DefaultScopes

The default AerialView scopes.

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default AerialView scopes are:

• https://www.googleapis.com/auth/cloud-platform

GrpcClient

The underlying gRPC AerialView client

Declaration

public virtual AerialView.AerialViewClient GrpcClient { get; }

Property Value

Type	Description
AerialView.AerialViewClient

ServiceMetadata

The service metadata associated with this client type.

Declaration

public static ServiceMetadata ServiceMetadata { get; }

Property Value

Type	Description
ServiceMetadata

Methods

Create()

Synchronously creates a AerialViewClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AerialViewClientBuilder.

Declaration

public static AerialViewClient Create()

Returns

Type	Description
AerialViewClient	The created AerialViewClient.

CreateAsync(CancellationToken)

Asynchronously creates a AerialViewClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AerialViewClientBuilder.

Declaration

public static Task<AerialViewClient> CreateAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The CancellationToken to use while creating the client.

Returns

Type	Description
Task<AerialViewClient>	The task representing the created AerialViewClient.

LookupVideo(LookupVideoRequest, CallSettings)

Fetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request.

Declaration

public virtual Video LookupVideo(LookupVideoRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
LookupVideoRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Video	The RPC response.

Sample code

// Create client
AerialViewClient aerialViewClient = AerialViewClient.Create();
// Initialize request argument(s)
LookupVideoRequest request = new LookupVideoRequest { VideoId = "", };
// Make the request
Video response = aerialViewClient.LookupVideo(request);

LookupVideoAsync(LookupVideoRequest, CallSettings)

Fetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request.

Declaration

public virtual Task<Video> LookupVideoAsync(LookupVideoRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
LookupVideoRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Video>	A Task containing the RPC response.

Sample code

// Create client
AerialViewClient aerialViewClient = await AerialViewClient.CreateAsync();
// Initialize request argument(s)
LookupVideoRequest request = new LookupVideoRequest { VideoId = "", };
// Make the request
Video response = await aerialViewClient.LookupVideoAsync(request);

LookupVideoAsync(LookupVideoRequest, CancellationToken)

Fetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request.

Declaration

public virtual Task<Video> LookupVideoAsync(LookupVideoRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
LookupVideoRequest	request	The request object containing all of the parameters for the API call.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Video>	A Task containing the RPC response.

Sample code

// Create client
AerialViewClient aerialViewClient = await AerialViewClient.CreateAsync();
// Initialize request argument(s)
LookupVideoRequest request = new LookupVideoRequest { VideoId = "", };
// Make the request
Video response = await aerialViewClient.LookupVideoAsync(request);

RenderVideo(RenderVideoRequest, CallSettings)

Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.

Declaration

public virtual RenderVideoResponse RenderVideo(RenderVideoRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RenderVideoRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
RenderVideoResponse	The RPC response.

Sample code

// Create client
AerialViewClient aerialViewClient = AerialViewClient.Create();
// Initialize request argument(s)
RenderVideoRequest request = new RenderVideoRequest { Address = "", };
// Make the request
RenderVideoResponse response = aerialViewClient.RenderVideo(request);

RenderVideo(string, CallSettings)

Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.

Declaration

public virtual RenderVideoResponse RenderVideo(string address, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	address	Required. A US postal address for the location to be rendered in the video.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
RenderVideoResponse	The RPC response.

Sample code

// Create client
AerialViewClient aerialViewClient = AerialViewClient.Create();
// Initialize request argument(s)
string address = "";
// Make the request
RenderVideoResponse response = aerialViewClient.RenderVideo(address);

RenderVideoAsync(RenderVideoRequest, CallSettings)

Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.

Declaration

public virtual Task<RenderVideoResponse> RenderVideoAsync(RenderVideoRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RenderVideoRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<RenderVideoResponse>	A Task containing the RPC response.

Sample code

// Create client
AerialViewClient aerialViewClient = await AerialViewClient.CreateAsync();
// Initialize request argument(s)
RenderVideoRequest request = new RenderVideoRequest { Address = "", };
// Make the request
RenderVideoResponse response = await aerialViewClient.RenderVideoAsync(request);

RenderVideoAsync(RenderVideoRequest, CancellationToken)

Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.

Declaration

public virtual Task<RenderVideoResponse> RenderVideoAsync(RenderVideoRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RenderVideoRequest	request	The request object containing all of the parameters for the API call.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<RenderVideoResponse>	A Task containing the RPC response.

Sample code

// Create client
AerialViewClient aerialViewClient = await AerialViewClient.CreateAsync();
// Initialize request argument(s)
RenderVideoRequest request = new RenderVideoRequest { Address = "", };
// Make the request
RenderVideoResponse response = await aerialViewClient.RenderVideoAsync(request);

RenderVideoAsync(string, CallSettings)

Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.

Declaration

public virtual Task<RenderVideoResponse> RenderVideoAsync(string address, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	address	Required. A US postal address for the location to be rendered in the video.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<RenderVideoResponse>	A Task containing the RPC response.

Sample code

// Create client
AerialViewClient aerialViewClient = await AerialViewClient.CreateAsync();
// Initialize request argument(s)
string address = "";
// Make the request
RenderVideoResponse response = await aerialViewClient.RenderVideoAsync(address);

RenderVideoAsync(string, CancellationToken)

Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.

Declaration

public virtual Task<RenderVideoResponse> RenderVideoAsync(string address, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	address	Required. A US postal address for the location to be rendered in the video.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<RenderVideoResponse>	A Task containing the RPC response.

Sample code

// Create client
AerialViewClient aerialViewClient = await AerialViewClient.CreateAsync();
// Initialize request argument(s)
string address = "";
// Make the request
RenderVideoResponse response = await aerialViewClient.RenderVideoAsync(address);

ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Declaration

public static Task ShutdownDefaultChannelsAsync()

Returns

Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.