CloudAnalyticsClient (Microsoft Azure Storage Android Client SDK 2.0.0 API)

java.lang.Object
- com.microsoft.azure.storage.analytics.CloudAnalyticsClient

```
public class CloudAnalyticsClient
extends Object
```
Provides a client-side logical representation for Microsoft Azure Storage Analytics. This client is used to configure and execute storage analytics requests.
The service client encapsulates the endpoint or endpoints for the blob and table service. It also encapsulates the credentials for accessing the storage account.

Constructor Summary

Constructors
Constructor and Description
`CloudAnalyticsClient(StorageUri blobStorageUri, StorageUri tableStorageUri, StorageCredentials credentials)` Initializes a new instance of the `CloudAnalyticsClient` class using the specified blob and table service endpoints and account credentials.

Method Summary

Methods
Modifier and Type	Method and Description
`CloudTable`	`getCapacityTable()` Gets the capacity metrics table for the blob service.
`CloudTable`	`getHourMetricsTable(StorageService service)` Gets the hour metrics table for a specific storage service.
`CloudTable`	`getHourMetricsTable(StorageService service, StorageLocation location)` Gets the hour metrics table for a specific storage service.
`CloudBlobDirectory`	`getLogDirectory(StorageService service)` Gets the `CloudBlobDirectory` object for the logs for a specific storage service.
`CloudTable`	`getMinuteMetricsTable(StorageService service)` Gets the minute metrics table for a specific storage service.
`CloudTable`	`getMinuteMetricsTable(StorageService service, StorageLocation location)` Gets the minute metrics table for a specific storage service.
`Iterable<ListBlobItem>`	`listLogBlobs(StorageService service)` Returns an enumerable collection of log blobs, retrieved lazily.
`Iterable<ListBlobItem>`	`listLogBlobs(StorageService service, Date startTime, Date endTime, EnumSet<LoggingOperations> operations, BlobListingDetails details, BlobRequestOptions options, OperationContext operationContext)` Returns an enumerable collection of log blobs, retrieved lazily.
`Iterable<LogRecord>`	`listLogRecords(StorageService service)` Returns an enumerable collection of log records, retrieved lazily.
`Iterable<LogRecord>`	`listLogRecords(StorageService service, Date startTime, Date endTime, BlobRequestOptions options, OperationContext operationContext)` Returns an enumerable collection of log records, retrieved lazily.
`static Iterable<LogRecord>`	`parseLogBlob(ListBlobItem logBlob)` Returns an enumerable collection of log records, retrieved lazily.
`static Iterable<LogRecord>`	`parseLogBlobs(Iterable<ListBlobItem> logBlobs)` Returns an enumerable collection of log records, retrieved lazily.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CloudAnalyticsClient
```
public CloudAnalyticsClient(StorageUri blobStorageUri,
                    StorageUri tableStorageUri,
                    StorageCredentials credentials)
```
    Initializes a new instance of the CloudAnalyticsClient class using the specified blob and table service endpoints and account credentials.
    
    Parameters:
    blobStorageUri - A StorageUri object containing the Blob service endpoint to use to create the client.
    tableStorageUri - A StorageUri object containing the Table service endpoint to use to create the client.
    credentials - A StorageCredentials object.
- Method Detail
  - getLogDirectory
```
public CloudBlobDirectory getLogDirectory(StorageService service)
                                   throws URISyntaxException,
                                          StorageException
```
    Gets the CloudBlobDirectory object for the logs for a specific storage service.
    
    Parameters:
    service - A StorageService enumeration value that indicates which storage service to use.
    
    Returns:
    A CloudBlobDirectory object.
    
    Throws:
    
    URISyntaxException
    
    StorageException
  - getHourMetricsTable
```
public CloudTable getHourMetricsTable(StorageService service)
                               throws URISyntaxException,
                                      StorageException
```
    Gets the hour metrics table for a specific storage service.
    
    Parameters:
    service - A StorageService enumeration value that indicates which storage service to use.
    
    Returns:
    The CloudTable object for the storage service.
    
    Throws:
    
    URISyntaxException
    
    StorageException
  - getHourMetricsTable
```
public CloudTable getHourMetricsTable(StorageService service,
                             StorageLocation location)
                               throws URISyntaxException,
                                      StorageException
```
    Gets the hour metrics table for a specific storage service.
    
    Parameters:
    service - A StorageService enumeration value that indicates which storage service to use.
    location - A StorageLocation enumeration value that indicates which storage location to use.
    
    Returns:
    The CloudTable object for the storage service.
    
    Throws:
    
    URISyntaxException
    
    StorageException
  - getMinuteMetricsTable
```
public CloudTable getMinuteMetricsTable(StorageService service)
                                 throws URISyntaxException,
                                        StorageException
```
    Gets the minute metrics table for a specific storage service.
    
    Parameters:
    service - A StorageService enumeration value that indicates which storage service to use.
    
    Returns:
    The CloudTable object for the storage service.
    
    Throws:
    
    URISyntaxException
    
    StorageException
  - getMinuteMetricsTable
