com.azure.core.util.tracing.StartSpanOptions.yml

### YamlMime:JavaType
uid: "com.azure.core.util.tracing.StartSpanOptions"
fullName: "com.azure.core.util.tracing.StartSpanOptions"
name: "StartSpanOptions"
nameWithType: "StartSpanOptions"
summary: "Represents span options that are available before span starts and describe it."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **StartSpanOptions**"
constructors:
- uid: "com.azure.core.util.tracing.StartSpanOptions.StartSpanOptions(com.azure.core.util.tracing.SpanKind)"
  fullName: "com.azure.core.util.tracing.StartSpanOptions.StartSpanOptions(SpanKind kind)"
  name: "StartSpanOptions(SpanKind kind)"
  nameWithType: "StartSpanOptions.StartSpanOptions(SpanKind kind)"
  summary: "Create start options with given kind"
  parameters:
  - description: "The kind of the span to be created."
    name: "kind"
    type: "<xref href=\"com.azure.core.util.tracing.SpanKind?alt=com.azure.core.util.tracing.SpanKind&text=SpanKind\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public StartSpanOptions(SpanKind kind)"
  desc: "Create start options with given kind"
methods:
- uid: "com.azure.core.util.tracing.StartSpanOptions.addLink(com.azure.core.util.tracing.TracingLink)"
  fullName: "com.azure.core.util.tracing.StartSpanOptions.addLink(TracingLink link)"
  name: "addLink(TracingLink link)"
  nameWithType: "StartSpanOptions.addLink(TracingLink link)"
  summary: "Add link to span."
  parameters:
  - description: "link."
    name: "link"
    type: "<xref href=\"com.azure.core.util.tracing.TracingLink?alt=com.azure.core.util.tracing.TracingLink&text=TracingLink\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public StartSpanOptions addLink(TracingLink link)"
  desc: "Add link to span."
  returns:
    description: "this instance for chaining."
    type: "<xref href=\"com.azure.core.util.tracing.StartSpanOptions?alt=com.azure.core.util.tracing.StartSpanOptions&text=StartSpanOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.tracing.StartSpanOptions.getAttributes()"
  fullName: "com.azure.core.util.tracing.StartSpanOptions.getAttributes()"
  name: "getAttributes()"
  nameWithType: "StartSpanOptions.getAttributes()"
  summary: "Gets all attributes on span that should be set before span is started."
  syntax: "public Map<String,Object> getAttributes()"
  desc: "Gets all attributes on span that should be set before span is started."
  returns:
    description: "attributes to be set on span and used for sampling."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>&gt;"
- uid: "com.azure.core.util.tracing.StartSpanOptions.getLinks()"
  fullName: "com.azure.core.util.tracing.StartSpanOptions.getLinks()"
  name: "getLinks()"
  nameWithType: "StartSpanOptions.getLinks()"
  summary: "Gets links to be set on span."
  syntax: "public List<TracingLink> getLinks()"
  desc: "Gets links to be set on span."
  returns:
    description: "list of links."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.core.util.tracing.TracingLink?alt=com.azure.core.util.tracing.TracingLink&text=TracingLink\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.core.util.tracing.StartSpanOptions.getRemoteParent()"
  fullName: "com.azure.core.util.tracing.StartSpanOptions.getRemoteParent()"
  name: "getRemoteParent()"
  nameWithType: "StartSpanOptions.getRemoteParent()"
  summary: "Gets remote parent."
  syntax: "public Context getRemoteParent()"
  desc: "Gets remote parent."
  returns:
    description: "context with remote parent span context on it."
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.tracing.StartSpanOptions.getSpanKind()"
  fullName: "com.azure.core.util.tracing.StartSpanOptions.getSpanKind()"
  name: "getSpanKind()"
  nameWithType: "StartSpanOptions.getSpanKind()"
  summary: "Gets span kind."
  syntax: "public SpanKind getSpanKind()"
  desc: "Gets span kind."
  returns:
    description: "span kind."
    type: "<xref href=\"com.azure.core.util.tracing.SpanKind?alt=com.azure.core.util.tracing.SpanKind&text=SpanKind\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.tracing.StartSpanOptions.getStartTimestamp()"
  fullName: "com.azure.core.util.tracing.StartSpanOptions.getStartTimestamp()"
  name: "getStartTimestamp()"
  nameWithType: "StartSpanOptions.getStartTimestamp()"
  summary: "Gets span start time."
  syntax: "public Instant getStartTimestamp()"
  desc: "Gets span start time."
  returns:
    description: "start timestamp."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html\">Instant</a>"
