Merge pull request fabric8io#2420 from rohanKanojia/pr/add-javadoc-fo…

…r-extensions
rohanKanojia · Aug 21, 2020 · 68c3e88 · 68c3e88
2 parents b3b6517 + 10c3f02
commit 68c3e88
Show file tree

Hide file tree

Showing 6 changed files with 237 additions and 15 deletions.
diff --git a/extensions/knative/client/src/main/java/io/fabric8/knative/client/KnativeClient.java b/extensions/knative/client/src/main/java/io/fabric8/knative/client/KnativeClient.java
@@ -52,23 +52,84 @@
 import io.fabric8.kubernetes.client.dsl.MixedOperation;
 import io.fabric8.kubernetes.client.dsl.Resource;
 
+/**
+ * Main interface for Knative Client.
+ */
 public interface KnativeClient extends Client {
 
-    // Serving
+  // Serving
+  /**
+   * API entrypoint for Service(serving.knative.dev/v1)
+   *
+   * @return MixedOperation for Service class
+   */
   MixedOperation<Service, ServiceList, DoneableService, Resource<Service, DoneableService>> services();
+
+  /**
+   * API entrypoint for Route(serving.knative.dev/v1)
+   *
+   * @return MixedOperation for Route class
+   */
   MixedOperation<Route, RouteList, DoneableRoute, Resource<Route, DoneableRoute>> routes();
+
+  /**
+   * API entrypoint for Revision(serving.knative.dev/v1)
+   *
+   * @return MixedOperation for Revision class
+   */
   MixedOperation<Revision, RevisionList, DoneableRevision, Resource<Revision, DoneableRevision>> revisions();
+
+  /**
+   * API entrypoint for Configuration(serving.knative.dev/v1)
+   *
+   * @return MixedOperation for Configuration class
+   */
   MixedOperation<Configuration, ConfigurationList, DoneableConfiguration, Resource<Configuration, DoneableConfiguration>> configurations();
 
 
-    //Eventing
+  //Eventing
+  /**
+   * API entrypoint for Broker(eventing.knative.dev/v1alpha1)
+   *
+   * @return MixedOperation for Broker class
+   */
   MixedOperation<Broker, BrokerList, DoneableBroker, Resource<Broker, DoneableBroker>> brokers();
+  /**
+   * API entrypoint for Trigger(eventing.knative.dev/v1alpha1)
+   *
+   * @return MixedOperation for Trigger class
+   */
   MixedOperation<Trigger, TriggerList, DoneableTrigger, Resource<Trigger, DoneableTrigger>> triggers();
-  MixedOperation<Channel, ChannelList, DoneableChannel, Resource<Channel, DoneableChannel>> channels();
-  MixedOperation<Subscription, SubscriptionList, DoneableSubscription, Resource<Subscription, DoneableSubscription>> subscriptions();
+  /**
+   * API entrypoint for EventType(eventing.knative.dev/v1alpha1)
+   *
+   * @return MixedOperation for EventType class
+   */
   MixedOperation<EventType, EventTypeList, DoneableEventType, Resource<EventType, DoneableEventType>> eventTypes();
 
-    //Messaging
+  //Messaging
+  /**
+   * API entrypoint for Channel(messaging.knative.dev/v1alpha1)
+   *
+   * @return MixedOperation for Channel class
+   */
+  MixedOperation<Channel, ChannelList, DoneableChannel, Resource<Channel, DoneableChannel>> channels();
+  /**
+   * API entrypoint for Subscription(messaging.knative.dev/v1alpha1)
+   *
+   * @return MixedOperation for Subscription class
+   */
+  MixedOperation<Subscription, SubscriptionList, DoneableSubscription, Resource<Subscription, DoneableSubscription>> subscriptions();
+  /**
+   * API entrypoint for Sequence(messaging.knative.dev/v1alpha1)
+   *
+   * @return MixedOperation for Sequence class
+   */
   MixedOperation<Sequence, SequenceList, DoneableSequence, Resource<Sequence, DoneableSequence>> sequences();
+  /**
+   * API entrypoint for InMemoryChannel(messaging.knative.dev/v1alpha1)
+   *
+   * @return MixedOperation for InMemoryChannel class
+   */
   MixedOperation<InMemoryChannel, InMemoryChannelList, DoneableInMemoryChannel, Resource<InMemoryChannel, DoneableInMemoryChannel>> inMemoryChannels();
 }
diff --git a/...e-catalog/client/src/main/java/io/fabric8/servicecatalog/client/ServiceCatalogClient.java b/...e-catalog/client/src/main/java/io/fabric8/servicecatalog/client/ServiceCatalogClient.java
@@ -20,6 +20,12 @@
 import io.fabric8.kubernetes.client.dsl.MixedOperation;
 import io.fabric8.kubernetes.client.dsl.NonNamespaceOperation;
 import io.fabric8.kubernetes.client.dsl.Resource;
