.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.13.2
+current_version = 0.14.0
 commit = True
 message = Update version {current_version} -> {new_version}
 

CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.14.0](https://github.com/IBM/platform-services-java-sdk/compare/0.13.2...0.14.0) (2020-10-31)
+
+
+### Features
+
+* **Usage Reports:** add service to project ([61e183a](https://github.com/IBM/platform-services-java-sdk/commit/61e183a13c65a3061068ac6ac8a69557cc54bae2))
+
 ## [0.13.2](https://github.com/IBM/platform-services-java-sdk/compare/0.13.1...0.13.2) (2020-10-30)
 
 

README.md

@@ -6,7 +6,7 @@
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 
-# IBM Cloud Platform Services Java SDK Version 0.13.2
+# IBM Cloud Platform Services Java SDK Version 0.14.0
 
 Java client library to interact with various 
 [IBM Cloud Platform Service APIs](https://cloud.ibm.com/docs?tab=api-docs&category=platform_services).
@@ -46,20 +46,21 @@ The IBM Cloud Platform Services Java SDK allows developers to programmatically i
 
 Service Name | Artifact Coordinates
 --- | --- 
-[Case Management](https://cloud.ibm.com/apidocs/case-management) | com.ibm.cloud:case-management:0.13.2
-[Catalog Management](https://cloud.ibm.com/apidocs/resource-catalog/private-catalog) | com.ibm.cloud:catalog-management:0.13.2
-[Configuration Governance](https://cloud.ibm.com/apidocs/security-compliance/config) | com.ibm.cloud:configuration-governance:0.13.2
-[Enterprise Management](https://cloud.ibm.com/apidocs/enterprise-apis/enterprise) | com.ibm.cloud:enterprise-management:0.13.2
-[Global Catalog](https://cloud.ibm.com/apidocs/resource-catalog/global-catalog) | com.ibm.cloud:global-catalog:0.13.2
-[Global Search](https://cloud.ibm.com/apidocs/search) | com.ibm.cloud:global-search:0.13.2
-[Global Tagging](https://cloud.ibm.com/apidocs/tagging) | com.ibm.cloud:global-tagging:0.13.2
-[IAM Access Groups](https://cloud.ibm.com/apidocs/iam-access-groups) | com.ibm.cloud:iam-access-groups:0.13.2
-[IAM Identity Service](https://cloud.ibm.com/apidocs/iam-identity-token-api) | com.ibm.cloud:iam-identity:0.13.2
-[IAM Policy Management](https://cloud.ibm.com/apidocs/iam-policy-management) | com.ibm.cloud:iam-policy-management:0.13.2
-[Open Service Broker](https://cloud.ibm.com/apidocs/resource-controller/ibm-cloud-osb-api) | com.ibm.cloud:open-service-broker:0.13.2
-[Resource Controller](https://cloud.ibm.com/apidocs/resource-controller/resource-controller) | com.ibm.cloud:resource-controller:0.13.2
-[Resource Manager](https://cloud.ibm.com/apidocs/resource-controller/resource-manager) | com.ibm.cloud:resource-manager:0.13.2
-[User Management](https://cloud.ibm.com/apidocs/user-management) | com.ibm.cloud:user-management:0.13.2
+[Case Management](https://cloud.ibm.com/apidocs/case-management) | com.ibm.cloud:case-management:0.14.0
+[Catalog Management](https://cloud.ibm.com/apidocs/resource-catalog/private-catalog) | com.ibm.cloud:catalog-management:0.14.0
+[Configuration Governance](https://cloud.ibm.com/apidocs/security-compliance/config) | com.ibm.cloud:configuration-governance:0.14.0
+[Enterprise Management](https://cloud.ibm.com/apidocs/enterprise-apis/enterprise) | com.ibm.cloud:enterprise-management:0.14.0
+[Global Catalog](https://cloud.ibm.com/apidocs/resource-catalog/global-catalog) | com.ibm.cloud:global-catalog:0.14.0
+[Global Search](https://cloud.ibm.com/apidocs/search) | com.ibm.cloud:global-search:0.14.0
+[Global Tagging](https://cloud.ibm.com/apidocs/tagging) | com.ibm.cloud:global-tagging:0.14.0
+[IAM Access Groups](https://cloud.ibm.com/apidocs/iam-access-groups) | com.ibm.cloud:iam-access-groups:0.14.0
+[IAM Identity Service](https://cloud.ibm.com/apidocs/iam-identity-token-api) | com.ibm.cloud:iam-identity:0.14.0
+[IAM Policy Management](https://cloud.ibm.com/apidocs/iam-policy-management) | com.ibm.cloud:iam-policy-management:0.14.0
+[Open Service Broker](https://cloud.ibm.com/apidocs/resource-controller/ibm-cloud-osb-api) | com.ibm.cloud:open-service-broker:0.14.0
+[Resource Controller](https://cloud.ibm.com/apidocs/resource-controller/resource-controller) | com.ibm.cloud:resource-controller:0.14.0
+[Resource Manager](https://cloud.ibm.com/apidocs/resource-controller/resource-manager) | com.ibm.cloud:resource-manager:0.14.0
+[Usage Reports](https://cloud.ibm.com/apidocs/metering-reporting) | com.ibm.cloud:usage-reports:0.14.0
+[User Management](https://cloud.ibm.com/apidocs/user-management) | com.ibm.cloud:user-management:0.14.0
 
 ## Prerequisites
 
@@ -70,7 +71,7 @@ Service Name | Artifact Coordinates
 * Java 8 or above.
 
 ## Installation
-The current version of this SDK is: 0.13.2
+The current version of this SDK is: 0.14.0
 
 Each service's artifact coordinates are listed in the table above.
 
@@ -92,13 +93,13 @@ artifact coordinates (group id, artifact id and version) for the service, like t
 <dependency>
     <groupId>com.ibm.cloud</groupId>
     <artifactId>case-management</artifactId>
-    <version>0.13.2</version>
+    <version>0.14.0</version>
 </dependency>
 ```
 
 ##### Gradle
 ```gradle
-'com.ibm.cloud:case-management:0.13.2'
+'com.ibm.cloud:case-management:0.14.0'
 ```
 
 ## Using the SDK

modules/coverage-reports/pom.xml

@@ -93,6 +93,11 @@
             <artifactId>resource-manager</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>usage-reports</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>user-management</artifactId>

modules/examples/pom.xml

@@ -38,6 +38,11 @@
             <artifactId>iam-identity</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>usage-reports</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency> 
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-jdk14</artifactId>

modules/examples/src/main/java/com/ibm/cloud/platform_services/usage_reports/v4/UsageReportsExamples.java

@@ -0,0 +1,199 @@
+/*
+ * (C) Copyright IBM Corp. 2020.
+ *
+ * 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.
+ */
+
+package com.ibm.cloud.platform_services.usage_reports.v4;
+
+import com.ibm.cloud.platform_services.usage_reports.v4.model.AccountSummary;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.AccountUsage;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.GetAccountSummaryOptions;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.GetAccountUsageOptions;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.GetOrgUsageOptions;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.GetResourceGroupUsageOptions;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.GetResourceUsageAccountOptions;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.GetResourceUsageOrgOptions;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.GetResourceUsageResourceGroupOptions;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.InstancesUsage;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.OrgUsage;
+import com.ibm.cloud.platform_services.usage_reports.v4.model.ResourceGroupUsage;
+import com.ibm.cloud.sdk.core.http.Response;
+import com.ibm.cloud.sdk.core.service.exception.ServiceResponseException;
+import com.ibm.cloud.sdk.core.util.CredentialUtils;
+import java.util.Map;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+//
+// This class provides an example of how to use the Usage Reports service.
+//
+// The following configuration properties are assumed to be defined:
+// USAGE_REPORTS_URL=<service url>
+// USAGE_REPORTS_AUTHTYPE=iam
+// USAGE_REPORTS_APIKEY=<IAM api key of user with authority to create rules>
+// USAGE_REPORTS_AUTH_URL=<IAM token service URL - omit this if using the production environment>
+// USAGE_REPORTS_ACCOUNT_ID=<the id of the account whose usage info will be retrieved>
+// USAGE_REPORTS_RESOURCE_GROUP_ID=<the id of the resource group whose usage info will be retrieved>
+// USAGE_REPORTS_ORG_ID=<the id of the organization whose usage info will be retrieved>
+// USAGE_REPORTS_BILLING_MONTH=<the billing month (yyyy-mm) for which usage info will be retrieved>
+//
+// These configuration properties can be exported as environment variables, or stored
+// in a "credentials" file and then:
+// export IBM_CREDENTIALS_FILE=<name of credentials file>
+//
+public class UsageReportsExamples {
+  private static final Logger logger = LoggerFactory.getLogger(UsageReportsExamples.class);
+  protected UsageReportsExamples() { }
+
+  private static String accountId;
+  private static String resourceGroupId;
+  private static String orgId;
+  private static String billingMonth;
+
+  static {
+      System.setProperty("IBM_CREDENTIALS_FILE", "../../usage_reports.env");
+  }
+
+  @SuppressWarnings("checkstyle:methodlength")
+  public static void main(String[] args) throws Exception {
+    UsageReports service = UsageReports.newInstance();
+
+    // Load up our test-specific config properties.
+    Map<String, String> config = CredentialUtils.getServiceProperties(UsageReports.DEFAULT_SERVICE_NAME);
+    accountId = config.get("ACCOUNT_ID");
+    resourceGroupId = config.get("RESOURCE_GROUP_ID");
+    orgId = config.get("ORG_ID");
+    billingMonth = config.get("BILLING_MONTH");
+
+    try {
+      // begin-get_account_summary
+      GetAccountSummaryOptions getAccountSummaryOptions = new GetAccountSummaryOptions.Builder()
+        .accountId(accountId)
+        .billingmonth(billingMonth)
+        .build();
+
+      Response<AccountSummary> response = service.getAccountSummary(getAccountSummaryOptions).execute();
+      AccountSummary accountSummary = response.getResult();
+
+      System.out.println("getAccountSummary() result:\n" + accountSummary.toString());
+      // end-get_account_summary
+    } catch (ServiceResponseException e) {
+        logger.error(String.format("Service returned status code %s: %s\nError details: %s",
+          e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
+    }
+
+    try {
+      // begin-get_account_usage
+      GetAccountUsageOptions getAccountUsageOptions = new GetAccountUsageOptions.Builder()
+        .accountId(accountId)
+        .billingmonth(billingMonth)
+        .build();
+
+      Response<AccountUsage> response = service.getAccountUsage(getAccountUsageOptions).execute();
+      AccountUsage accountUsage = response.getResult();
+
+      System.out.println("getAccountUsage() result:\n" + accountUsage.toString());
+      // end-get_account_usage
+    } catch (ServiceResponseException e) {
+        logger.error(String.format("Service returned status code %s: %s\nError details: %s",
+          e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
+    }
+
+    try {
+      // begin-get_resource_group_usage
+      GetResourceGroupUsageOptions getResourceGroupUsageOptions = new GetResourceGroupUsageOptions.Builder()
+        .accountId(accountId)
+        .resourceGroupId(resourceGroupId)
+        .billingmonth(billingMonth)
+        .build();
+
+      Response<ResourceGroupUsage> response = service.getResourceGroupUsage(getResourceGroupUsageOptions).execute();
+      ResourceGroupUsage resourceGroupUsage = response.getResult();
+
+      System.out.println("getResourceGroupUsage() result:\n" + resourceGroupUsage.toString());
+      // end-get_resource_group_usage
+    } catch (ServiceResponseException e) {
+        logger.error(String.format("Service returned status code %s: %s\nError details: %s",
+          e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
+    }
+
+    try {
+      // begin-get_org_usage
+      GetOrgUsageOptions getOrgUsageOptions = new GetOrgUsageOptions.Builder()
+        .accountId(accountId)
+        .organizationId(orgId)
+        .billingmonth(billingMonth)
+        .build();
+
+      Response<OrgUsage> response = service.getOrgUsage(getOrgUsageOptions).execute();
+      OrgUsage orgUsage = response.getResult();
+
+      System.out.println("getOrgUsage() result:\n" + orgUsage.toString());
+      // end-get_org_usage
+    } catch (ServiceResponseException e) {
+        logger.error(String.format("Service returned status code %s: %s\nError details: %s",
+          e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
+    }
+
+    try {
+      // begin-get_resource_usage_account
+      GetResourceUsageAccountOptions getResourceUsageAccountOptions = new GetResourceUsageAccountOptions.Builder()
+        .accountId(accountId)
+        .billingmonth(billingMonth)
+        .build();
+
+      Response<InstancesUsage> response = service.getResourceUsageAccount(getResourceUsageAccountOptions).execute();
+      InstancesUsage instancesUsage = response.getResult();
+
+      System.out.println("getResourceUsageAccount() result:\n" + instancesUsage.toString());
+      // end-get_resource_usage_account
+    } catch (ServiceResponseException e) {
+        logger.error(String.format("Service returned status code %s: %s\nError details: %s",
+          e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
+    }
+
+    try {
+      // begin-get_resource_usage_resource_group
+      GetResourceUsageResourceGroupOptions getResourceUsageResourceGroupOptions = new GetResourceUsageResourceGroupOptions.Builder()
+        .accountId(accountId)
+        .resourceGroupId(resourceGroupId)
+        .billingmonth(billingMonth)
+        .build();
+
+      Response<InstancesUsage> response = service.getResourceUsageResourceGroup(getResourceUsageResourceGroupOptions).execute();
+      InstancesUsage instancesUsage = response.getResult();
+
+      System.out.println("getResourceUsageResourceGroup() result:\n" + instancesUsage.toString());
+      // end-get_resource_usage_resource_group
+    } catch (ServiceResponseException e) {
+        logger.error(String.format("Service returned status code %s: %s\nError details: %s",
+          e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
+    }
+
+    try {
+      // begin-get_resource_usage_org
+      GetResourceUsageOrgOptions getResourceUsageOrgOptions = new GetResourceUsageOrgOptions.Builder()
+        .accountId(accountId)
+        .organizationId(orgId)
+        .billingmonth(billingMonth)
+        .build();
+
+      Response<InstancesUsage> response = service.getResourceUsageOrg(getResourceUsageOrgOptions).execute();
+      InstancesUsage instancesUsage = response.getResult();
+
+      System.out.println("getResourceUsageOrg() result:\n" + instancesUsage.toString());
+      // end-get_resource_usage_org
+    } catch (ServiceResponseException e) {
+        logger.error(String.format("Service returned status code %s: %s\nError details: %s",
+          e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
+    }
+  }
+}

modules/usage-reports/pom.xml

@@ -0,0 +1,68 @@
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+	<!-- >>> Replace this with the parent pom's artifactId -->
+        <artifactId>platform-services</artifactId>
+        <groupId>com.ibm.cloud</groupId>
+        <version>99-SNAPSHOT</version>
+        <relativePath>../..</relativePath>
+    </parent>
+
+    <!-- >>> Replace this with the service module's artifactId (e.g. "example-service") -->
+    <artifactId>usage-reports</artifactId>
+
+    <!-- >>> Replace this with a text description of this module (e.g. "Example Service") -->
+    <name>IBM Cloud Usage Reports API</name>
+    <packaging>jar</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.ibm.cloud</groupId>
+            <artifactId>sdk-core</artifactId>
+        </dependency>
+        <dependency>
+            <!-- >>> Replace this with the "common" module's artifactId (e.g. my-services-common) -->
+            <artifactId>platform-services-common</artifactId>
+            <groupId>com.ibm.cloud</groupId>
+        </dependency>
+        <dependency>
+            <!-- >>> Replace this with the "common" module's artifactId (e.g. my-services-common) -->
+            <artifactId>platform-services-common</artifactId>
+            <groupId>${project.groupId}</groupId>
+            <type>test-jar</type>
+            <classifier>tests</classifier>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.testng</groupId>
+            <artifactId>testng</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.squareup.okhttp3</groupId>
+            <artifactId>mockwebserver</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.powermock</groupId>
+            <artifactId>powermock-api-mockito2</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.powermock</groupId>
+            <artifactId>powermock-module-testng</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <developers>
+        <developer>
+            <name>IBM Cloud DevX SDK Development</name>
+            <email>devxsdk@us.ibm.com</email>
+            <url>https://www.ibm.com/</url>
+        </developer>
+    </developers>
+
+</project>