com.hubspot.mesos.rx.java.protobuf.package-info Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mesos-rxjava-protobuf-client Show documentation
The newest version!
/*
 *    Copyright (C) 2016 Mesosphere, Inc
 *
 * 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.
 */

/**
 * This package provides a builder and corresponding {@link com.hubspot.mesos.rx.java.util.MessageCodec MessageCodec}s
 * necessary to create a client (using protobuf) to interact with an
 * {@link rx.Observable} of {@link org.apache.mesos.v1.scheduler.Protos.Event} coming from Apache Mesos.
 *
 * The following is a full Apache Mesos Framework that declines all resource offers:
 * {@code
 * import static org.apache.mesos.v1.Protos.*;
 * import static org.apache.mesos.v1.scheduler.Protos.*;
 *
 * final Protos.FrameworkID fwId = FrameworkID.newBuilder().setValue(UUID.randomUUID().toString()).build();
 * com.hubspot.mesos.rx.java.ProtobufMesosClientBuilder.schedulerUsingProtos()
 *     .mesosUri(URI.create("http://localhost:5050/api/v1/scheduler"))
 *     .applicationUserAgentEntry(UserAgentEntries.literal("decline-framework", "0.1.0-SNAPSHOT"))
 *     .subscribe(
 *         Call.newBuilder()
 *             .setFrameworkId(fwId)
 *             .setType(Call.Type.SUBSCRIBE)
 *             .setSubscribe(
 *                 Call.Subscribe.newBuilder()
 *                     .setFrameworkInfo(
 *                         Protos.FrameworkInfo.newBuilder()
 *                             .setId(fwId)
 *                             .setUser("root")
 *                             .setName("decline-framework")
 *                             .setFailoverTimeout(0)
 *                     )
 *             )
 *             .build()
 *     )
 *     .processStream(es ->
 *         es.filter(event -> event.getType() == Event.Type.OFFERS)
 *         .flatMap(event -> Observable.from(event.getOffers().getOffersList()))
 *         .map(offer ->
 *             Call.newBuilder()
 *                 .setFrameworkId(fwId)
 *                 .setType(Call.Type.DECLINE)
 *                 .setDecline(
 *                     Call.Decline.newBuilder()
 *                         .addOfferIds(offer.getId())
 *                 )
 *                 .build()
 *         )
 *         .map(SinkOperations::create)
 *         .map(Optional::of)
 *     )
 *     .build()
 *     .openStream()
 *     .await();
 * }
 */
package com.hubspot.mesos.rx.java.protobuf;