+import io.fabric8.servicecatalog.api.model.ClusterServiceBroker;
+import io.fabric8.servicecatalog.api.model.ClusterServiceBrokerList;
+import io.fabric8.servicecatalog.api.model.ClusterServiceClass;
+import io.fabric8.servicecatalog.api.model.ClusterServiceClassList;
+import io.fabric8.servicecatalog.api.model.ClusterServicePlan;
+import io.fabric8.servicecatalog.api.model.ClusterServicePlanList;
 import io.fabric8.servicecatalog.api.model.DoneableClusterServiceBroker;
 import io.fabric8.servicecatalog.api.model.DoneableClusterServiceClass;
 import io.fabric8.servicecatalog.api.model.DoneableClusterServicePlan;
@@ -28,25 +34,81 @@
 import io.fabric8.servicecatalog.api.model.DoneableServiceClass;
 import io.fabric8.servicecatalog.api.model.DoneableServiceInstance;
 import io.fabric8.servicecatalog.api.model.DoneableServicePlan;
-import io.fabric8.servicecatalog.client.internal.*;
-import io.fabric8.servicecatalog.api.model.*;
+import io.fabric8.servicecatalog.api.model.ServiceBinding;
+import io.fabric8.servicecatalog.api.model.ServiceBindingList;
+import io.fabric8.servicecatalog.api.model.ServiceBroker;
+import io.fabric8.servicecatalog.api.model.ServiceBrokerList;
+import io.fabric8.servicecatalog.api.model.ServiceClass;
+import io.fabric8.servicecatalog.api.model.ServiceClassList;
+import io.fabric8.servicecatalog.api.model.ServiceInstance;
+import io.fabric8.servicecatalog.api.model.ServiceInstanceList;
+import io.fabric8.servicecatalog.api.model.ServicePlan;
+import io.fabric8.servicecatalog.api.model.ServicePlanList;
+import io.fabric8.servicecatalog.client.internal.ClusterServiceBrokerResource;
+import io.fabric8.servicecatalog.client.internal.ClusterServiceClassResource;
+import io.fabric8.servicecatalog.client.internal.ClusterServicePlanResource;
+import io.fabric8.servicecatalog.client.internal.ServiceBindingResource;
+import io.fabric8.servicecatalog.client.internal.ServiceInstanceResource;
 
+/**
+ * Main interface for Service Catalog Client.
+ */
 public interface ServiceCatalogClient extends Client {
 
-    NonNamespaceOperation<ClusterServiceBroker, ClusterServiceBrokerList, DoneableClusterServiceBroker, ClusterServiceBrokerResource> clusterServiceBrokers();
+  /**
+   * API entrypoint for ClusterServiceBroker(servicecatalog.k8s.io/v1beta1)
+   *
+   * @return NonNamespaceOperation for ClusterServiceBroker class
+   */
+  NonNamespaceOperation<ClusterServiceBroker, ClusterServiceBrokerList, DoneableClusterServiceBroker, ClusterServiceBrokerResource> clusterServiceBrokers();
 
-    NonNamespaceOperation<ClusterServiceClass, ClusterServiceClassList, DoneableClusterServiceClass, ClusterServiceClassResource> clusterServiceClasses();
+  /**
+   * API entrypoint for ClusterServiceClass(servicecatalog.k8s.io/v1beta1)
+   *
+   * @return NonNamespaceOperation for ClusterServiceClass class
+   */
+  NonNamespaceOperation<ClusterServiceClass, ClusterServiceClassList, DoneableClusterServiceClass, ClusterServiceClassResource> clusterServiceClasses();
 
-    NonNamespaceOperation<ClusterServicePlan, ClusterServicePlanList, DoneableClusterServicePlan, ClusterServicePlanResource> clusterServicePlans();
+  /**
+   * API entrypoint for ClusterServicePlan(servicecatalog.k8s.io/v1beta1)
+   *
+   * @return NonNamespaceOperation for ClusterServicePlan class
+   */
+  NonNamespaceOperation<ClusterServicePlan, ClusterServicePlanList, DoneableClusterServicePlan, ClusterServicePlanResource> clusterServicePlans();
 
-    MixedOperation<ServiceInstance, ServiceInstanceList, DoneableServiceInstance, ServiceInstanceResource> serviceInstances();
+  /**
+   * API entrypoint for ServiceInstance(servicecatalog.k8s.io/v1beta1)
+   *
+   * @return MixedOperation for ServiceInstance class
+   */
+  MixedOperation<ServiceInstance, ServiceInstanceList, DoneableServiceInstance, ServiceInstanceResource> serviceInstances();
 
-    MixedOperation<ServiceBinding, ServiceBindingList, DoneableServiceBinding, ServiceBindingResource> serviceBindings();
+  /**
+   * API entrypoint for ServiceBinding(servicecatalog.k8s.io/v1beta1)
+   *
+   * @return MixedOperation for ServiceBinding class
+   */
+  MixedOperation<ServiceBinding, ServiceBindingList, DoneableServiceBinding, ServiceBindingResource> serviceBindings();
 
-    MixedOperation<ServiceBroker, ServiceBrokerList, DoneableServiceBroker, Resource<ServiceBroker, DoneableServiceBroker>> serviceBrokers();
+  /**
+   * API entrypoint for ServiceBroker(servicecatalog.k8s.io/v1beta1)
+   *
+   * @return MixedOperation for ServiceBroker class
+   */
+  MixedOperation<ServiceBroker, ServiceBrokerList, DoneableServiceBroker, Resource<ServiceBroker, DoneableServiceBroker>> serviceBrokers();
 
-    MixedOperation<ServiceClass, ServiceClassList, DoneableServiceClass, Resource<ServiceClass, DoneableServiceClass>> serviceClasses();
+  /**
+   * API entrypoint for ServiceClass(servicecatalog.k8s.io/v1beta1)
+   *
+   * @return MixedOperation for ServiceClass class
+   */
+  MixedOperation<ServiceClass, ServiceClassList, DoneableServiceClass, Resource<ServiceClass, DoneableServiceClass>> serviceClasses();
 
-    MixedOperation<ServicePlan, ServicePlanList, DoneableServicePlan, Resource<ServicePlan, DoneableServicePlan>> servicePlans();
+  /**
+   * API entrypoint for ServicePlan(servicecatalog.k8s.io/v1beta1)
+   *
+   * @return MixedOperation for ServicePlan class
+   */
+  MixedOperation<ServicePlan, ServicePlanList, DoneableServicePlan, Resource<ServicePlan, DoneableServicePlan>> servicePlans();
 
 }