```
public CloudTable getMinuteMetricsTable(StorageService service,
                               StorageLocation location)
                                 throws URISyntaxException,
                                        StorageException
```
    Gets the minute metrics table for a specific storage service.
    
    Parameters:
    service - A StorageService enumeration value that indicates which storage service to use.
    location - A StorageLocation enumeration value that indicates which storage location to use.
    
    Returns:
    The CloudTable object for the storage service.
    
    Throws:
    
    URISyntaxException
    
    StorageException
  - getCapacityTable
```
public CloudTable getCapacityTable()
                            throws URISyntaxException,
                                   StorageException
```
    Gets the capacity metrics table for the blob service.
    
    Returns:
    A CloudTable object.
    
    Throws:
    
    URISyntaxException
    
    StorageException
  - listLogBlobs
```
public Iterable<ListBlobItem> listLogBlobs(StorageService service)
                                    throws URISyntaxException,
                                           StorageException
```
    Returns an enumerable collection of log blobs, retrieved lazily.
    
    Parameters:
    service - A StorageService enumeration value that indicates which storage service to use.
    
    Returns:
    An enumerable collection of objects that implement ListBlobItem and are retrieved lazily.
    
    Throws:
    
    URISyntaxException
    
    StorageException
  - listLogBlobs
```
public Iterable<ListBlobItem> listLogBlobs(StorageService service,
                                  Date startTime,
                                  Date endTime,
                                  EnumSet<LoggingOperations> operations,
                                  BlobListingDetails details,
                                  BlobRequestOptions options,
                                  OperationContext operationContext)
                                    throws StorageException,
                                           URISyntaxException
```
    Returns an enumerable collection of log blobs, retrieved lazily.
    
    Parameters:
    service - A StorageService enumeration value that indicates which storage service to use.
    startTime - A java.util.Date object representing the start of the time range for which logs should be retrieved.
    endTime - A java.util.Date object representing the end of the time range for which logs should be retrieved.
    operations - A LoggingOperations enumeration set that indicates which log types to return.
    details - A BlobListingDetails enumeration set that indicates whether or not blob metadata should be returned. None or METADATA are the only valid values.
    options - A BlobRequestOptions object that specifies additional options for the request.
    operationContext - An OperationContext object that represents the context for the current operation.
    
    Returns:
    An enumerable collection of objects that implement ListBlobItem and are retrieved lazily.
    
    Throws:
    
    StorageException
    
    URISyntaxException
  - listLogRecords
```
public Iterable<LogRecord> listLogRecords(StorageService service)
                                   throws URISyntaxException,
                                          StorageException
```
    Returns an enumerable collection of log records, retrieved lazily.
    
    Parameters:
    service - A StorageService enumeration value that indicates which storage service to use.
    
    Returns:
    An enumerable collection of objects that implement ListBlobItem and are retrieved lazily.
    
    Throws:
    
    URISyntaxException
    
    StorageException
  - listLogRecords
```
public Iterable<LogRecord> listLogRecords(StorageService service,
                                 Date startTime,
                                 Date endTime,
                                 BlobRequestOptions options,
                                 OperationContext operationContext)
                                   throws StorageException,
                                          URISyntaxException
```
    Returns an enumerable collection of log records, retrieved lazily.
    
    Parameters:
    service - A StorageService enumeration value that indicates which storage service to use.
    startTime - A java.util.Date object representing the start of the time range for which logs should be retrieved.
    endTime - A java.util.Date object representing the end of the time range for which logs should be retrieved.
    options - A BlobRequestOptions object that specifies additional options for the request.
    operationContext - An OperationContext object that represents the context for the current operation.
    
    Returns:
    An enumerable collection of objects that implement ListBlobItem and are retrieved lazily.
    
    Throws:
    
    StorageException
    
    URISyntaxException
  - parseLogBlobs
```
public static Iterable<LogRecord> parseLogBlobs(Iterable<ListBlobItem> logBlobs)
```
    Returns an enumerable collection of log records, retrieved lazily.
    
    Parameters:
    logBlobs - An Iterable of blobs to parse LogRecords from.
    
    Returns:
    An enumerable collection of objects that implement LogRecords and are retrieved lazily.
    
    Throws:
    
    StorageException
    
    URISyntaxException
  - parseLogBlob
```
public static Iterable<LogRecord> parseLogBlob(ListBlobItem logBlob)
```
    Returns an enumerable collection of log records, retrieved lazily.
    
    Parameters:
    logBlobs - An Iterable of blobs to parse LogRecords from.
    
    Returns:
    An enumerable collection of objects that implement LogRecords and are retrieved lazily.
    
    Throws:
    
    StorageException
    
    URISyntaxException

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class CloudAnalyticsClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CloudAnalyticsClient

Method Detail

getLogDirectory

getHourMetricsTable

getHourMetricsTable

getMinuteMetricsTable

getMinuteMetricsTable

getCapacityTable

listLogBlobs

listLogBlobs

listLogRecords

listLogRecords

parseLogBlobs

parseLogBlob