com.mulesoft.connector.googlepubsub.internal.operation

Class SnapshotOperations

java.lang.Object

com.mulesoft.connector.googlepubsub.internal.operation.SnapshotOperations

public class SnapshotOperations
extends Object

Constructor Summary

Constructors

Constructor and Description
SnapshotOperations()

Method Summary

Modifier and Type	Method and Description
Snapshot	createSnapshot(PubSubConfiguration config, PubSubConnection connection, SubscriptionIdentifier subscriptionIdentifier, String snapshotName, Map<String,String> labels, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper) Creates a snapshot from the requested subscription.
void	deleteSnapshot(PubSubConfiguration config, PubSubConnection connection, SnapshotIdentifier snapshotIdentifier) Deletes an existing snapshot
Snapshot	getSnapshot(PubSubConfiguration config, PubSubConnection connection, SnapshotIdentifier snapshotIdentifier) Retrieve a selected snapshot
org.mule.runtime.extension.api.runtime.streaming.PagingProvider<PubSubConnection,Snapshot>	getSnapshotList(PubSubConfiguration config, String projectId) Retrieve list of all the existing snapshots in selected project
Snapshot	patchSnapshot(PubSubConfiguration config, PubSubConnection connection, InputStream snapshot, String updateMask) Updates an existing snapshot.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnapshotOperations

public SnapshotOperations()

Method Detail

createSnapshot

@MediaType(value="application/java")
 @OutputResolver(output=SnapshotMetadataResolver.class)
 @Summary(value="Creates new snapshot on selected subscription")
 @Throws(value={CommonErrorTypeProvider.class,CreateOpErrorTypeProvider.class})
public Snapshot createSnapshot(@Config
                                                                                                                                                                                                                                                                             PubSubConfiguration config,
                                                                                                                                                                                                                                                                             @Connection
                                                                                                                                                                                                                                                                             PubSubConnection connection,
                                                                                                                                                                                                                                                                             @ParameterGroup(name="Subscription settings")
                                                                                                                                                                                                                                                                             SubscriptionIdentifier subscriptionIdentifier,
                                                                                                                                                                                                                                                                             String snapshotName,
                                                                                                                                                                                                                                                                             @Summary(value="key-value pairs used for easier resource filtering") @Optional @NullSafe @Content
                                                                                                                                                                                                                                                                             Map<String,String> labels,
                                                                                                                                                                                                                                                                             org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper)

Creates a snapshot from the requested subscription. Snapshots are used in seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Parameters:

config - configuration

connection - connection

subscriptionIdentifier - Resource name for subscription contains subscriptionName and projectId

snapshotName - A project-wide unique identifier for snapshot

labels - Labels are key-value pairs that help users to organize Google Cloud resources. Attaching labels to resources helps to filter them based on the labels.

streamingHelper - streaming helper

Returns:

created snapshot

patchSnapshot

@MediaType(value="application/java")
 @OutputResolver(output=SnapshotMetadataResolver.class)
 @Summary(value="Updates selected snapshot")
 @Throws(value=CommonErrorTypeProvider.class)
public Snapshot patchSnapshot(@Config
                                                                                                                                                                                                                      PubSubConfiguration config,
                                                                                                                                                                                                                      @Connection
                                                                                                                                                                                                                      PubSubConnection connection,
                                                                                                                                                                                                                      @Content
                                                                                                                                                                                                                      InputStream snapshot,
                                                                                                                                                                                                                      @Example(value="snapshot.expireTime, snapshot.labels")
                                                                                                                                                                                                                      String updateMask)
                                                                                                                                                                                                               throws IOException

Updates an existing snapshot.

Parameters:

config - configuration

connection - connection

snapshot - Snapshot object with updated fields.

updateMask - Indicates which fields in the provided snapshot to update. Must be specified and non-empty. This is a comma-separated list of fully qualified names of fields.

Returns:

updated snapshot

Throws:

IOException

deleteSnapshot

@Summary(value="Deletes selected snapshot")
 @Throws(value=CommonErrorTypeProvider.class)
public void deleteSnapshot(@Config
                                                                                                                     PubSubConfiguration config,
                                                                                                                     @Connection
                                                                                                                     PubSubConnection connection,
                                                                                                                     @ParameterGroup(name="Snapshot settings")
                                                                                                                     SnapshotIdentifier snapshotIdentifier)

Deletes an existing snapshot

Parameters:

config - configuration

connection - connection

snapshotIdentifier - A project-wide unique identifier for snapshot

getSnapshot

@MediaType(value="application/java")
 @Summary(value="Retrieve a selected snapshot")
 @OutputResolver(output=SnapshotMetadataResolver.class)
 @Throws(value=CommonErrorTypeProvider.class)
public Snapshot getSnapshot(@Config
                                                                                                                                                                                                                       PubSubConfiguration config,
                                                                                                                                                                                                                       @Connection
                                                                                                                                                                                                                       PubSubConnection connection,
                                                                                                                                                                                                                       @ParameterGroup(name="Snapshot settings")
                                                                                                                                                                                                                       SnapshotIdentifier snapshotIdentifier)

Retrieve a selected snapshot

Parameters:

config - configuration

connection - connection

snapshotIdentifier - A project-wide unique identifier for snapshot

Returns:

found snapshot

getSnapshotList

@MediaType(value="application/java")
 @Summary(value="Retrieve list of all the existing snapshots in selected project")
 @Throws(value=CommonErrorTypeProvider.class)
 @OutputResolver(output=SnapshotMetadataResolver.class)
public org.mule.runtime.extension.api.runtime.streaming.PagingProvider<PubSubConnection,Snapshot> getSnapshotList(@Config
                                                                                                                                                                                                                                                                                                                                                PubSubConfiguration config,
                                                                                                                                                                                                                                                                                                                                                @ConfigOverride
                                                                                                                                                                                                                                                                                                                                                String projectId)

Retrieve list of all the existing snapshots in selected project

Parameters:

config - configuration

projectId - A globally unique identifier for your project

Returns:

list of snapshots in the selected project