ServiceProperties.Metrics (Microsoft Azure SDK for Media Services 0.9.8 API)

java.lang.Object
- com.microsoft.windowsazure.services.queue.models.ServiceProperties.Metrics

Enclosing class:

ServiceProperties
```
public static class ServiceProperties.Metrics
extends Object
```
This inner class represents the settings for metrics on the Queue service of the storage account. These settings include the Storage Analytics version, whether metrics are enabled, whether to include API operation summary statistics, and a ServiceProperties.RetentionPolicy instance for retention policy settings.

Constructor Summary

Constructors
Constructor and Description

Metrics()

Constructors
Constructor and Description
`Metrics()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceProperties.RetentionPolicy`	`getRetentionPolicy()` Gets a reference to the `ServiceProperties.RetentionPolicy` instance in this `ServiceProperties.Metrics` instance.
`String`	`getVersion()` Gets the Storage Analytics version number associated with this `ServiceProperties.Metrics` instance.
`boolean`	`isEnabled()` Gets a flag indicating whether metrics is enabled for the Queue storage service.
`Boolean`	`isIncludeAPIs()` Gets a flag indicating whether metrics should generate summary statistics for called API operations.
`ServiceProperties.Metrics`	`setEnabled(boolean enabled)` Sets a flag indicating whether to enable metrics for the Queue storage service.
`ServiceProperties.Metrics`	`setIncludeAPIs(Boolean includeAPIs)` Sets a flag indicating whether metrics should generate summary statistics for called API operations.
`ServiceProperties.Metrics`	`setRetentionPolicy(ServiceProperties.RetentionPolicy retentionPolicy)` Sets the `ServiceProperties.RetentionPolicy` instance in this `ServiceProperties.Metrics` instance.
`ServiceProperties.Metrics`	`setVersion(String version)` Sets the Storage Analytics version number to associate with this `ServiceProperties.Metrics` instance.

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

- Constructor Detail
  - Metrics
```
public Metrics()
```
- Method Detail
  - getRetentionPolicy
```
public ServiceProperties.RetentionPolicy getRetentionPolicy()
```
    Gets a reference to the ServiceProperties.RetentionPolicy instance in this ServiceProperties.Metrics instance.
    
    Returns:
    
    A reference to the ServiceProperties.RetentionPolicy instance in this ServiceProperties.Metrics instance.
  - setRetentionPolicy
```
public ServiceProperties.Metrics setRetentionPolicy(ServiceProperties.RetentionPolicy retentionPolicy)
```
    Sets the ServiceProperties.RetentionPolicy instance in this ServiceProperties.Metrics instance.
    
    Parameters:
    
    retentionPolicy - The ServiceProperties.RetentionPolicy instance to set in this ServiceProperties.Metrics instance.
    
    Returns:
    
    A reference to this ServiceProperties.Metrics instance.
  - isIncludeAPIs
```
public Boolean isIncludeAPIs()
```
    Gets a flag indicating whether metrics should generate summary statistics for called API operations. If this value is true then all Queue service REST API operations will be included in the metrics.
    
    Returns:
    
    true if Queue service REST API operations are included in metrics, otherwise false.
  - setIncludeAPIs
```
public ServiceProperties.Metrics setIncludeAPIs(Boolean includeAPIs)
```
    Sets a flag indicating whether metrics should generate summary statistics for called API operations. If this value is true then all Queue service REST API operations will be included in the metrics.
    
    Parameters:
    
    includeAPIs - true to include Queue service REST API operations in metrics, otherwise false.
    
    Returns:
    
    A reference to this ServiceProperties.Metrics instance.
  - isEnabled
```
public boolean isEnabled()
```
    Gets a flag indicating whether metrics is enabled for the Queue storage service.
    
    Returns:
    
    A flag indicating whether metrics is enabled for the Queue storage service.
  - setEnabled
```
public ServiceProperties.Metrics setEnabled(boolean enabled)
```
    Sets a flag indicating whether to enable metrics for the Queue storage service.
    
    Parameters:
    
    enabled - true to enable metrics for the Queue storage service, otherwise false.
    
    Returns:
    
    A reference to this ServiceProperties.Metrics instance.
  - getVersion
```
public String getVersion()
```
    Gets the Storage Analytics version number associated with this ServiceProperties.Metrics instance.
    
    Returns:
    
    A String containing the Storage Analytics version number.
  - setVersion
```
public ServiceProperties.Metrics setVersion(String version)
```
    Sets the Storage Analytics version number to associate with this ServiceProperties.Metrics instance. The current supported version number is "1.0".
    See the Storage Analytics Overview documentation on MSDN for more information.
    
    Parameters:
    
    version - A String containing the Storage Analytics version number to set.
    
    Returns:
    
    A reference to this ServiceProperties.Metrics instance.

/** 
* 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 ServiceProperties.Metrics

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Metrics

Method Detail

getRetentionPolicy

setRetentionPolicy

isIncludeAPIs

setIncludeAPIs

isEnabled

setEnabled

getVersion

setVersion