diff --git a/extensions/tekton/client/src/main/java/io/fabric8/tekton/client/TektonClient.java b/extensions/tekton/client/src/main/java/io/fabric8/tekton/client/TektonClient.java
@@ -19,7 +19,20 @@
 import io.fabric8.tekton.client.dsl.V1alpha1APIGroupDSL;
 import io.fabric8.tekton.client.dsl.V1beta1APIGroupDSL;
 
+/**
+ * Main interface for Tekton client library.
+ */
 public interface TektonClient extends Client {
+  /**
+   * API entrypoint for tekton.dev/v1beta1 API group resources
+   *
+   * @return {@link V1beta1APIGroupDSL} for Tekton resource operations in this API group.
+   */
   V1beta1APIGroupDSL v1beta1();
+
+  /**
+   * API entrypoint for tekton.dev/v1alpha1 API group resources
+   * @return {@link V1alpha1APIGroupDSL} for Tekton resource operations in this API group.
+   */
   V1alpha1APIGroupDSL v1alpha1();
 }
diff --git a/extensions/tekton/client/src/main/java/io/fabric8/tekton/client/dsl/V1alpha1APIGroupDSL.java b/extensions/tekton/client/src/main/java/io/fabric8/tekton/client/dsl/V1alpha1APIGroupDSL.java
@@ -42,12 +42,52 @@
 import io.fabric8.tekton.resource.v1alpha1.PipelineResourceList;
 
 public interface V1alpha1APIGroupDSL extends Client {
+  /**
+   * API entrypoint for Pipeline(tekton.dev/v1alpha1)
+   *
+   * @return MixedOperation for Pipeline class
+   */
   MixedOperation<Pipeline, PipelineList, DoneablePipeline, Resource<Pipeline, DoneablePipeline>> pipelines();
+
+  /**
+   * API entrypoint for PipelineRun(tekton.dev/v1alpha1)
+   *
+   * @return MixedOperation for PipelineRun class
+   */
   MixedOperation<PipelineRun, PipelineRunList, DoneablePipelineRun, Resource<PipelineRun, DoneablePipelineRun>> pipelineRuns();
+
+  /**
+   * API entrypoint for PipelineResource(tekton.dev/v1alpha1)
+   *
+   * @return MixedOperation for PipelineResource class
+   */
   MixedOperation<PipelineResource, PipelineResourceList, DoneablePipelineResource, Resource<PipelineResource, DoneablePipelineResource>> pipelineResources();
+
+  /**
+   * API entrypoint for Task(tekton.dev/v1alpha1)
+   *
+   * @return MixedOperation for Task class
+   */
   MixedOperation<Task, TaskList, DoneableTask, Resource<Task, DoneableTask>> tasks();
+
+  /**
+   * API entrypoint for TaskRun(tekton.dev/v1alpha1)
+   *
+   * @return MixedOperation for TaskRun class
+   */
   MixedOperation<TaskRun, TaskRunList, DoneableTaskRun, Resource<TaskRun, DoneableTaskRun>> taskRuns();
+
+  /**
+   * API entrypoint for Condition(tekton.dev/v1alpha1)
+   *
+   * @return MixedOperation for Condition class
+   */
   MixedOperation<Condition, ConditionList, DoneableCondition, Resource<Condition, DoneableCondition>> conditions();
 
+  /**
+   * API entrypoint for ClusterTask(tekton.dev/v1alpha1)
+   *
+   * @return MixedOperation for ClusterTask class
+   */
   NonNamespaceOperation<ClusterTask, ClusterTaskList, DoneableClusterTask, Resource<ClusterTask, DoneableClusterTask>> clusterTasks();
 }