- uid: "com.azure.core.util.tracing.StartSpanOptions.setAttribute(java.lang.String,java.lang.Object)"
  fullName: "com.azure.core.util.tracing.StartSpanOptions.setAttribute(String key, Object value)"
  name: "setAttribute(String key, Object value)"
  nameWithType: "StartSpanOptions.setAttribute(String key, Object value)"
  summary: "Sets attribute on span before its started."
  parameters:
  - description: "attribute key."
    name: "key"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "attribute value. Note that underlying tracer implementations limit supported value types.\n              OpenTelemetry implementation supports following types:\n <ul>\n     <li><xref uid=\"java.lang.String\" data-throw-if-not-resolved=\"false\" data-raw-source=\"String\"></xref></li>\n     <li><code>int</code></li>\n     <li><code>double</code></li>\n     <li><code>boolean</code></li>\n     <li><code>long</code></li>\n     <li>Arrays of the above</li>\n </ul>"
    name: "value"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  syntax: "public StartSpanOptions setAttribute(String key, Object value)"
  desc: "Sets attribute on span before its started. Such attributes may affect sampling decision. Adding duplicate attributes, update, or removal is discouraged, since underlying implementations behavior can vary."
  returns:
    description: "this instance for chaining."
    type: "<xref href=\"com.azure.core.util.tracing.StartSpanOptions?alt=com.azure.core.util.tracing.StartSpanOptions&text=StartSpanOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.tracing.StartSpanOptions.setRemoteParent(com.azure.core.util.Context)"
  fullName: "com.azure.core.util.tracing.StartSpanOptions.setRemoteParent(Context parent)"
  name: "setRemoteParent(Context parent)"
  nameWithType: "StartSpanOptions.setRemoteParent(Context parent)"
  summary: "Sets remote parent context."
  parameters:
  - description: "context with remote span context."
    name: "parent"
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public StartSpanOptions setRemoteParent(Context parent)"
  desc: "Sets remote parent context."
  returns:
    description: "this instance for chaining."
    type: "<xref href=\"com.azure.core.util.tracing.StartSpanOptions?alt=com.azure.core.util.tracing.StartSpanOptions&text=StartSpanOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.tracing.StartSpanOptions.setStartTimestamp(java.time.Instant)"
  fullName: "com.azure.core.util.tracing.StartSpanOptions.setStartTimestamp(Instant timestamp)"
  name: "setStartTimestamp(Instant timestamp)"
  nameWithType: "StartSpanOptions.setStartTimestamp(Instant timestamp)"
  summary: "Sets span start timestamp."
  parameters:
  - description: "span start time."
    name: "timestamp"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html\">Instant</a>"
  syntax: "public StartSpanOptions setStartTimestamp(Instant timestamp)"
  desc: "Sets span start timestamp. This is optional and used to record past spans. If not set, uses current time."
  returns:
    description: "this instance for chaining."
    type: "<xref href=\"com.azure.core.util.tracing.StartSpanOptions?alt=com.azure.core.util.tracing.StartSpanOptions&text=StartSpanOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents span options that are available before span starts and describe it."
metadata: {}
package: "com.azure.core.util.tracing"
artifact: com.azure:azure-core:1.52.0