com.microsoft.azure.functions.annotation.ServiceBusTopicOutput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-functions-java-library Show documentation

This package contains all Java interfaces and annotations to interact with Microsoft Azure functions runtime.

There is a newer version: 3.1.0

Show newest version

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */

package com.microsoft.azure.functions.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 
 * Place this on a parameter whose value would be written to a service bus topic. The parameter type
 * should be OutputBinding<T>, where T could be one of:
 * 
 *
 * 
 * Any native Java types such as int, String, byte[]
 * Any POJO type
 * 
 *
 *
 * @since 1.0.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.PARAMETER, ElementType.METHOD })
public @interface ServiceBusTopicOutput {
  /**
   * The variable name used in function.json.
   * 
   * @return The variable name used in function.json.
   */
  String name();

  /**
   * 
   * Defines how Functions runtime should treat the parameter value. Possible values are:
   * 
   * 
   * "" or string: treat it as a string whose value is serialized from the parameter
   * binary: treat it as a binary data whose value comes from for example
   * OutputBinding<byte[]>
   * 
   * 
   * @return The dataType which will be used by the Functions runtime.
   */
  String dataType() default "";

  /**
   * Defines the name of the Service Bus topic to which to write.
   * 
   * @return The Service Bus topic name string.
   */
  String topicName();

  /**
   * Defines the subscription name of the Service Bus topic to which to write.
   * 
   * @return The Service Bus topic subscription name string.
   */
  String subscriptionName();

  /**
   * Defines the app setting name that contains the Service Bus connection string.
   * 
   * @return The app setting name of the connection string.
   */
  String connection();

  /**
   * Defines the permission of the Service Bus topic to which to write.
   * 
   * @return The Service Bus topic permission.
   */
  AccessRights access() default AccessRights.MANAGE;
}