diff --git a/extensions/tekton/client/src/main/java/io/fabric8/tekton/client/dsl/V1beta1APIGroupDSL.java b/extensions/tekton/client/src/main/java/io/fabric8/tekton/client/dsl/V1beta1APIGroupDSL.java
@@ -36,11 +36,39 @@
 import io.fabric8.tekton.pipeline.v1beta1.TaskRunList;
 
 public interface V1beta1APIGroupDSL extends Client {
+  /**
+   * API entrypoint for Pipeline(tekton.dev/v1beta1)
+   *
+   * @return MixedOperation for Pipeline class
+   */
   MixedOperation<Pipeline, PipelineList, DoneablePipeline, Resource<Pipeline, DoneablePipeline>> pipelines();
+
+  /**
+   * API entrypoint for PipelineRun(tekton.dev/v1beta1)
+   *
+   * @return MixedOperation for PipelineRun class
+   */
   MixedOperation<PipelineRun, PipelineRunList, DoneablePipelineRun, Resource<PipelineRun, DoneablePipelineRun>> pipelineRuns();
+
+  /**
+   * API entrypoint for Task(tekton.dev/v1beta1)
+   *
+   * @return MixedOperation for Task class
+   */
   MixedOperation<Task, TaskList, DoneableTask, Resource<Task, DoneableTask>> tasks();
+
+  /**
+   * API entrypoint for TaskRun(tekton.dev/v1beta1)
+   *
+   * @return MixedOperation for TaskRun class
+   */
   MixedOperation<TaskRun, TaskRunList, DoneableTaskRun, Resource<TaskRun, DoneableTaskRun>> taskRuns();
 
+  /**
+   * API entrypoint for ClusterTask(tekton.dev/v1beta1)
+   *
+   * @return MixedOperation for ClusterTask class
+   */
   NonNamespaceOperation<ClusterTask, ClusterTaskList, DoneableClusterTask, Resource<ClusterTask, DoneableClusterTask>> clusterTasks();
 
 }
diff --git a/...esnapshot/client/src/main/java/io/fabric8/volumesnapshot/client/VolumeSnapshotClient.java b/...esnapshot/client/src/main/java/io/fabric8/volumesnapshot/client/VolumeSnapshotClient.java
@@ -32,11 +32,29 @@
 import io.fabric8.volumesnapshot.client.internal.VolumeSnapshotContentResource;
 import io.fabric8.volumesnapshot.client.internal.VolumeSnapshotResource;
 
+/**
+ * Main interface for VolumeSnapshot Client library.
+ */
 public interface VolumeSnapshotClient extends Client {
 
+  /**
+   * API entrypoint for dealing with VolumeSnapshotClass(snapshot.storage.k8s.io/v1beta1)
+   *
+   * @return NonNamespaceOperation for VolumeSnapshotClass class
+   */
   NonNamespaceOperation<VolumeSnapshotClass, VolumeSnapshotClassList, DoneableVolumeSnapshotClass, VolumeSnapshotClassResource> volumeSnapshotClasses();
 
+  /**
+   * API entrypoint for dealing with VolumeSnapshotContent(snapshot.storage.k8s.io/v1beta1)
+   *
+   * @return NonNamespaceOperation for VolumeSnapshotContent class
+   */
   NonNamespaceOperation<VolumeSnapshotContent, VolumeSnapshotContentList, DoneableVolumeSnapshotContent, VolumeSnapshotContentResource> volumeSnapshotContents();
 
+  /**
+   * API entrypoint for dealing with VolumeSnapshot(snapshot.storage.k8s.io/v1beta1)
+   *
+   * @return MixedOperation for VolumeSnapshot class
+   */
   MixedOperation<VolumeSnapshot, VolumeSnapshotList, DoneableVolumeSnapshot, VolumeSnapshotResource> volumeSnapshots();
 }