azure-docs-sdk-java/docs-ref-autogen/com.azure.core.annotation.O...

28 строки
2.2 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.core.annotation.Options"
fullName: "com.azure.core.annotation.Options"
name: "Options"
nameWithType: "Options"
summary: "HTTP OPTIONS method annotation describing the parameterized relative path to a REST endpoint for retrieving options."
syntax: "public interface **Options**</br> implements <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html\">Annotation</a>"
methods:
- uid: "com.azure.core.annotation.Options.value()"
fullName: "com.azure.core.annotation.Options.value()"
name: "value()"
nameWithType: "Options.value()"
summary: "Get the relative path of the annotated method's OPTIONS URL."
modifiers:
- "abstract"
syntax: "public abstract String value()"
desc: "Get the relative path of the annotated method's OPTIONS URL."
returns:
description: "The relative path of the annotated method's OPTIONS URL."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "interface"
desc: "HTTP OPTIONS method annotation describing the parameterized relative path to a REST endpoint for retrieving options.\n\nThe required value can be either a relative path or an absolute path. When it's an absolute path, it must start with a protocol or a parameterized segment (Otherwise the parse cannot tell if it's absolute or relative).\n\n**Example 1: Relative path segments**\n\n```java\n@Options(\"subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/\"\n + \"virtualMachines/{vmName}\")\n ResponseBase<ResponseHeaders, ResponseBody> options(@PathParam(\"resourceGroupName\") String rgName,\n @PathParam(\"vmName\") String vmName,\n @PathParam(\"subscriptionId\") String subscriptionId);\n```\n\n**Example 2: Absolute path segment**\n\n```java\n@Options(\"{vaultBaseUrl}/secrets/{secretName}\")\n ResponseBase<ResponseHeaders, ResponseBody> options(\n @PathParam(value = \"vaultBaseUrl\", encoded = true) String vaultBaseUrl,\n @PathParam(\"secretName\") String secretName);\n```"
implements:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html\">Annotation</a>"
metadata: {}
package: "com.azure.core.annotation"
artifact: com.azure:azure-core:1.52.0