Sha256: b2ee8ceee700d98839a917f6a4c2da66199d946be1fc17e75c960d68a4c866d1

Contents?: true

Size: 1.74 KB

Versions: 3

Compression:

Stored size: 1.74 KB

Contents

# Athenian::CalculatedReleaseMetric

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_for** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. | [optional] |
| **with** | [**ReleaseWith**](ReleaseWith.md) |  | [optional] |
| **jira** | [**JIRAFilter**](JIRAFilter.md) |  | [optional] |
| **matches** | [**Hash<String, ReleaseMatchStrategy>**](ReleaseMatchStrategy.md) | Applied release matching strategies for the repositories in `for`. |  |
| **metrics** | [**Array<ReleaseMetricID>**](ReleaseMetricID.md) |  |  |
| **granularity** | **String** | How often the metrics are reported. The value must satisfy the following regular expression: /^all|(([1-9]\\d* )?(aligned )?(day|week|month|year))$/. \"all\" produces a single interval [`date_from`, `date_to`]. \"aligned week/month/year\" produces intervals cut by calendar week/month/year borders, for example, when `date_from` is `2020-01-15` and `date_to` is `2020-03-10`, the intervals will be `2020-01-15` - `2020-02-01` - `2020-03-01` - `2020-03-10`. |  |
| **values** | [**Array<CalculatedLinearMetricValues>**](CalculatedLinearMetricValues.md) | The sequence steps from `date_from` till `date_to` by `granularity`. |  |

## Example

```ruby
require 'athenian'

instance = Athenian::CalculatedReleaseMetric.new(
  _for: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
  with: null,
  jira: null,
  matches: null,
  metrics: null,
  granularity: 2 week,
  values: null
)
```

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
athenian-2.1.86 docs/CalculatedReleaseMetric.md
athenian-2.1.85 docs/CalculatedReleaseMetric.md
athenian-2.1.81 docs/CalculatedReleaseMetric.md