From 8755463b035f326d5f04587af833eb52ec12b153 Mon Sep 17 00:00:00 2001 From: VSC-Service-Account Date: Mon, 7 Nov 2022 21:09:01 +0000 Subject: [PATCH] CI Update Build.Reason:Manual by Alma Jenks Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=329983&view=results --- .../com.azure.core.amqp.AmqpClientOptions.yml | 2 +- .../com.azure.core.amqp.AmqpConnection.yml | 2 +- .../com.azure.core.amqp.AmqpEndpointState.yml | 2 +- .../com.azure.core.amqp.AmqpLink.yml | 2 +- ...com.azure.core.amqp.AmqpManagementNode.yml | 2 +- ...om.azure.core.amqp.AmqpMessageConstant.yml | 2 +- .../com.azure.core.amqp.AmqpRetryMode.yml | 2 +- .../com.azure.core.amqp.AmqpRetryOptions.yml | 2 +- .../com.azure.core.amqp.AmqpRetryPolicy.yml | 2 +- .../com.azure.core.amqp.AmqpSession.yml | 2 +- ...com.azure.core.amqp.AmqpShutdownSignal.yml | 2 +- .../com.azure.core.amqp.AmqpTransaction.yml | 2 +- ...e.core.amqp.AmqpTransactionCoordinator.yml | 2 +- .../com.azure.core.amqp.AmqpTransportType.yml | 2 +- ...zure.core.amqp.ClaimsBasedSecurityNode.yml | 2 +- ...e.core.amqp.ExponentialAmqpRetryPolicy.yml | 2 +- ...m.azure.core.amqp.FixedAmqpRetryPolicy.yml | 2 +- ...zure.core.amqp.ProxyAuthenticationType.yml | 2 +- .../com.azure.core.amqp.ProxyOptions.yml | 2 +- ...zure.core.amqp.client.traits.AmqpTrait.yml | 2 +- .../com.azure.core.amqp.client.traits.yml | 2 +- ...core.amqp.exception.AmqpErrorCondition.yml | 2 +- ...e.core.amqp.exception.AmqpErrorContext.yml | 2 +- ...zure.core.amqp.exception.AmqpException.yml | 2 +- ...e.core.amqp.exception.AmqpResponseCode.yml | 2 +- ...e.core.amqp.exception.LinkErrorContext.yml | 2 +- ....exception.OperationCancelledException.yml | 2 +- ...ore.amqp.exception.SessionErrorContext.yml | 2 +- .../com.azure.core.amqp.exception.yml | 2 +- ...com.azure.core.amqp.models.AmqpAddress.yml | 2 +- ....core.amqp.models.AmqpAnnotatedMessage.yml | 2 +- ...azure.core.amqp.models.AmqpMessageBody.yml | 2 +- ...e.core.amqp.models.AmqpMessageBodyType.yml | 2 +- ...ure.core.amqp.models.AmqpMessageHeader.yml | 2 +- ...m.azure.core.amqp.models.AmqpMessageId.yml | 2 +- ...core.amqp.models.AmqpMessageProperties.yml | 2 +- ....core.amqp.models.CbsAuthorizationType.yml | 10 +- ...azure.core.amqp.models.DeliveryOutcome.yml | 2 +- ...m.azure.core.amqp.models.DeliveryState.yml | 8 +- ...re.amqp.models.ModifiedDeliveryOutcome.yml | 2 +- ...re.amqp.models.ReceivedDeliveryOutcome.yml | 2 +- ...re.amqp.models.RejectedDeliveryOutcome.yml | 2 +- ...qp.models.TransactionalDeliveryOutcome.yml | 2 +- .../com.azure.core.amqp.models.yml | 2 +- docs-ref-autogen/com.azure.core.amqp.yml | 2 +- .../com.azure.core.annotation.BodyParam.yml | 6 +- .../com.azure.core.annotation.Delete.yml | 2 +- ...zure.core.annotation.ExpectedResponses.yml | 2 +- .../com.azure.core.annotation.Fluent.yml | 2 +- .../com.azure.core.annotation.FormParam.yml | 4 +- .../com.azure.core.annotation.Generated.yml | 2 +- .../com.azure.core.annotation.Get.yml | 2 +- .../com.azure.core.annotation.Head.yml | 2 +- ...azure.core.annotation.HeaderCollection.yml | 2 +- .../com.azure.core.annotation.HeaderParam.yml | 2 +- .../com.azure.core.annotation.Headers.yml | 2 +- .../com.azure.core.annotation.Host.yml | 2 +- .../com.azure.core.annotation.HostParam.yml | 2 +- .../com.azure.core.annotation.Immutable.yml | 2 +- .../com.azure.core.annotation.JsonFlatten.yml | 2 +- .../com.azure.core.annotation.Options.yml | 2 +- .../com.azure.core.annotation.Patch.yml | 2 +- .../com.azure.core.annotation.PathParam.yml | 2 +- .../com.azure.core.annotation.Post.yml | 2 +- .../com.azure.core.annotation.Put.yml | 2 +- .../com.azure.core.annotation.QueryParam.yml | 2 +- ....azure.core.annotation.ResumeOperation.yml | 2 +- .../com.azure.core.annotation.ReturnType.yml | 2 +- ...re.core.annotation.ReturnValueWireType.yml | 2 +- ...om.azure.core.annotation.ServiceClient.yml | 2 +- ...e.core.annotation.ServiceClientBuilder.yml | 2 +- ....core.annotation.ServiceClientProtocol.yml | 2 +- ...azure.core.annotation.ServiceInterface.yml | 2 +- ...om.azure.core.annotation.ServiceMethod.yml | 2 +- ...tation.UnexpectedResponseExceptionType.yml | 2 +- ...ation.UnexpectedResponseExceptionTypes.yml | 4 +- .../com.azure.core.annotation.yml | 2 +- ....client.traits.AzureKeyCredentialTrait.yml | 2 +- ...nt.traits.AzureNamedKeyCredentialTrait.yml | 2 +- ....client.traits.AzureSasCredentialTrait.yml | 2 +- ....core.client.traits.ConfigurationTrait.yml | 2 +- ...re.client.traits.ConnectionStringTrait.yml | 2 +- ...azure.core.client.traits.EndpointTrait.yml | 2 +- ...com.azure.core.client.traits.HttpTrait.yml | 2 +- ...ore.client.traits.TokenCredentialTrait.yml | 2 +- .../com.azure.core.client.traits.yml | 2 +- .../com.azure.core.credential.AccessToken.yml | 14 +- ...ure.core.credential.AzureKeyCredential.yml | 2 +- ...om.azure.core.credential.AzureNamedKey.yml | 2 +- ...ore.credential.AzureNamedKeyCredential.yml | 2 +- ...ure.core.credential.AzureSasCredential.yml | 2 +- ...edential.BasicAuthenticationCredential.yml | 2 +- ...azure.core.credential.SimpleTokenCache.yml | 2 +- ....azure.core.credential.TokenCredential.yml | 2 +- ...re.core.credential.TokenRequestContext.yml | 2 +- .../com.azure.core.credential.yml | 2 +- ...ore.cryptography.AsyncKeyEncryptionKey.yml | 2 +- ...tography.AsyncKeyEncryptionKeyResolver.yml | 2 +- ...ure.core.cryptography.KeyEncryptionKey.yml | 2 +- ....cryptography.KeyEncryptionKeyResolver.yml | 2 +- .../com.azure.core.cryptography.yml | 2 +- ...om.azure.core.exception.AzureException.yml | 2 +- ...xception.ClientAuthenticationException.yml | 2 +- ...m.azure.core.exception.DecodeException.yml | 2 +- ...re.core.exception.HttpRequestException.yml | 4 +- ...e.core.exception.HttpResponseException.yml | 6 +- ...core.exception.ResourceExistsException.yml | 2 +- ...re.exception.ResourceModifiedException.yml | 2 +- ...re.exception.ResourceNotFoundException.yml | 2 +- ...ore.exception.ServiceResponseException.yml | 2 +- ...re.exception.TooManyRedirectsException.yml | 2 +- ...re.exception.UnexpectedLengthException.yml | 2 +- docs-ref-autogen/com.azure.core.exception.yml | 2 +- .../com.azure.core.http.ContentType.yml | 2 +- .../com.azure.core.http.HttpAuthorization.yml | 6 +- .../com.azure.core.http.HttpClient.yml | 2 +- ...com.azure.core.http.HttpClientProvider.yml | 2 +- .../com.azure.core.http.HttpHeader.yml | 2 +- .../com.azure.core.http.HttpHeaderName.yml | 892 ++++++++++++++++++ .../com.azure.core.http.HttpHeaders.yml | 109 ++- .../com.azure.core.http.HttpMethod.yml | 2 +- .../com.azure.core.http.HttpPipeline.yml | 2 +- ...om.azure.core.http.HttpPipelineBuilder.yml | 2 +- ...zure.core.http.HttpPipelineCallContext.yml | 2 +- ...azure.core.http.HttpPipelineNextPolicy.yml | 2 +- ...e.core.http.HttpPipelineNextSyncPolicy.yml | 2 +- ...m.azure.core.http.HttpPipelinePosition.yml | 2 +- .../com.azure.core.http.HttpRange.yml | 2 +- .../com.azure.core.http.HttpRequest.yml | 2 +- .../com.azure.core.http.HttpResponse.yml | 2 +- .../com.azure.core.http.MatchConditions.yml | 4 +- .../com.azure.core.http.ProxyOptions.Type.yml | 2 +- .../com.azure.core.http.ProxyOptions.yml | 14 +- .../com.azure.core.http.RequestConditions.yml | 4 +- ...http.netty.NettyAsyncHttpClientBuilder.yml | 2 +- ...ttp.netty.NettyAsyncHttpClientProvider.yml | 2 +- .../com.azure.core.http.netty.yml | 2 +- ....http.okhttp.OkHttpAsyncClientProvider.yml | 2 +- ...tp.okhttp.OkHttpAsyncHttpClientBuilder.yml | 2 +- .../com.azure.core.http.okhttp.yml | 2 +- ...m.azure.core.http.policy.AddDatePolicy.yml | 4 +- ...ttp.policy.AddHeadersFromContextPolicy.yml | 4 +- ...zure.core.http.policy.AddHeadersPolicy.yml | 2 +- ...e.http.policy.AfterRetryPolicyProvider.yml | 2 +- ...e.http.policy.AzureKeyCredentialPolicy.yml | 2 +- ...e.http.policy.AzureSasCredentialPolicy.yml | 2 +- ...policy.BearerTokenAuthenticationPolicy.yml | 2 +- ....http.policy.BeforeRetryPolicyProvider.yml | 2 +- ...om.azure.core.http.policy.CookiePolicy.yml | 4 +- ...re.http.policy.DefaultRedirectStrategy.yml | 2 +- ...re.core.http.policy.ExponentialBackoff.yml | 2 +- ....http.policy.ExponentialBackoffOptions.yml | 4 +- .../com.azure.core.http.policy.FixedDelay.yml | 2 +- ...ure.core.http.policy.FixedDelayOptions.yml | 2 +- .../com.azure.core.http.policy.HostPolicy.yml | 2 +- ...re.core.http.policy.HttpLogDetailLevel.yml | 14 +- ....azure.core.http.policy.HttpLogOptions.yml | 2 +- ...ure.core.http.policy.HttpLoggingPolicy.yml | 2 +- ...re.core.http.policy.HttpPipelinePolicy.yml | 2 +- ...ore.http.policy.HttpPipelineSyncPolicy.yml | 4 +- ...re.core.http.policy.HttpPolicyProvider.yml | 2 +- ...e.core.http.policy.HttpPolicyProviders.yml | 2 +- ...ure.core.http.policy.HttpRequestLogger.yml | 2 +- ....http.policy.HttpRequestLoggingContext.yml | 2 +- ...re.core.http.policy.HttpResponseLogger.yml | 2 +- ...http.policy.HttpResponseLoggingContext.yml | 2 +- .../com.azure.core.http.policy.PortPolicy.yml | 2 +- ....azure.core.http.policy.ProtocolPolicy.yml | 2 +- ....azure.core.http.policy.RedirectPolicy.yml | 2 +- ...zure.core.http.policy.RedirectStrategy.yml | 2 +- ...azure.core.http.policy.RequestIdPolicy.yml | 2 +- ...om.azure.core.http.policy.RetryOptions.yml | 2 +- ...com.azure.core.http.policy.RetryPolicy.yml | 2 +- ...m.azure.core.http.policy.RetryStrategy.yml | 2 +- ...m.azure.core.http.policy.TimeoutPolicy.yml | 2 +- ...azure.core.http.policy.UserAgentPolicy.yml | 2 +- .../com.azure.core.http.policy.yml | 2 +- .../com.azure.core.http.rest.Page.yml | 2 +- .../com.azure.core.http.rest.PagedFlux.yml | 2 +- ...com.azure.core.http.rest.PagedFluxBase.yml | 2 +- ...com.azure.core.http.rest.PagedIterable.yml | 2 +- ...azure.core.http.rest.PagedIterableBase.yml | 2 +- ...com.azure.core.http.rest.PagedResponse.yml | 2 +- ...azure.core.http.rest.PagedResponseBase.yml | 2 +- ...om.azure.core.http.rest.RequestOptions.yml | 4 +- .../com.azure.core.http.rest.Response.yml | 2 +- .../com.azure.core.http.rest.ResponseBase.yml | 2 +- .../com.azure.core.http.rest.RestProxy.yml | 2 +- ...om.azure.core.http.rest.SimpleResponse.yml | 2 +- ...om.azure.core.http.rest.StreamResponse.yml | 2 +- docs-ref-autogen/com.azure.core.http.rest.yml | 2 +- docs-ref-autogen/com.azure.core.http.yml | 3 +- ...e.management.AzureEnvironment.Endpoint.yml | 2 +- ...azure.core.management.AzureEnvironment.yml | 2 +- ...om.azure.core.management.ProxyResource.yml | 2 +- .../com.azure.core.management.Region.yml | 2 +- .../com.azure.core.management.Resource.yml | 2 +- ....management.ResourceAuthorIdentityType.yml | 8 +- .../com.azure.core.management.SubResource.yml | 2 +- .../com.azure.core.management.SystemData.yml | 2 +- ...re.management.exception.AdditionalInfo.yml | 2 +- ...e.management.exception.ManagementError.yml | 2 +- ...nagement.exception.ManagementException.yml | 2 +- .../com.azure.core.management.exception.yml | 2 +- ...olicy.ArmChallengeAuthenticationPolicy.yml | 2 +- .../com.azure.core.management.http.policy.yml | 2 +- ...re.management.polling.PollResult.Error.yml | 2 +- ...ure.core.management.polling.PollResult.yml | 2 +- ....core.management.polling.PollerFactory.yml | 2 +- .../com.azure.core.management.polling.yml | 2 +- ...e.core.management.profile.AzureProfile.yml | 2 +- .../com.azure.core.management.profile.yml | 2 +- ...core.management.provider.DelayProvider.yml | 2 +- ...management.provider.IdentifierProvider.yml | 2 +- .../com.azure.core.management.provider.yml | 2 +- ...anagement.serializer.SerializerFactory.yml | 2 +- .../com.azure.core.management.serializer.yml | 2 +- .../com.azure.core.management.yml | 2 +- .../com.azure.core.models.CloudEvent.yml | 2 +- ...azure.core.models.CloudEventDataFormat.yml | 25 +- .../com.azure.core.models.GeoBoundingBox.yml | 2 +- .../com.azure.core.models.GeoCollection.yml | 2 +- .../com.azure.core.models.GeoLineString.yml | 2 +- ...re.core.models.GeoLineStringCollection.yml | 2 +- .../com.azure.core.models.GeoLinearRing.yml | 2 +- .../com.azure.core.models.GeoObject.yml | 2 +- .../com.azure.core.models.GeoObjectType.yml | 12 +- .../com.azure.core.models.GeoPoint.yml | 2 +- ...m.azure.core.models.GeoPointCollection.yml | 2 +- .../com.azure.core.models.GeoPolygon.yml | 2 +- ...azure.core.models.GeoPolygonCollection.yml | 2 +- .../com.azure.core.models.GeoPosition.yml | 2 +- ...om.azure.core.models.JsonPatchDocument.yml | 2 +- .../com.azure.core.models.MessageContent.yml | 4 +- .../com.azure.core.models.ResponseError.yml | 2 +- docs-ref-autogen/com.azure.core.models.yml | 2 +- ...erializer.json.gson.GsonJsonSerializer.yml | 2 +- ...er.json.gson.GsonJsonSerializerBuilder.yml | 2 +- ...r.json.gson.GsonJsonSerializerProvider.yml | 2 +- .../com.azure.core.serializer.json.gson.yml | 2 +- ...zer.json.jackson.JacksonJsonSerializer.yml | 2 +- ...n.jackson.JacksonJsonSerializerBuilder.yml | 2 +- ....jackson.JacksonJsonSerializerProvider.yml | 2 +- ...com.azure.core.serializer.json.jackson.yml | 2 +- .../com.azure.core.util.AsyncCloseable.yml | 2 +- ...ore.util.AuthorizationChallengeHandler.yml | 2 +- .../com.azure.core.util.Base64Url.yml | 2 +- .../com.azure.core.util.Base64Util.yml | 2 +- .../com.azure.core.util.BinaryData.yml | 8 +- .../com.azure.core.util.ClientOptions.yml | 4 +- .../com.azure.core.util.Configuration.yml | 2 +- ...m.azure.core.util.ConfigurationBuilder.yml | 2 +- ....azure.core.util.ConfigurationProperty.yml | 2 +- ...core.util.ConfigurationPropertyBuilder.yml | 2 +- ...om.azure.core.util.ConfigurationSource.yml | 2 +- .../com.azure.core.util.Context.yml | 2 +- .../com.azure.core.util.Contexts.yml | 2 +- .../com.azure.core.util.CoreUtils.yml | 2 +- .../com.azure.core.util.DateTimeRfc1123.yml | 2 +- docs-ref-autogen/com.azure.core.util.ETag.yml | 2 +- ...m.azure.core.util.ExpandableStringEnum.yml | 8 +- .../com.azure.core.util.FluxUtil.yml | 2 +- .../com.azure.core.util.Header.yml | 2 +- .../com.azure.core.util.HttpClientOptions.yml | 4 +- .../com.azure.core.util.IterableStream.yml | 2 +- .../com.azure.core.util.MetricsOptions.yml | 2 +- .../com.azure.core.util.ProgressListener.yml | 2 +- .../com.azure.core.util.ProgressReporter.yml | 2 +- .../com.azure.core.util.ReferenceManager.yml | 2 +- .../com.azure.core.util.ServiceVersion.yml | 2 +- ...om.azure.core.util.TelemetryAttributes.yml | 2 +- .../com.azure.core.util.UrlBuilder.yml | 2 +- ...om.azure.core.util.UserAgentProperties.yml | 2 +- .../com.azure.core.util.UserAgentUtil.yml | 2 +- ...re.core.util.builder.ClientBuilderUtil.yml | 2 +- .../com.azure.core.util.builder.yml | 2 +- .../com.azure.core.util.io.IOUtils.yml | 2 +- docs-ref-autogen/com.azure.core.util.io.yml | 2 +- ...m.azure.core.util.logging.ClientLogger.yml | 2 +- .../com.azure.core.util.logging.LogLevel.yml | 2 +- ....core.util.logging.LoggingEventBuilder.yml | 2 +- .../com.azure.core.util.logging.yml | 2 +- ...zure.core.util.metrics.DoubleHistogram.yml | 2 +- ...om.azure.core.util.metrics.LongCounter.yml | 2 +- .../com.azure.core.util.metrics.LongGauge.yml | 2 +- .../com.azure.core.util.metrics.Meter.yml | 2 +- ....azure.core.util.metrics.MeterProvider.yml | 2 +- .../com.azure.core.util.metrics.yml | 2 +- ...azure.core.util.paging.ContinuablePage.yml | 2 +- ....core.util.paging.ContinuablePagedFlux.yml | 2 +- ...e.util.paging.ContinuablePagedFluxCore.yml | 2 +- ...e.util.paging.ContinuablePagedIterable.yml | 2 +- ...m.azure.core.util.paging.PageRetriever.yml | 2 +- ...ure.core.util.paging.PageRetrieverSync.yml | 2 +- .../com.azure.core.util.paging.yml | 2 +- ...re.core.util.polling.AsyncPollResponse.yml | 10 +- ...re.util.polling.ChainedPollingStrategy.yml | 2 +- ...re.util.polling.DefaultPollingStrategy.yml | 2 +- ...e.util.polling.LocationPollingStrategy.yml | 2 +- ...til.polling.LongRunningOperationStatus.yml | 8 +- ...lling.OperationResourcePollingStrategy.yml | 2 +- ...m.azure.core.util.polling.PollResponse.yml | 2 +- ...com.azure.core.util.polling.PollerFlux.yml | 4 +- ...azure.core.util.polling.PollingContext.yml | 10 +- ...zure.core.util.polling.PollingStrategy.yml | 2 +- ...til.polling.StatusCheckPollingStrategy.yml | 2 +- ...til.polling.SyncChainedPollingStrategy.yml | 118 +++ ...til.polling.SyncDefaultPollingStrategy.yml | 169 ++++ ...il.polling.SyncLocationPollingStrategy.yml | 155 +++ ...g.SyncOperationResourcePollingStrategy.yml | 164 ++++ ...com.azure.core.util.polling.SyncPoller.yml | 42 +- ....core.util.polling.SyncPollingStrategy.yml | 113 +++ ...polling.SyncStatusCheckPollingStrategy.yml | 111 +++ .../com.azure.core.util.polling.yml | 8 +- ....core.util.serializer.CollectionFormat.yml | 2 +- ...re.core.util.serializer.JacksonAdapter.yml | 2 +- ...re.core.util.serializer.JsonSerializer.yml | 2 +- ...util.serializer.JsonSerializerProvider.yml | 2 +- ...til.serializer.JsonSerializerProviders.yml | 2 +- ...re.util.serializer.MemberNameConverter.yml | 2 +- ...serializer.MemberNameConverterProvider.yml | 2 +- ...erializer.MemberNameConverterProviders.yml | 2 +- ....core.util.serializer.ObjectSerializer.yml | 2 +- ...core.util.serializer.SerializerAdapter.yml | 2 +- ...ore.util.serializer.SerializerEncoding.yml | 2 +- ...ure.core.util.serializer.TypeReference.yml | 2 +- .../com.azure.core.util.serializer.yml | 2 +- ...om.azure.core.util.tracing.ProcessKind.yml | 2 +- .../com.azure.core.util.tracing.SpanKind.yml | 2 +- ...ure.core.util.tracing.StartSpanOptions.yml | 2 +- .../com.azure.core.util.tracing.Tracer.yml | 2 +- ...om.azure.core.util.tracing.TracerProxy.yml | 2 +- .../com.azure.core.util.tracing.yml | 2 +- docs-ref-autogen/com.azure.core.util.yml | 2 +- docs-ref-autogen/toc.yml | 14 + ...llautomation.CallAutomationAsyncClient.yml | 177 ++++ ...on.callautomation.CallAutomationClient.yml | 189 ++++ ...automation.CallAutomationClientBuilder.yml | 246 +++++ ...nication.callautomation.CallConnection.yml | 242 +++++ ...ion.callautomation.CallConnectionAsync.yml | 219 +++++ ...communication.callautomation.CallMedia.yml | 146 +++ ...nication.callautomation.CallMediaAsync.yml | 145 +++ ...unication.callautomation.CallRecording.yml | 311 ++++++ ...tion.callautomation.CallRecordingAsync.yml | 296 ++++++ ...automation.CallingServerServiceVersion.yml | 91 ++ ...munication.callautomation.EventHandler.yml | 67 ++ ...tomation.models.AddParticipantsOptions.yml | 147 +++ ...utomation.models.AddParticipantsResult.yml | 57 ++ ...allautomation.models.AnswerCallOptions.yml | 88 ++ ...callautomation.models.AnswerCallResult.yml | 52 + ...mation.models.CallConnectionProperties.yml | 97 ++ ...lautomation.models.CallConnectionState.yml | 135 +++ ...tion.callautomation.models.CallLocator.yml | 39 + ....callautomation.models.CallLocatorKind.yml | 91 ++ ...mation.models.CallMediaRecognitionType.yml | 79 ++ ...n.models.CallMediaRecognizeDtmfOptions.yml | 120 +++ ...ation.models.CallMediaRecognizeOptions.yml | 222 +++++ ....callautomation.models.CallParticipant.yml | 64 ++ ...callautomation.models.CallRejectReason.yml | 103 ++ ...ation.callautomation.models.CallResult.yml | 59 ++ ...ation.callautomation.models.CallSource.yml | 75 ++ ...tomation.models.CallingOperationStatus.yml | 111 +++ ...llautomation.models.CallingServerError.yml | 79 ++ ...ion.models.CallingServerErrorException.yml | 68 ++ ...llautomation.models.CollectTonesResult.yml | 59 ++ ...allautomation.models.CreateCallOptions.yml | 149 +++ ...callautomation.models.CreateCallResult.yml | 52 + ...utomation.models.DownloadToFileOptions.yml | 83 ++ ...ication.callautomation.models.DtmfTone.yml | 259 +++++ ...ation.callautomation.models.FileSource.yml | 64 ++ ...callautomation.models.GroupCallLocator.yml | 55 ++ ...on.callautomation.models.HangUpOptions.yml | 75 ++ ...tomation.models.ListParticipantsResult.yml | 47 + ...omation.models.ParallelDownloadOptions.yml | 107 +++ ...tion.callautomation.models.PlayOptions.yml | 83 ++ ...ation.callautomation.models.PlaySource.yml | 59 ++ ...n.callautomation.models.PlaySourceType.yml | 79 ++ ...llautomation.models.RecognizeInputType.yml | 79 ++ ...callautomation.models.RecordingChannel.yml | 91 ++ ...callautomation.models.RecordingContent.yml | 91 ++ ....callautomation.models.RecordingFormat.yml | 103 ++ ...n.callautomation.models.RecordingState.yml | 91 ++ ...automation.models.RecordingStateResult.yml | 57 ++ ...lautomation.models.RedirectCallOptions.yml | 88 ++ ...allautomation.models.RejectCallOptions.yml | 99 ++ ...ation.models.RemoveParticipantsOptions.yml | 99 ++ ...mation.models.RemoveParticipantsResult.yml | 47 + ...automation.models.RepeatabilityHeaders.yml | 74 ++ ...allautomation.models.ServerCallLocator.yml | 55 ++ ...utomation.models.StartRecordingOptions.yml | 195 ++++ ...llautomation.models.TransferCallResult.yml | 47 + ...odels.TransferToParticipantCallOptions.yml | 123 +++ ...on.models.events.AddParticipantsFailed.yml | 56 ++ ...models.events.AddParticipantsSucceeded.yml | 56 ++ ....models.events.CallAutomationEventBase.yml | 69 ++ ....CallAutomationEventWithReasonCodeBase.yml | 56 ++ ...automation.models.events.CallConnected.yml | 35 + ...omation.models.events.CallDisconnected.yml | 35 + ...ion.models.events.CallTransferAccepted.yml | 46 + ...ation.models.events.CallTransferFailed.yml | 46 + ...tion.models.events.ParticipantsUpdated.yml | 46 + ...lautomation.models.events.PlayCanceled.yml | 41 + ...automation.models.events.PlayCompleted.yml | 52 + ...allautomation.models.events.PlayFailed.yml | 52 + ...tomation.models.events.ReasonCode.Play.yml | 64 ++ ...ion.models.events.ReasonCode.Recognize.yml | 100 ++ ...allautomation.models.events.ReasonCode.yml | 64 ++ ...mation.models.events.RecognizeCanceled.yml | 41 + ...ation.models.events.RecognizeCompleted.yml | 67 ++ ...tomation.models.events.RecognizeFailed.yml | 46 + ...on.models.events.RecordingStateChanged.yml | 66 ++ ...mation.models.events.ResultInformation.yml | 59 ++ ...unication.callautomation.models.events.yml | 30 + ...re.communication.callautomation.models.yml | 56 ++ ...com.azure.communication.callautomation.yml | 22 + ...http.vertx.VertxAsyncHttpClientBuilder.yml | 2 +- ...ttp.vertx.VertxAsyncHttpClientProvider.yml | 2 +- ...om.azure.core.http.vertx.VertxProvider.yml | 2 +- .../com.azure.core.http.vertx.yml | 2 +- ...entelemetry.OpenTelemetryMeterProvider.yml | 2 +- ...ntelemetry.OpenTelemetryMetricsOptions.yml | 2 +- .../com.azure.core.metrics.opentelemetry.yml | 2 +- ...lizer.avro.apache.ApacheAvroSerializer.yml | 2 +- ...vro.apache.ApacheAvroSerializerBuilder.yml | 2 +- ...ro.apache.ApacheAvroSerializerProvider.yml | 2 +- .../com.azure.core.serializer.avro.apache.yml | 2 +- ....opentelemetry.OpenTelemetryHttpPolicy.yml | 2 +- ...cing.opentelemetry.OpenTelemetryTracer.yml | 2 +- .../com.azure.core.tracing.opentelemetry.yml | 2 +- preview/docs-ref-autogen/toc.yml | 163 ++++ .../docs-ref-mapping/reference-preview.yml | 6 +- 431 files changed, 10063 insertions(+), 373 deletions(-) create mode 100644 docs-ref-autogen/com.azure.core.http.HttpHeaderName.yml create mode 100644 docs-ref-autogen/com.azure.core.util.polling.SyncChainedPollingStrategy.yml create mode 100644 docs-ref-autogen/com.azure.core.util.polling.SyncDefaultPollingStrategy.yml create mode 100644 docs-ref-autogen/com.azure.core.util.polling.SyncLocationPollingStrategy.yml create mode 100644 docs-ref-autogen/com.azure.core.util.polling.SyncOperationResourcePollingStrategy.yml create mode 100644 docs-ref-autogen/com.azure.core.util.polling.SyncPollingStrategy.yml create mode 100644 docs-ref-autogen/com.azure.core.util.polling.SyncStatusCheckPollingStrategy.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationAsyncClient.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationClient.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationClientBuilder.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.CallConnection.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.CallConnectionAsync.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.CallMedia.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.CallMediaAsync.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.CallRecording.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.CallRecordingAsync.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.CallingServerServiceVersion.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.EventHandler.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.AddParticipantsOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.AddParticipantsResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.AnswerCallOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.AnswerCallResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallConnectionProperties.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallConnectionState.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallLocator.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallLocatorKind.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognitionType.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognizeOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallParticipant.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallRejectReason.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallSource.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingOperationStatus.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingServerError.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingServerErrorException.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CollectTonesResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CreateCallOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.CreateCallResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.DownloadToFileOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.DtmfTone.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.FileSource.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.GroupCallLocator.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.HangUpOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.ListParticipantsResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.ParallelDownloadOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlayOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlaySource.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlaySourceType.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecognizeInputType.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingChannel.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingContent.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingFormat.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingState.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingStateResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RedirectCallOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RejectCallOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RemoveParticipantsOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RemoveParticipantsResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.RepeatabilityHeaders.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.ServerCallLocator.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.StartRecordingOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.TransferCallResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.TransferToParticipantCallOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.AddParticipantsFailed.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.AddParticipantsSucceeded.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallAutomationEventBase.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallConnected.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallDisconnected.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallTransferAccepted.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallTransferFailed.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ParticipantsUpdated.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayCanceled.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayCompleted.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayFailed.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.Play.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.Recognize.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeCanceled.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeCompleted.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeFailed.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecordingStateChanged.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ResultInformation.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.models.yml create mode 100644 preview/docs-ref-autogen/com.azure.communication.callautomation.yml diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpClientOptions.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpClientOptions.yml index 382b515f3be6..ff731ee889a2 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpClientOptions.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpClientOptions.yml @@ -87,4 +87,4 @@ type: "class" desc: "General configuration options for AMQP clients." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpConnection.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpConnection.yml index 80bcf4ccae86..9c43e244a98f 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpConnection.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpConnection.yml @@ -157,4 +157,4 @@ implements: - "" metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpEndpointState.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpEndpointState.yml index 0a9fffef9241..34d2ede31858 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpEndpointState.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpEndpointState.yml @@ -73,4 +73,4 @@ methods: desc: "Represents a state for a connection, session, or link." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpLink.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpLink.yml index fbfe79a76355..1883ce2d2226 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpLink.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpLink.yml @@ -73,4 +73,4 @@ implements: - "" metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpManagementNode.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpManagementNode.yml index aadb35857b3f..c79e01847bf9 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpManagementNode.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpManagementNode.yml @@ -47,4 +47,4 @@ implements: - "" metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpMessageConstant.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpMessageConstant.yml index a3ebb4c458f7..6d2a21afc1d8 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpMessageConstant.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpMessageConstant.yml @@ -237,4 +237,4 @@ methods: desc: "Reserved well-known constants from AMQP protocol." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpRetryMode.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpRetryMode.yml index 765af83b4d75..a9043efa708f 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpRetryMode.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpRetryMode.yml @@ -67,4 +67,4 @@ methods: desc: "The type of approach to apply when calculating the delay between retry attempts." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpRetryOptions.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpRetryOptions.yml index 245fc18d2225..7820146b4b26 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpRetryOptions.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpRetryOptions.yml @@ -184,4 +184,4 @@ type: "class" desc: "A set of options that can be specified to influence how retry attempts are made." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpRetryPolicy.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpRetryPolicy.yml index 87c7381d0905..8077c14f21fc 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpRetryPolicy.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpRetryPolicy.yml @@ -122,4 +122,4 @@ type: "class" desc: "An abstract representation of a policy to govern retrying of messaging operations." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpSession.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpSession.yml index 0944cc79c85b..6a415f1e40a4 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpSession.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpSession.yml @@ -180,4 +180,4 @@ implements: - "" metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpShutdownSignal.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpShutdownSignal.yml index 1976d2b270e6..db91217eb4f3 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpShutdownSignal.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpShutdownSignal.yml @@ -74,4 +74,4 @@ type: "class" desc: "Represents a signal that caused the AMQP connection to shutdown." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpTransaction.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpTransaction.yml index 48e04ccc71b1..9d14b6c2fa70 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpTransaction.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpTransaction.yml @@ -59,4 +59,4 @@ type: "class" desc: "Represents transaction in message broker. It does not do any network operation on its own. It contains meta data about transaction such as transaction id." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpTransactionCoordinator.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpTransactionCoordinator.yml index a6cc2a9a0eca..70390bbfcad9 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpTransactionCoordinator.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpTransactionCoordinator.yml @@ -41,4 +41,4 @@ type: "interface" desc: "Provides an API to manage AMQP transaction on the message broker. A transaction is used where two or more operations in the messaging broker are part of one unit of work. The transaction must ensure that all operations belonging to a given transaction either succeed or fail jointly. In general a transaction is involved with many operations on one message broker entity. Sometime a transaction can span over multiple message broker entities explained as follows.\n\nDistributed Transactions: A distributed transaction where operations spans over different message broker entities. For example an application receive from entity 'A' and sends to entity 'B' and 'C' and all these operations are part of one transaction." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.AmqpTransportType.yml b/docs-ref-autogen/com.azure.core.amqp.AmqpTransportType.yml index 10efd521be4c..2be9dee6fec8 100644 --- a/docs-ref-autogen/com.azure.core.amqp.AmqpTransportType.yml +++ b/docs-ref-autogen/com.azure.core.amqp.AmqpTransportType.yml @@ -91,4 +91,4 @@ methods: desc: "All TransportType switches available for AMQP protocol." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.ClaimsBasedSecurityNode.yml b/docs-ref-autogen/com.azure.core.amqp.ClaimsBasedSecurityNode.yml index fc3c935498e9..324ac2843e5c 100644 --- a/docs-ref-autogen/com.azure.core.amqp.ClaimsBasedSecurityNode.yml +++ b/docs-ref-autogen/com.azure.core.amqp.ClaimsBasedSecurityNode.yml @@ -50,4 +50,4 @@ implements: - "" metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.ExponentialAmqpRetryPolicy.yml b/docs-ref-autogen/com.azure.core.amqp.ExponentialAmqpRetryPolicy.yml index 90722e4bdb76..25eef20197c0 100644 --- a/docs-ref-autogen/com.azure.core.amqp.ExponentialAmqpRetryPolicy.yml +++ b/docs-ref-autogen/com.azure.core.amqp.ExponentialAmqpRetryPolicy.yml @@ -90,4 +90,4 @@ type: "class" desc: "A policy to govern retrying of messaging operations in which the delay between retries will grow in an exponential manner, allowing more time to recover as the number of retries increases." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.FixedAmqpRetryPolicy.yml b/docs-ref-autogen/com.azure.core.amqp.FixedAmqpRetryPolicy.yml index a42b1f06ffa8..481c08713f56 100644 --- a/docs-ref-autogen/com.azure.core.amqp.FixedAmqpRetryPolicy.yml +++ b/docs-ref-autogen/com.azure.core.amqp.FixedAmqpRetryPolicy.yml @@ -90,4 +90,4 @@ type: "class" desc: "A policy to govern retrying of messaging operations in which the base delay between retries remains the same." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.ProxyAuthenticationType.yml b/docs-ref-autogen/com.azure.core.amqp.ProxyAuthenticationType.yml index 4237196ef951..00854a90fb98 100644 --- a/docs-ref-autogen/com.azure.core.amqp.ProxyAuthenticationType.yml +++ b/docs-ref-autogen/com.azure.core.amqp.ProxyAuthenticationType.yml @@ -73,4 +73,4 @@ methods: desc: "Supported methods of proxy authentication." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.ProxyOptions.yml b/docs-ref-autogen/com.azure.core.amqp.ProxyOptions.yml index 0199da444538..503654a40743 100644 --- a/docs-ref-autogen/com.azure.core.amqp.ProxyOptions.yml +++ b/docs-ref-autogen/com.azure.core.amqp.ProxyOptions.yml @@ -174,4 +174,4 @@ implements: - "AutoCloseable" metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.client.traits.AmqpTrait.yml b/docs-ref-autogen/com.azure.core.amqp.client.traits.AmqpTrait.yml index b50e1dbd43a9..1509adf167ba 100644 --- a/docs-ref-autogen/com.azure.core.amqp.client.traits.AmqpTrait.yml +++ b/docs-ref-autogen/com.azure.core.amqp.client.traits.AmqpTrait.yml @@ -77,4 +77,4 @@ typeParameters: desc: "An providing a consistent interface for configuration of AMQP-specific settings." metadata: {} package: "com.azure.core.amqp.client.traits" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.client.traits.yml b/docs-ref-autogen/com.azure.core.amqp.client.traits.yml index 132218d88a0f..04f7e8952c5f 100644 --- a/docs-ref-autogen/com.azure.core.amqp.client.traits.yml +++ b/docs-ref-autogen/com.azure.core.amqp.client.traits.yml @@ -8,4 +8,4 @@ interfaces: desc: "This package contains interfaces that represent common cross-cutting (and AMQP-related) aspects of functionality\n offered by libraries in the Azure SDK for Java. Each interface is referred to as a 'trait', and classes that\n implement the interface are said to have that trait. There are additional traits that are more general\n purpose in the package.\n\n

The particular focus of traits in the Azure SDK for Java is to enable higher-level\n libraries the ability to more abstractly configure client libraries as part of their builders, prior to the client\n itself being instantiated. By doing this, these high-level libraries are able to reason about functionality more\n simply. It is important to appreciate that despite the availability of these cross-cutting traits, there is no\n promise that configuration of each builder can simply be a matter of providing the same arguments for all builders!\n Each builder must be configured appropriately for its requirements, or else runtime failures may occur when the\n builder is asked to create the associated client.

" metadata: {} package: "com.azure.core.amqp.client.traits" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.exception.AmqpErrorCondition.yml b/docs-ref-autogen/com.azure.core.amqp.exception.AmqpErrorCondition.yml index 7eb7ade1a16d..d3ac24b82406 100644 --- a/docs-ref-autogen/com.azure.core.amqp.exception.AmqpErrorCondition.yml +++ b/docs-ref-autogen/com.azure.core.amqp.exception.AmqpErrorCondition.yml @@ -273,4 +273,4 @@ methods: desc: "Contains constants common to the AMQP protocol and constants shared by Azure services." metadata: {} package: "com.azure.core.amqp.exception" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.exception.AmqpErrorContext.yml b/docs-ref-autogen/com.azure.core.amqp.exception.AmqpErrorContext.yml index 3c7d2d310e6d..0fd1a87fd1d6 100644 --- a/docs-ref-autogen/com.azure.core.amqp.exception.AmqpErrorContext.yml +++ b/docs-ref-autogen/com.azure.core.amqp.exception.AmqpErrorContext.yml @@ -85,4 +85,4 @@ implements: - "Serializable" metadata: {} package: "com.azure.core.amqp.exception" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.exception.AmqpException.yml b/docs-ref-autogen/com.azure.core.amqp.exception.AmqpException.yml index 620943472923..666dd0497835 100644 --- a/docs-ref-autogen/com.azure.core.amqp.exception.AmqpException.yml +++ b/docs-ref-autogen/com.azure.core.amqp.exception.AmqpException.yml @@ -183,4 +183,4 @@ type: "class" desc: "General exception for AMQP related failures." metadata: {} package: "com.azure.core.amqp.exception" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.exception.AmqpResponseCode.yml b/docs-ref-autogen/com.azure.core.amqp.exception.AmqpResponseCode.yml index 97dd366c4c90..21a6ea01b486 100644 --- a/docs-ref-autogen/com.azure.core.amqp.exception.AmqpResponseCode.yml +++ b/docs-ref-autogen/com.azure.core.amqp.exception.AmqpResponseCode.yml @@ -363,4 +363,4 @@ methods: desc: "Error response codes returned from AMQP." metadata: {} package: "com.azure.core.amqp.exception" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.exception.LinkErrorContext.yml b/docs-ref-autogen/com.azure.core.amqp.exception.LinkErrorContext.yml index 348d87c20498..2d3fa1b46ee4 100644 --- a/docs-ref-autogen/com.azure.core.amqp.exception.LinkErrorContext.yml +++ b/docs-ref-autogen/com.azure.core.amqp.exception.LinkErrorContext.yml @@ -86,4 +86,4 @@ type: "class" desc: "Represents the context for an AMQP link when an occurs." metadata: {} package: "com.azure.core.amqp.exception" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.exception.OperationCancelledException.yml b/docs-ref-autogen/com.azure.core.amqp.exception.OperationCancelledException.yml index fcc8d53d16d2..14d6fdd81802 100644 --- a/docs-ref-autogen/com.azure.core.amqp.exception.OperationCancelledException.yml +++ b/docs-ref-autogen/com.azure.core.amqp.exception.OperationCancelledException.yml @@ -81,4 +81,4 @@ type: "class" desc: "This exception is thrown when the underlying AMQP layer encounters an abnormal link abort or the connection is disconnected in an unexpected fashion." metadata: {} package: "com.azure.core.amqp.exception" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.exception.SessionErrorContext.yml b/docs-ref-autogen/com.azure.core.amqp.exception.SessionErrorContext.yml index 031614035fa9..3d6276232047 100644 --- a/docs-ref-autogen/com.azure.core.amqp.exception.SessionErrorContext.yml +++ b/docs-ref-autogen/com.azure.core.amqp.exception.SessionErrorContext.yml @@ -66,4 +66,4 @@ type: "class" desc: "Context for an error that occurs in an AMQP session when an occurs." metadata: {} package: "com.azure.core.amqp.exception" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.exception.yml b/docs-ref-autogen/com.azure.core.amqp.exception.yml index 86618e5416c0..f8a270eb2e30 100644 --- a/docs-ref-autogen/com.azure.core.amqp.exception.yml +++ b/docs-ref-autogen/com.azure.core.amqp.exception.yml @@ -15,4 +15,4 @@ enums: desc: "Package containing classes related to AMQP exceptions." metadata: {} package: "com.azure.core.amqp.exception" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.AmqpAddress.yml b/docs-ref-autogen/com.azure.core.amqp.models.AmqpAddress.yml index ffea3dd290d0..3733c69db161 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.AmqpAddress.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.AmqpAddress.yml @@ -65,4 +65,4 @@ type: "class" desc: "This represents amqp address information. This will be used in populating information like 'To', 'ReplyTo' etc.\n\n**Create and retrieve address**\n\n```java\nAmqpAddress amqpAddress = new AmqpAddress(\"my-address\");\n // Retrieve Adderss\n String address = amqpAddress.toString();\n System.out.println(\"Address \" + address);\n```" metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.AmqpAnnotatedMessage.yml b/docs-ref-autogen/com.azure.core.amqp.models.AmqpAnnotatedMessage.yml index 8965a20833ce..c58fcbed1edc 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.AmqpAnnotatedMessage.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.AmqpAnnotatedMessage.yml @@ -108,4 +108,4 @@ type: "class" desc: "The representation of message as defined by AMQP protocol." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageBody.yml b/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageBody.yml index 061b67e467aa..facf5f00253a 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageBody.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageBody.yml @@ -124,4 +124,4 @@ type: "class" desc: "This class encapsulates the body of a message. The map to an AMQP specification message body types. Current implementation support AMQP data type.\n\n**Client should test for before calling corresponding get method. Get methods not corresponding to the type of the body throws exception.**\n\n**How to check for **\n\n```java\nObject amqpValue;\n AmqpMessageBodyType bodyType = amqpAnnotatedMessage.getBody().getBodyType();\n\n switch (bodyType) {\n case DATA:\n byte[] payload = amqpAnnotatedMessage.getBody().getFirstData();\n System.out.println(new String(payload));\n break;\n case SEQUENCE:\n List sequenceData = amqpAnnotatedMessage.getBody().getSequence();\n sequenceData.forEach(System.out::println);\n break;\n case VALUE:\n amqpValue = amqpAnnotatedMessage.getBody().getValue();\n System.out.println(amqpValue);\n break;\n default:\n throw new RuntimeException(String.format(Locale.US, \"Body type [%s] is not valid.\", bodyType));\n }\n```" metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageBodyType.yml b/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageBodyType.yml index bbbd73fedc01..57337ea48164 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageBodyType.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageBodyType.yml @@ -73,4 +73,4 @@ methods: desc: "Represents all valid for an AMQP Message. Current SDK only support AMQP data type. Track this [issue][] to find out support for other AMQP types.\n\n**Types of Amqp message body**\n\n * [DATA][]\n * [SEQUENCE][]\n * [VALUE][]\n\n\n[issue]: https://github.com/Azure/azure-sdk-for-java/issues/17614\n[DATA]: http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-data\n[SEQUENCE]: http://docs.oasis-open.org/amqp/core/v1.0/amqp-core-messaging-v1.0.html#type-amqp-sequence\n[VALUE]: http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-amqp-value" metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageHeader.yml b/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageHeader.yml index eb72eb2a8ed2..11bf77ab5b65 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageHeader.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageHeader.yml @@ -146,4 +146,4 @@ type: "class" desc: "The representation of message header as defined by AMQP protocol." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageId.yml b/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageId.yml index a238ad5434b1..706d8fbb207a 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageId.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageId.yml @@ -65,4 +65,4 @@ type: "class" desc: "This represents Message id. Amqp specification support message id in various types. This class only implements representation at present.\n\n**Create and retrieve message id** \n\n```java\nAmqpMessageId messageId = new AmqpMessageId(\"my-message-id\");\n // Retrieve Message id\n String id = messageId.toString();\n System.out.println(\"Message Id \" + id);\n```" metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageProperties.yml b/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageProperties.yml index 95047ae94f7a..453d0f4cdd69 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageProperties.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.AmqpMessageProperties.yml @@ -338,4 +338,4 @@ type: "class" desc: "The representation of message properties as defined by AMQP protocol." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.CbsAuthorizationType.yml b/docs-ref-autogen/com.azure.core.amqp.models.CbsAuthorizationType.yml index e0ceb598fbec..a055b3b2f4f4 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.CbsAuthorizationType.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.CbsAuthorizationType.yml @@ -31,7 +31,11 @@ constructors: fullName: "com.azure.core.amqp.models.CbsAuthorizationType.CbsAuthorizationType()" name: "CbsAuthorizationType()" nameWithType: "CbsAuthorizationType.CbsAuthorizationType()" - syntax: "public CbsAuthorizationType()" + summary: "Creates a new instance of without a value." + deprecatedTag: "Use one of the constants or the factory method." + syntax: "@Deprecated
public CbsAuthorizationType()" + desc: "Creates a new instance of without a value.\n\nThis constructor shouldn't be called as it will produce a which doesn't have a String enum value." + hasDeprecatedTag: true fields: - uid: "com.azure.core.amqp.models.CbsAuthorizationType.JSON_WEB_TOKEN" fullName: "com.azure.core.amqp.models.CbsAuthorizationType.JSON_WEB_TOKEN" @@ -44,7 +48,7 @@ fields: field: type: "" syntax: "public static final CbsAuthorizationType JSON_WEB_TOKEN" - desc: "Authorize with CBS using a JSON web token. This is used in the case where Azure Active Directory is used for authentication and the authenticated user wants to authorize with Azure Event Hubs." + desc: "Authorize with CBS using a JSON web token.\n\nThis is used in the case where Azure Active Directory is used for authentication and the authenticated user wants to authorize with Azure Event Hubs." - uid: "com.azure.core.amqp.models.CbsAuthorizationType.SHARED_ACCESS_SIGNATURE" fullName: "com.azure.core.amqp.models.CbsAuthorizationType.SHARED_ACCESS_SIGNATURE" name: "SHARED_ACCESS_SIGNATURE" @@ -61,4 +65,4 @@ type: "class" desc: "An enumeration of supported authorization methods with the ." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.DeliveryOutcome.yml b/docs-ref-autogen/com.azure.core.amqp.models.DeliveryOutcome.yml index 37b3b9a9a1c8..b5fa3057d3a3 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.DeliveryOutcome.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.DeliveryOutcome.yml @@ -48,4 +48,4 @@ type: "class" desc: "Outcomes accepted by the AMQP protocol layer. Some outcomes have metadata associated with them, such as while others require only a . An outcome with no metadata is ." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.DeliveryState.yml b/docs-ref-autogen/com.azure.core.amqp.models.DeliveryState.yml index bb0ddb28077a..cd75d25dacc5 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.DeliveryState.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.DeliveryState.yml @@ -31,7 +31,11 @@ constructors: fullName: "com.azure.core.amqp.models.DeliveryState.DeliveryState()" name: "DeliveryState()" nameWithType: "DeliveryState.DeliveryState()" - syntax: "public DeliveryState()" + summary: "Creates a new instance of without a value." + deprecatedTag: "Use one of the constants or the factory method." + syntax: "@Deprecated
public DeliveryState()" + desc: "Creates a new instance of without a value.\n\nThis constructor shouldn't be called as it will produce a which doesn't have a String enum value." + hasDeprecatedTag: true fields: - uid: "com.azure.core.amqp.models.DeliveryState.ACCEPTED" fullName: "com.azure.core.amqp.models.DeliveryState.ACCEPTED" @@ -138,4 +142,4 @@ type: "class" desc: "States for a message delivery." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.ModifiedDeliveryOutcome.yml b/docs-ref-autogen/com.azure.core.amqp.models.ModifiedDeliveryOutcome.yml index 95b05738f4f4..0cf74babe36b 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.ModifiedDeliveryOutcome.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.ModifiedDeliveryOutcome.yml @@ -110,4 +110,4 @@ type: "class" desc: "The modified outcome.\n\nAt the source the modified outcome means that the message is no longer acquired by the receiver, and has been made available for (re-)delivery to the same or other targets receiving from the node. The message has been changed at the node in the ways indicated by the fields of the outcome. As modified is a terminal outcome, transfer of payload data will not be able to be resumed if the link becomes suspended. A delivery can become modified at the source even before all transfer frames have been sent. This does not imply that the remaining transfers for the delivery will not be sent. The source MAY spontaneously attain the modified outcome for a message (for example the source might implement some sort of time-bound acquisition lock, after which the acquisition of a message at a node is revoked to allow for delivery to an alternative consumer with the message modified in some way to denote the previous failed, e.g., with delivery-failed set to true).\n\nAt the target, the modified outcome is used to indicate that a given transfer was not and will not be acted upon, and that the message SHOULD be modified in the specified ways at the node." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.ReceivedDeliveryOutcome.yml b/docs-ref-autogen/com.azure.core.amqp.models.ReceivedDeliveryOutcome.yml index 06674f929dd7..e4e73b3463e1 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.ReceivedDeliveryOutcome.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.ReceivedDeliveryOutcome.yml @@ -65,4 +65,4 @@ type: "class" desc: "Represents a partial message that was received." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.RejectedDeliveryOutcome.yml b/docs-ref-autogen/com.azure.core.amqp.models.RejectedDeliveryOutcome.yml index fe830620385d..aa2e60863bda 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.RejectedDeliveryOutcome.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.RejectedDeliveryOutcome.yml @@ -86,4 +86,4 @@ type: "class" desc: "The rejected delivery outcome.\n\nAt the target, the rejected outcome is used to indicate that an incoming message is invalid and therefore unprocessable. The rejected outcome when applied to a message will cause the delivery-count to be incremented in the header of the rejected message.\n\nAt the source, the rejected outcome means that the target has informed the source that the message was rejected, and the source has taken the necessary action. The delivery SHOULD NOT ever spontaneously attain the rejected state at the source." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.TransactionalDeliveryOutcome.yml b/docs-ref-autogen/com.azure.core.amqp.models.TransactionalDeliveryOutcome.yml index 20c372a1140e..ada9a0a8ab0c 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.TransactionalDeliveryOutcome.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.TransactionalDeliveryOutcome.yml @@ -76,4 +76,4 @@ type: "class" desc: "A transaction delivery outcome." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.models.yml b/docs-ref-autogen/com.azure.core.amqp.models.yml index 0dfa9c4a912f..f9e1b3538f8b 100644 --- a/docs-ref-autogen/com.azure.core.amqp.models.yml +++ b/docs-ref-autogen/com.azure.core.amqp.models.yml @@ -22,4 +22,4 @@ enums: desc: "Package containing classes related to AMQP models classes." metadata: {} package: "com.azure.core.amqp.models" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.amqp.yml b/docs-ref-autogen/com.azure.core.amqp.yml index 398147455ea8..299d4163334c 100644 --- a/docs-ref-autogen/com.azure.core.amqp.yml +++ b/docs-ref-autogen/com.azure.core.amqp.yml @@ -28,4 +28,4 @@ interfaces: desc: "Package containing classes common to AMQP protocol." metadata: {} package: "com.azure.core.amqp" -artifact: com.azure:azure-core-amqp:2.7.2 +artifact: com.azure:azure-core-amqp:2.8.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.BodyParam.yml b/docs-ref-autogen/com.azure.core.annotation.BodyParam.yml index 06d23dbcc97d..03c71886b87c 100644 --- a/docs-ref-autogen/com.azure.core.annotation.BodyParam.yml +++ b/docs-ref-autogen/com.azure.core.annotation.BodyParam.yml @@ -10,11 +10,13 @@ methods: fullName: "com.azure.core.annotation.BodyParam.value()" name: "value()" nameWithType: "BodyParam.value()" + summary: "Gets the Content-Type for the body." modifiers: - "abstract" syntax: "public abstract String value()" + desc: "Gets the Content-Type for the body." returns: - description: "the Content-Type that the body should be treated as" + description: "The Content-Type for the body." type: "String" type: "interface" desc: "Annotation to annotate a parameter to send to a REST endpoint as HTTP Request content.\n\nIf the parameter type extends `InputStream`, this payload is streamed to server through \"application/octet-stream\". Otherwise, the body is serialized first and sent as \"application/json\" or \"application/xml\", based on the serializer.\n\n**Example 1: Put JSON**\n\n```java\n@Put(\"subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/\"\n + \"virtualMachines/{vmName}\")\n VirtualMachine createOrUpdate(@PathParam(\"resourceGroupName\") String rgName,\n @PathParam(\"vmName\") String vmName,\n @PathParam(\"subscriptionId\") String subscriptionId,\n @BodyParam(\"application/json\") VirtualMachine vm);\n```\n\n**Example 2: Stream**\n\n```java\n@Post(\"formdata/stream/uploadfile\")\n void uploadFileViaBody(@BodyParam(\"application/octet-stream\") FileInputStream fileContent);\n```" @@ -22,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Delete.yml b/docs-ref-autogen/com.azure.core.annotation.Delete.yml index a76bb5867ff5..b5f8311c57b2 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Delete.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Delete.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.ExpectedResponses.yml b/docs-ref-autogen/com.azure.core.annotation.ExpectedResponses.yml index 166e65932928..eb40e157662b 100644 --- a/docs-ref-autogen/com.azure.core.annotation.ExpectedResponses.yml +++ b/docs-ref-autogen/com.azure.core.annotation.ExpectedResponses.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Fluent.yml b/docs-ref-autogen/com.azure.core.annotation.Fluent.yml index f41c9587be14..8b77f634caab 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Fluent.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Fluent.yml @@ -11,4 +11,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.FormParam.yml b/docs-ref-autogen/com.azure.core.annotation.FormParam.yml index 2f43af529829..7c70efe8b6c3 100644 --- a/docs-ref-autogen/com.azure.core.annotation.FormParam.yml +++ b/docs-ref-autogen/com.azure.core.annotation.FormParam.yml @@ -22,9 +22,11 @@ methods: fullName: "com.azure.core.annotation.FormParam.value()" name: "value()" nameWithType: "FormParam.value()" + summary: "Gets the name of the key in a key-value pair as part of the form data." modifiers: - "abstract" syntax: "public abstract String value()" + desc: "Gets the name of the key in a key-value pair as part of the form data." returns: description: "The name of the key in a key value pair as part of the form data." type: "String" @@ -34,4 +36,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Generated.yml b/docs-ref-autogen/com.azure.core.annotation.Generated.yml index 69f1d3f919b4..b3450e581e1d 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Generated.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Generated.yml @@ -11,4 +11,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Get.yml b/docs-ref-autogen/com.azure.core.annotation.Get.yml index 360991cbfd94..4a8d663a963a 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Get.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Get.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Head.yml b/docs-ref-autogen/com.azure.core.annotation.Head.yml index 1bacef889d61..5e202d6e8c8f 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Head.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Head.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.HeaderCollection.yml b/docs-ref-autogen/com.azure.core.annotation.HeaderCollection.yml index f3bb46b55a0a..19ffa28867d8 100644 --- a/docs-ref-autogen/com.azure.core.annotation.HeaderCollection.yml +++ b/docs-ref-autogen/com.azure.core.annotation.HeaderCollection.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.HeaderParam.yml b/docs-ref-autogen/com.azure.core.annotation.HeaderParam.yml index 680d7f67add6..ef4b82411cb7 100644 --- a/docs-ref-autogen/com.azure.core.annotation.HeaderParam.yml +++ b/docs-ref-autogen/com.azure.core.annotation.HeaderParam.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Headers.yml b/docs-ref-autogen/com.azure.core.annotation.Headers.yml index 19b36da1fba0..f90403f7d39a 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Headers.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Headers.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Host.yml b/docs-ref-autogen/com.azure.core.annotation.Host.yml index 483de083960b..748ab79abdbf 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Host.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Host.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.HostParam.yml b/docs-ref-autogen/com.azure.core.annotation.HostParam.yml index f4286a4eadd4..481e4a87c0b6 100644 --- a/docs-ref-autogen/com.azure.core.annotation.HostParam.yml +++ b/docs-ref-autogen/com.azure.core.annotation.HostParam.yml @@ -36,4 +36,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Immutable.yml b/docs-ref-autogen/com.azure.core.annotation.Immutable.yml index 455e84064c97..9f0cac586097 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Immutable.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Immutable.yml @@ -11,4 +11,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.JsonFlatten.yml b/docs-ref-autogen/com.azure.core.annotation.JsonFlatten.yml index 1369ee2c757b..1059438c7e43 100644 --- a/docs-ref-autogen/com.azure.core.annotation.JsonFlatten.yml +++ b/docs-ref-autogen/com.azure.core.annotation.JsonFlatten.yml @@ -11,4 +11,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Options.yml b/docs-ref-autogen/com.azure.core.annotation.Options.yml index f7671738c565..fd3f2956f032 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Options.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Options.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Patch.yml b/docs-ref-autogen/com.azure.core.annotation.Patch.yml index 7a2a635c9774..930c390f3217 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Patch.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Patch.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.PathParam.yml b/docs-ref-autogen/com.azure.core.annotation.PathParam.yml index 3932e2d4e7dd..c8c680b96c6c 100644 --- a/docs-ref-autogen/com.azure.core.annotation.PathParam.yml +++ b/docs-ref-autogen/com.azure.core.annotation.PathParam.yml @@ -36,4 +36,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Post.yml b/docs-ref-autogen/com.azure.core.annotation.Post.yml index d3910371ad9b..d105c497beb5 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Post.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Post.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.Put.yml b/docs-ref-autogen/com.azure.core.annotation.Put.yml index aa3758c1d8e0..3983e3d14fff 100644 --- a/docs-ref-autogen/com.azure.core.annotation.Put.yml +++ b/docs-ref-autogen/com.azure.core.annotation.Put.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.QueryParam.yml b/docs-ref-autogen/com.azure.core.annotation.QueryParam.yml index 0145a072c21b..18507a3a56fb 100644 --- a/docs-ref-autogen/com.azure.core.annotation.QueryParam.yml +++ b/docs-ref-autogen/com.azure.core.annotation.QueryParam.yml @@ -48,4 +48,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.ResumeOperation.yml b/docs-ref-autogen/com.azure.core.annotation.ResumeOperation.yml index 828ef70e1f33..3a9b355fe9df 100644 --- a/docs-ref-autogen/com.azure.core.annotation.ResumeOperation.yml +++ b/docs-ref-autogen/com.azure.core.annotation.ResumeOperation.yml @@ -13,4 +13,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.ReturnType.yml b/docs-ref-autogen/com.azure.core.annotation.ReturnType.yml index 9d487b2af1cd..f7ac7008bc44 100644 --- a/docs-ref-autogen/com.azure.core.annotation.ReturnType.yml +++ b/docs-ref-autogen/com.azure.core.annotation.ReturnType.yml @@ -73,4 +73,4 @@ methods: desc: "Enumeration of return types used with annotation to indicate if a method is expected to return a single item or a collection" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.ReturnValueWireType.yml b/docs-ref-autogen/com.azure.core.annotation.ReturnValueWireType.yml index d90ac55682c7..d77b83bf26d0 100644 --- a/docs-ref-autogen/com.azure.core.annotation.ReturnValueWireType.yml +++ b/docs-ref-autogen/com.azure.core.annotation.ReturnValueWireType.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.ServiceClient.yml b/docs-ref-autogen/com.azure.core.annotation.ServiceClient.yml index 68ce36005514..8fcb15a9607a 100644 --- a/docs-ref-autogen/com.azure.core.annotation.ServiceClient.yml +++ b/docs-ref-autogen/com.azure.core.annotation.ServiceClient.yml @@ -48,4 +48,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.ServiceClientBuilder.yml b/docs-ref-autogen/com.azure.core.annotation.ServiceClientBuilder.yml index 41e95c3ab92f..38a514f072e8 100644 --- a/docs-ref-autogen/com.azure.core.annotation.ServiceClientBuilder.yml +++ b/docs-ref-autogen/com.azure.core.annotation.ServiceClientBuilder.yml @@ -36,4 +36,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.ServiceClientProtocol.yml b/docs-ref-autogen/com.azure.core.annotation.ServiceClientProtocol.yml index fd3f89d7611d..1dfe1fbc94c4 100644 --- a/docs-ref-autogen/com.azure.core.annotation.ServiceClientProtocol.yml +++ b/docs-ref-autogen/com.azure.core.annotation.ServiceClientProtocol.yml @@ -67,4 +67,4 @@ methods: desc: "Enumeration of protocols available for setting the property of annotation." metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.ServiceInterface.yml b/docs-ref-autogen/com.azure.core.annotation.ServiceInterface.yml index 185954974a25..408d3244e182 100644 --- a/docs-ref-autogen/com.azure.core.annotation.ServiceInterface.yml +++ b/docs-ref-autogen/com.azure.core.annotation.ServiceInterface.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.ServiceMethod.yml b/docs-ref-autogen/com.azure.core.annotation.ServiceMethod.yml index c870ac513d3f..4dd3b1e68342 100644 --- a/docs-ref-autogen/com.azure.core.annotation.ServiceMethod.yml +++ b/docs-ref-autogen/com.azure.core.annotation.ServiceMethod.yml @@ -24,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.UnexpectedResponseExceptionType.yml b/docs-ref-autogen/com.azure.core.annotation.UnexpectedResponseExceptionType.yml index b4b96691aa5f..61fc9be52b1d 100644 --- a/docs-ref-autogen/com.azure.core.annotation.UnexpectedResponseExceptionType.yml +++ b/docs-ref-autogen/com.azure.core.annotation.UnexpectedResponseExceptionType.yml @@ -36,4 +36,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.UnexpectedResponseExceptionTypes.yml b/docs-ref-autogen/com.azure.core.annotation.UnexpectedResponseExceptionTypes.yml index 417b5323533f..09c5d4094131 100644 --- a/docs-ref-autogen/com.azure.core.annotation.UnexpectedResponseExceptionTypes.yml +++ b/docs-ref-autogen/com.azure.core.annotation.UnexpectedResponseExceptionTypes.yml @@ -10,9 +10,11 @@ methods: fullName: "com.azure.core.annotation.UnexpectedResponseExceptionTypes.value()" name: "value()" nameWithType: "UnexpectedResponseExceptionTypes.value()" + summary: "Gets an array of that annotate a method." modifiers: - "abstract" syntax: "public abstract UnexpectedResponseExceptionType[] value()" + desc: "Gets an array of that annotate a method." returns: description: "array of that annotate a method." type: "[]" @@ -22,4 +24,4 @@ implements: - "Annotation" metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.annotation.yml b/docs-ref-autogen/com.azure.core.annotation.yml index 39f39751525a..ad07935bd0e7 100644 --- a/docs-ref-autogen/com.azure.core.annotation.yml +++ b/docs-ref-autogen/com.azure.core.annotation.yml @@ -39,4 +39,4 @@ interfaces: desc: "Package containing annotations for client side methods that maps to REST APIs." metadata: {} package: "com.azure.core.annotation" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.client.traits.AzureKeyCredentialTrait.yml b/docs-ref-autogen/com.azure.core.client.traits.AzureKeyCredentialTrait.yml index 4efa484e58f5..8f82acb6ef33 100644 --- a/docs-ref-autogen/com.azure.core.client.traits.AzureKeyCredentialTrait.yml +++ b/docs-ref-autogen/com.azure.core.client.traits.AzureKeyCredentialTrait.yml @@ -29,4 +29,4 @@ typeParameters: desc: "An providing a consistent interface for setting . Refer to the Azure SDK for Java [identity and authentication][] documentation for more details on proper usage of the type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity" metadata: {} package: "com.azure.core.client.traits" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.client.traits.AzureNamedKeyCredentialTrait.yml b/docs-ref-autogen/com.azure.core.client.traits.AzureNamedKeyCredentialTrait.yml index 5d3db3351abb..d85b36b407fd 100644 --- a/docs-ref-autogen/com.azure.core.client.traits.AzureNamedKeyCredentialTrait.yml +++ b/docs-ref-autogen/com.azure.core.client.traits.AzureNamedKeyCredentialTrait.yml @@ -29,4 +29,4 @@ typeParameters: desc: "An providing a consistent interface for setting . Refer to the Azure SDK for Java [identity and authentication][] documentation for more details on proper usage of the type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity" metadata: {} package: "com.azure.core.client.traits" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.client.traits.AzureSasCredentialTrait.yml b/docs-ref-autogen/com.azure.core.client.traits.AzureSasCredentialTrait.yml index 9b5ea95150a4..32bc7ff47828 100644 --- a/docs-ref-autogen/com.azure.core.client.traits.AzureSasCredentialTrait.yml +++ b/docs-ref-autogen/com.azure.core.client.traits.AzureSasCredentialTrait.yml @@ -29,4 +29,4 @@ typeParameters: desc: "An providing a consistent interface for setting . Refer to the Azure SDK for Java [identity and authentication][] documentation for more details on proper usage of the type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity" metadata: {} package: "com.azure.core.client.traits" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.client.traits.ConfigurationTrait.yml b/docs-ref-autogen/com.azure.core.client.traits.ConfigurationTrait.yml index ab40e31041f4..1275cd86c39f 100644 --- a/docs-ref-autogen/com.azure.core.client.traits.ConfigurationTrait.yml +++ b/docs-ref-autogen/com.azure.core.client.traits.ConfigurationTrait.yml @@ -29,4 +29,4 @@ typeParameters: desc: "An providing a consistent interface for setting ." metadata: {} package: "com.azure.core.client.traits" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.client.traits.ConnectionStringTrait.yml b/docs-ref-autogen/com.azure.core.client.traits.ConnectionStringTrait.yml index e1174edcd228..6f4692db141b 100644 --- a/docs-ref-autogen/com.azure.core.client.traits.ConnectionStringTrait.yml +++ b/docs-ref-autogen/com.azure.core.client.traits.ConnectionStringTrait.yml @@ -29,4 +29,4 @@ typeParameters: desc: "An providing a consistent interface for setting connection strings." metadata: {} package: "com.azure.core.client.traits" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.client.traits.EndpointTrait.yml b/docs-ref-autogen/com.azure.core.client.traits.EndpointTrait.yml index a8115c48f936..3c47d3b4b9da 100644 --- a/docs-ref-autogen/com.azure.core.client.traits.EndpointTrait.yml +++ b/docs-ref-autogen/com.azure.core.client.traits.EndpointTrait.yml @@ -29,4 +29,4 @@ typeParameters: desc: "An providing a consistent interface for setting service endpoints." metadata: {} package: "com.azure.core.client.traits" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.client.traits.HttpTrait.yml b/docs-ref-autogen/com.azure.core.client.traits.HttpTrait.yml index 303590f23d7e..4f23744dee69 100644 --- a/docs-ref-autogen/com.azure.core.client.traits.HttpTrait.yml +++ b/docs-ref-autogen/com.azure.core.client.traits.HttpTrait.yml @@ -109,4 +109,4 @@ typeParameters: desc: "An providing a consistent interface for configuration of HTTP-specific settings. Refer to the Azure SDK for Java [HTTP clients and pipelines][] documentation for more details on proper usage and configuration of the Azure SDK for Java HTTP clients.\n\nIt is important to understand the precedence order of the HttpTrait APIs. In particular, if a is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\n\n[HTTP clients and pipelines]: https://aka.ms/azsdk/java/docs/http-client-pipeline" metadata: {} package: "com.azure.core.client.traits" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.client.traits.TokenCredentialTrait.yml b/docs-ref-autogen/com.azure.core.client.traits.TokenCredentialTrait.yml index ff7bf9482ada..38646d5ab36a 100644 --- a/docs-ref-autogen/com.azure.core.client.traits.TokenCredentialTrait.yml +++ b/docs-ref-autogen/com.azure.core.client.traits.TokenCredentialTrait.yml @@ -29,4 +29,4 @@ typeParameters: desc: "An providing a consistent interface for setting . Refer to the Azure SDK for Java [identity and authentication][] documentation for more details on proper usage of the type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity" metadata: {} package: "com.azure.core.client.traits" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.client.traits.yml b/docs-ref-autogen/com.azure.core.client.traits.yml index 0b2cd1a5de3c..1523a2bc3d49 100644 --- a/docs-ref-autogen/com.azure.core.client.traits.yml +++ b/docs-ref-autogen/com.azure.core.client.traits.yml @@ -15,4 +15,4 @@ interfaces: desc: "This package contains interfaces that represent common cross-cutting aspects of functionality offered by libraries\n in the Azure SDK for Java. Each interface is referred to as a 'trait', and classes that implement the interface are\n said to have that trait. There are additional traits related to AMQP use cases in the\n com.azure.core.amqp.client.traits package.\n\n

The particular focus of traits in the Azure SDK for Java is to enable higher-level\n libraries the ability to more abstractly configure client libraries as part of their builders, prior to the client\n itself being instantiated. By doing this, these high-level libraries are able to reason about functionality more\n simply. It is important to appreciate that despite the availability of these cross-cutting traits, there is no\n promise that configuration of each builder can simply be a matter of providing the same arguments for all builders!\n Each builder must be configured appropriately for its requirements, or else runtime failures may occur when the\n builder is asked to create the associated client.

" metadata: {} package: "com.azure.core.client.traits" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.credential.AccessToken.yml b/docs-ref-autogen/com.azure.core.credential.AccessToken.yml index 4fa2f720e080..310b8bef63fd 100644 --- a/docs-ref-autogen/com.azure.core.credential.AccessToken.yml +++ b/docs-ref-autogen/com.azure.core.credential.AccessToken.yml @@ -41,28 +41,34 @@ methods: fullName: "com.azure.core.credential.AccessToken.getExpiresAt()" name: "getExpiresAt()" nameWithType: "AccessToken.getExpiresAt()" + summary: "Gets the time when the token expires, in UTC." syntax: "public OffsetDateTime getExpiresAt()" + desc: "Gets the time when the token expires, in UTC." returns: - description: "the time when the token expires, in UTC." + description: "The time when the token expires, in UTC." type: "OffsetDateTime" - uid: "com.azure.core.credential.AccessToken.getToken()" fullName: "com.azure.core.credential.AccessToken.getToken()" name: "getToken()" nameWithType: "AccessToken.getToken()" + summary: "Gets the token." syntax: "public String getToken()" + desc: "Gets the token." returns: - description: "the token string." + description: "The token." type: "String" - uid: "com.azure.core.credential.AccessToken.isExpired()" fullName: "com.azure.core.credential.AccessToken.isExpired()" name: "isExpired()" nameWithType: "AccessToken.isExpired()" + summary: "Whether the token has expired." syntax: "public boolean isExpired()" + desc: "Whether the token has expired." returns: - description: "if the token has expired." + description: "Whether the token has expired." type: "" type: "class" desc: "Represents an immutable access token with a token string and an expiration time." metadata: {} package: "com.azure.core.credential" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.credential.AzureKeyCredential.yml b/docs-ref-autogen/com.azure.core.credential.AzureKeyCredential.yml index d570827d4d83..5bc7ad51473a 100644 --- a/docs-ref-autogen/com.azure.core.credential.AzureKeyCredential.yml +++ b/docs-ref-autogen/com.azure.core.credential.AzureKeyCredential.yml @@ -62,4 +62,4 @@ type: "class" desc: "Represents a credential that uses a key to authenticate to an Azure Service." metadata: {} package: "com.azure.core.credential" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.credential.AzureNamedKey.yml b/docs-ref-autogen/com.azure.core.credential.AzureNamedKey.yml index 2eac961e3e32..7d8a3976508b 100644 --- a/docs-ref-autogen/com.azure.core.credential.AzureNamedKey.yml +++ b/docs-ref-autogen/com.azure.core.credential.AzureNamedKey.yml @@ -46,4 +46,4 @@ type: "class" desc: "Represents a credential bag containing the key and the name of the key." metadata: {} package: "com.azure.core.credential" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.credential.AzureNamedKeyCredential.yml b/docs-ref-autogen/com.azure.core.credential.AzureNamedKeyCredential.yml index 70e1701743d1..28ab635c5a81 100644 --- a/docs-ref-autogen/com.azure.core.credential.AzureNamedKeyCredential.yml +++ b/docs-ref-autogen/com.azure.core.credential.AzureNamedKeyCredential.yml @@ -68,4 +68,4 @@ type: "class" desc: "Represents a credential with a key name and the key and uses the key to authenticate to an Azure Service.\n\nThe named credential can be created for keys which have a name identifier associated with them.\n\n**Code Samples**\n\nCreate a named credential for a service specific sas key.\n\n```java\nAzureNamedKeyCredential azureNamedKeyCredential =\n new AzureNamedKeyCredential(\"AZURE-SERVICE-SAS-KEY-NAME\", \"AZURE-SERVICE-SAS-KEY\");\n```" metadata: {} package: "com.azure.core.credential" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.credential.AzureSasCredential.yml b/docs-ref-autogen/com.azure.core.credential.AzureSasCredential.yml index da50599adaae..0449c8943349 100644 --- a/docs-ref-autogen/com.azure.core.credential.AzureSasCredential.yml +++ b/docs-ref-autogen/com.azure.core.credential.AzureSasCredential.yml @@ -76,4 +76,4 @@ type: "class" desc: "Represents a credential that uses a shared access signature to authenticate to an Azure Service." metadata: {} package: "com.azure.core.credential" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.credential.BasicAuthenticationCredential.yml b/docs-ref-autogen/com.azure.core.credential.BasicAuthenticationCredential.yml index 906f495d47a9..c06460c50504 100644 --- a/docs-ref-autogen/com.azure.core.credential.BasicAuthenticationCredential.yml +++ b/docs-ref-autogen/com.azure.core.credential.BasicAuthenticationCredential.yml @@ -55,4 +55,4 @@ implements: - "" metadata: {} package: "com.azure.core.credential" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.credential.SimpleTokenCache.yml b/docs-ref-autogen/com.azure.core.credential.SimpleTokenCache.yml index 43121164a93f..1f32a3ca7740 100644 --- a/docs-ref-autogen/com.azure.core.credential.SimpleTokenCache.yml +++ b/docs-ref-autogen/com.azure.core.credential.SimpleTokenCache.yml @@ -48,4 +48,4 @@ type: "class" desc: "A token cache that supports caching a token and refreshing it." metadata: {} package: "com.azure.core.credential" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.credential.TokenCredential.yml b/docs-ref-autogen/com.azure.core.credential.TokenCredential.yml index 6330c8a0c2c5..fddf1f0d6f22 100644 --- a/docs-ref-autogen/com.azure.core.credential.TokenCredential.yml +++ b/docs-ref-autogen/com.azure.core.credential.TokenCredential.yml @@ -42,4 +42,4 @@ type: "interface" desc: "The interface for credentials that can provide a token." metadata: {} package: "com.azure.core.credential" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.credential.TokenRequestContext.yml b/docs-ref-autogen/com.azure.core.credential.TokenRequestContext.yml index 39002f79cf0c..c9a52c78396f 100644 --- a/docs-ref-autogen/com.azure.core.credential.TokenRequestContext.yml +++ b/docs-ref-autogen/com.azure.core.credential.TokenRequestContext.yml @@ -120,4 +120,4 @@ type: "class" desc: "Contains details of a request to get a token." metadata: {} package: "com.azure.core.credential" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.credential.yml b/docs-ref-autogen/com.azure.core.credential.yml index cb090da3628b..7b53647df287 100644 --- a/docs-ref-autogen/com.azure.core.credential.yml +++ b/docs-ref-autogen/com.azure.core.credential.yml @@ -17,4 +17,4 @@ interfaces: desc: "Package containing basic credential classes for authentication purposes." metadata: {} package: "com.azure.core.credential" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.cryptography.AsyncKeyEncryptionKey.yml b/docs-ref-autogen/com.azure.core.cryptography.AsyncKeyEncryptionKey.yml index c6bbca1d1e96..fa4ec40cc548 100644 --- a/docs-ref-autogen/com.azure.core.cryptography.AsyncKeyEncryptionKey.yml +++ b/docs-ref-autogen/com.azure.core.cryptography.AsyncKeyEncryptionKey.yml @@ -60,4 +60,4 @@ type: "interface" desc: "A key which is used to asynchronously encrypt, or wrap, another key." metadata: {} package: "com.azure.core.cryptography" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.cryptography.AsyncKeyEncryptionKeyResolver.yml b/docs-ref-autogen/com.azure.core.cryptography.AsyncKeyEncryptionKeyResolver.yml index 9aacd2a5a2b8..3ca2ae55f1fa 100644 --- a/docs-ref-autogen/com.azure.core.cryptography.AsyncKeyEncryptionKeyResolver.yml +++ b/docs-ref-autogen/com.azure.core.cryptography.AsyncKeyEncryptionKeyResolver.yml @@ -26,4 +26,4 @@ type: "interface" desc: "An object capable of asynchronously retrieving key encryption keys from a provided key identifier." metadata: {} package: "com.azure.core.cryptography" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.cryptography.KeyEncryptionKey.yml b/docs-ref-autogen/com.azure.core.cryptography.KeyEncryptionKey.yml index 7c42a35986d3..cd4674676623 100644 --- a/docs-ref-autogen/com.azure.core.cryptography.KeyEncryptionKey.yml +++ b/docs-ref-autogen/com.azure.core.cryptography.KeyEncryptionKey.yml @@ -60,4 +60,4 @@ type: "interface" desc: "A key which is used to synchronously encrypt, or wrap, another key." metadata: {} package: "com.azure.core.cryptography" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.cryptography.KeyEncryptionKeyResolver.yml b/docs-ref-autogen/com.azure.core.cryptography.KeyEncryptionKeyResolver.yml index 93f8fdbb6d25..43f980d36d39 100644 --- a/docs-ref-autogen/com.azure.core.cryptography.KeyEncryptionKeyResolver.yml +++ b/docs-ref-autogen/com.azure.core.cryptography.KeyEncryptionKeyResolver.yml @@ -26,4 +26,4 @@ type: "interface" desc: "An object capable of synchronously retrieving key encryption keys from a provided key identifier." metadata: {} package: "com.azure.core.cryptography" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.cryptography.yml b/docs-ref-autogen/com.azure.core.cryptography.yml index 5acf9f572d9d..6bb3c1606ef4 100644 --- a/docs-ref-autogen/com.azure.core.cryptography.yml +++ b/docs-ref-autogen/com.azure.core.cryptography.yml @@ -11,4 +11,4 @@ interfaces: desc: "Package containing core cryptography interfaces." metadata: {} package: "com.azure.core.cryptography" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.AzureException.yml b/docs-ref-autogen/com.azure.core.exception.AzureException.yml index 9ed20295ed6a..e675fabe2bb7 100644 --- a/docs-ref-autogen/com.azure.core.exception.AzureException.yml +++ b/docs-ref-autogen/com.azure.core.exception.AzureException.yml @@ -106,4 +106,4 @@ type: "class" desc: "The base Azure exception." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.ClientAuthenticationException.yml b/docs-ref-autogen/com.azure.core.exception.ClientAuthenticationException.yml index 1f0ff5e8dc72..4d4775eaf3ff 100644 --- a/docs-ref-autogen/com.azure.core.exception.ClientAuthenticationException.yml +++ b/docs-ref-autogen/com.azure.core.exception.ClientAuthenticationException.yml @@ -97,4 +97,4 @@ type: "class" desc: "The exception thrown when failed to authenticate the client request with status code of 4XX, typically 401 unauthorized. A runtime exception indicating request authorization failure caused by one of the following scenarios:\n\n * A client did not send the required authorization credentials to access the requested resource, i.e. Authorization HTTP header is missing in the request\n * If the request contains the HTTP Authorization header, then the exception indicates that authorization has been refused for the credentials contained in the request header." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.DecodeException.yml b/docs-ref-autogen/com.azure.core.exception.DecodeException.yml index cd23f9a1838d..408d493bd82c 100644 --- a/docs-ref-autogen/com.azure.core.exception.DecodeException.yml +++ b/docs-ref-autogen/com.azure.core.exception.DecodeException.yml @@ -97,4 +97,4 @@ type: "class" desc: "Error raised during response deserialization. The HTTP response could not be decoded." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.HttpRequestException.yml b/docs-ref-autogen/com.azure.core.exception.HttpRequestException.yml index 6dc6e1952fe2..b3e50ce3e82b 100644 --- a/docs-ref-autogen/com.azure.core.exception.HttpRequestException.yml +++ b/docs-ref-autogen/com.azure.core.exception.HttpRequestException.yml @@ -124,7 +124,9 @@ methods: fullName: "com.azure.core.exception.HttpRequestException.getRequest()" name: "getRequest()" nameWithType: "HttpRequestException.getRequest()" + summary: "Gets the being sent when the exception occurred." syntax: "public HttpRequest getRequest()" + desc: "Gets the being sent when the exception occurred." returns: description: "The being sent when the exception occurred." type: "" @@ -132,4 +134,4 @@ type: "class" desc: "The exception when an HTTP request fails.\n\nGenerally, these errors are safe to retry." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.HttpResponseException.yml b/docs-ref-autogen/com.azure.core.exception.HttpResponseException.yml index a6be8aa8f815..24ba369e6e11 100644 --- a/docs-ref-autogen/com.azure.core.exception.HttpResponseException.yml +++ b/docs-ref-autogen/com.azure.core.exception.HttpResponseException.yml @@ -141,7 +141,9 @@ methods: fullName: "com.azure.core.exception.HttpResponseException.getResponse()" name: "getResponse()" nameWithType: "HttpResponseException.getResponse()" + summary: "Gets the received that is associated to the exception." syntax: "public HttpResponse getResponse()" + desc: "Gets the received that is associated to the exception." returns: description: "The received that is associated to the exception." type: "" @@ -149,7 +151,9 @@ methods: fullName: "com.azure.core.exception.HttpResponseException.getValue()" name: "getValue()" nameWithType: "HttpResponseException.getValue()" + summary: "Gets the deserialized HTTP response value." syntax: "public Object getValue()" + desc: "Gets the deserialized HTTP response value." returns: description: "The deserialized HTTP response value." type: "Object" @@ -157,4 +161,4 @@ type: "class" desc: "The exception thrown when an unsuccessful response is received with http status code (e.g. 3XX, 4XX, 5XX) from the service request." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.ResourceExistsException.yml b/docs-ref-autogen/com.azure.core.exception.ResourceExistsException.yml index d81760348835..deef47a7d706 100644 --- a/docs-ref-autogen/com.azure.core.exception.ResourceExistsException.yml +++ b/docs-ref-autogen/com.azure.core.exception.ResourceExistsException.yml @@ -97,4 +97,4 @@ type: "class" desc: "The exception thrown when HTTP request tried to create an already existing resource with status code of 4XX, typically 412 conflict." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.ResourceModifiedException.yml b/docs-ref-autogen/com.azure.core.exception.ResourceModifiedException.yml index 13224f615cc4..de660183ae9f 100644 --- a/docs-ref-autogen/com.azure.core.exception.ResourceModifiedException.yml +++ b/docs-ref-autogen/com.azure.core.exception.ResourceModifiedException.yml @@ -97,4 +97,4 @@ type: "class" desc: "The exception thrown for invalid resource modification with status code of 4XX, typically 409 Conflict." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.ResourceNotFoundException.yml b/docs-ref-autogen/com.azure.core.exception.ResourceNotFoundException.yml index e512e2115e00..0052b005edbe 100644 --- a/docs-ref-autogen/com.azure.core.exception.ResourceNotFoundException.yml +++ b/docs-ref-autogen/com.azure.core.exception.ResourceNotFoundException.yml @@ -97,4 +97,4 @@ type: "class" desc: "An error response, typically triggered by a 412 response (for update) or 404 (for get/post)" metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.ServiceResponseException.yml b/docs-ref-autogen/com.azure.core.exception.ServiceResponseException.yml index 053bf7e86fb6..6304d1e6eb65 100644 --- a/docs-ref-autogen/com.azure.core.exception.ServiceResponseException.yml +++ b/docs-ref-autogen/com.azure.core.exception.ServiceResponseException.yml @@ -69,4 +69,4 @@ type: "class" desc: "A runtime exception indicating service response failure caused by one of the following scenarios:\n\n1. The request was sent, but the client failed to understand the response. (Not in the right format, partial response, etc.).\n2. The connection may have timed out. These errors can be retried for idempotent or safe operations." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.TooManyRedirectsException.yml b/docs-ref-autogen/com.azure.core.exception.TooManyRedirectsException.yml index 85808ed1b751..3415e6dcf2b7 100644 --- a/docs-ref-autogen/com.azure.core.exception.TooManyRedirectsException.yml +++ b/docs-ref-autogen/com.azure.core.exception.TooManyRedirectsException.yml @@ -97,4 +97,4 @@ type: "class" desc: "This exception is thrown when an HTTP request has reached the maximum number of redirect attempts with HTTP status code of 3XX." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.UnexpectedLengthException.yml b/docs-ref-autogen/com.azure.core.exception.UnexpectedLengthException.yml index 12c97ccd0258..09f53f9aa367 100644 --- a/docs-ref-autogen/com.azure.core.exception.UnexpectedLengthException.yml +++ b/docs-ref-autogen/com.azure.core.exception.UnexpectedLengthException.yml @@ -82,4 +82,4 @@ type: "class" desc: "This exception class represents an error when the specified input length doesn't match the data length." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.exception.yml b/docs-ref-autogen/com.azure.core.exception.yml index 012ba5e8063b..1f5af2ac5b1f 100644 --- a/docs-ref-autogen/com.azure.core.exception.yml +++ b/docs-ref-autogen/com.azure.core.exception.yml @@ -18,4 +18,4 @@ classes: desc: "Package containing core exception classes." metadata: {} package: "com.azure.core.exception" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.ContentType.yml b/docs-ref-autogen/com.azure.core.http.ContentType.yml index e527f43c1798..ae3a3ebbf0e7 100644 --- a/docs-ref-autogen/com.azure.core.http.ContentType.yml +++ b/docs-ref-autogen/com.azure.core.http.ContentType.yml @@ -65,4 +65,4 @@ type: "class" desc: "The different values that commonly used for Content-Type header." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpAuthorization.yml b/docs-ref-autogen/com.azure.core.http.HttpAuthorization.yml index 07323c384e9c..0b45f4282850 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpAuthorization.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpAuthorization.yml @@ -41,7 +41,9 @@ methods: fullName: "com.azure.core.http.HttpAuthorization.getParameter()" name: "getParameter()" nameWithType: "HttpAuthorization.getParameter()" + summary: "Gets the credential of the authorization header." syntax: "public String getParameter()" + desc: "Gets the credential of the authorization header." returns: description: "Credential of the authorization header." type: "String" @@ -49,7 +51,9 @@ methods: fullName: "com.azure.core.http.HttpAuthorization.getScheme()" name: "getScheme()" nameWithType: "HttpAuthorization.getScheme()" + summary: "Gets the scheme of the authorization header." syntax: "public String getScheme()" + desc: "Gets the scheme of the authorization header." returns: description: "Scheme of the authorization header." type: "String" @@ -65,4 +69,4 @@ type: "class" desc: "Represents the value of an HTTP Authorization header." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpClient.yml b/docs-ref-autogen/com.azure.core.http.HttpClient.yml index 9f22dd54a939..58bfc114d752 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpClient.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpClient.yml @@ -92,4 +92,4 @@ type: "interface" desc: "A generic interface for sending HTTP requests and getting responses." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpClientProvider.yml b/docs-ref-autogen/com.azure.core.http.HttpClientProvider.yml index 9ddfc5af1d52..fe15257f6aa7 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpClientProvider.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpClientProvider.yml @@ -38,4 +38,4 @@ type: "interface" desc: "An interface to be implemented by any azure-core plugin that wishes to provide an alternate implementation." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpHeader.yml b/docs-ref-autogen/com.azure.core.http.HttpHeader.yml index 4680a9d5ae10..fab650815e57 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpHeader.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpHeader.yml @@ -62,4 +62,4 @@ type: "class" desc: "A single header within an HTTP request or response.\n\nIf multiple header values are added to an HTTP request or response with the same name (case-insensitive), then the values will be appended to the end of the same Header with commas separating them." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpHeaderName.yml b/docs-ref-autogen/com.azure.core.http.HttpHeaderName.yml new file mode 100644 index 000000000000..d3b51fa96620 --- /dev/null +++ b/docs-ref-autogen/com.azure.core.http.HttpHeaderName.yml @@ -0,0 +1,892 @@ +### YamlMime:JavaType +uid: "com.azure.core.http.HttpHeaderName" +fullName: "com.azure.core.http.HttpHeaderName" +name: "HttpHeaderName" +nameWithType: "HttpHeaderName" +summary: "Represents HTTP header names for multiple versions of HTTP." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **HttpHeaderName**
extends <>" +constructors: +- uid: "com.azure.core.http.HttpHeaderName.HttpHeaderName()" + fullName: "com.azure.core.http.HttpHeaderName.HttpHeaderName()" + name: "HttpHeaderName()" + nameWithType: "HttpHeaderName.HttpHeaderName()" + summary: "Creates a new instance of without a value." + deprecatedTag: "Use one of the constants or the factory method." + syntax: "@Deprecated
public HttpHeaderName()" + desc: "Creates a new instance of without a value.\n\nThis constructor shouldn't be called as it will produce a which doesn't have a String enum value." + hasDeprecatedTag: true +fields: +- uid: "com.azure.core.http.HttpHeaderName.ACCEPT" + fullName: "com.azure.core.http.HttpHeaderName.ACCEPT" + name: "ACCEPT" + nameWithType: "HttpHeaderName.ACCEPT" + summary: "`Accept`/`accept`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCEPT" + desc: "`Accept`/`accept`" +- uid: "com.azure.core.http.HttpHeaderName.ACCEPT_CHARSET" + fullName: "com.azure.core.http.HttpHeaderName.ACCEPT_CHARSET" + name: "ACCEPT_CHARSET" + nameWithType: "HttpHeaderName.ACCEPT_CHARSET" + summary: "`Accept-Charset`/`accept-charset`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCEPT_CHARSET" + desc: "`Accept-Charset`/`accept-charset`" +- uid: "com.azure.core.http.HttpHeaderName.ACCEPT_DATETIME" + fullName: "com.azure.core.http.HttpHeaderName.ACCEPT_DATETIME" + name: "ACCEPT_DATETIME" + nameWithType: "HttpHeaderName.ACCEPT_DATETIME" + summary: "`Accept-Datetime`/`accept-datetime`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCEPT_DATETIME" + desc: "`Accept-Datetime`/`accept-datetime`" +- uid: "com.azure.core.http.HttpHeaderName.ACCEPT_ENCODING" + fullName: "com.azure.core.http.HttpHeaderName.ACCEPT_ENCODING" + name: "ACCEPT_ENCODING" + nameWithType: "HttpHeaderName.ACCEPT_ENCODING" + summary: "`Accept-Encoding`/`accept-encoding`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCEPT_ENCODING" + desc: "`Accept-Encoding`/`accept-encoding`" +- uid: "com.azure.core.http.HttpHeaderName.ACCEPT_LANGUAGE" + fullName: "com.azure.core.http.HttpHeaderName.ACCEPT_LANGUAGE" + name: "ACCEPT_LANGUAGE" + nameWithType: "HttpHeaderName.ACCEPT_LANGUAGE" + summary: "`Accept-Language`/`accept-language`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCEPT_LANGUAGE" + desc: "`Accept-Language`/`accept-language`" +- uid: "com.azure.core.http.HttpHeaderName.ACCEPT_PATCH" + fullName: "com.azure.core.http.HttpHeaderName.ACCEPT_PATCH" + name: "ACCEPT_PATCH" + nameWithType: "HttpHeaderName.ACCEPT_PATCH" + summary: "`Accept-Patch`/`accept-patch`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCEPT_PATCH" + desc: "`Accept-Patch`/`accept-patch`" +- uid: "com.azure.core.http.HttpHeaderName.ACCEPT_RANGES" + fullName: "com.azure.core.http.HttpHeaderName.ACCEPT_RANGES" + name: "ACCEPT_RANGES" + nameWithType: "HttpHeaderName.ACCEPT_RANGES" + summary: "`Accept-Ranges`/`accept-ranges`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCEPT_RANGES" + desc: "`Accept-Ranges`/`accept-ranges`" +- uid: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_ALLOW_CREDENTIALS" + fullName: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_ALLOW_CREDENTIALS" + name: "ACCESS_CONTROL_ALLOW_CREDENTIALS" + nameWithType: "HttpHeaderName.ACCESS_CONTROL_ALLOW_CREDENTIALS" + summary: "`Access-Control-Allow-Credentials`/`access-control-allow-credentials`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCESS_CONTROL_ALLOW_CREDENTIALS" + desc: "`Access-Control-Allow-Credentials`/`access-control-allow-credentials`" +- uid: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_ALLOW_HEADERS" + fullName: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_ALLOW_HEADERS" + name: "ACCESS_CONTROL_ALLOW_HEADERS" + nameWithType: "HttpHeaderName.ACCESS_CONTROL_ALLOW_HEADERS" + summary: "`Access-Control-Allow-Headers`/`access-control-allow-headers`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCESS_CONTROL_ALLOW_HEADERS" + desc: "`Access-Control-Allow-Headers`/`access-control-allow-headers`" +- uid: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_ALLOW_METHODS" + fullName: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_ALLOW_METHODS" + name: "ACCESS_CONTROL_ALLOW_METHODS" + nameWithType: "HttpHeaderName.ACCESS_CONTROL_ALLOW_METHODS" + summary: "`Access-Control-Allow-Methods`/`access-control-allow-methods`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCESS_CONTROL_ALLOW_METHODS" + desc: "`Access-Control-Allow-Methods`/`access-control-allow-methods`" +- uid: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_ALLOW_ORIGIN" + fullName: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_ALLOW_ORIGIN" + name: "ACCESS_CONTROL_ALLOW_ORIGIN" + nameWithType: "HttpHeaderName.ACCESS_CONTROL_ALLOW_ORIGIN" + summary: "`Access-Control-Allow-Origin`/`access-control-allow-origin`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCESS_CONTROL_ALLOW_ORIGIN" + desc: "`Access-Control-Allow-Origin`/`access-control-allow-origin`" +- uid: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_EXPOSE_HEADERS" + fullName: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_EXPOSE_HEADERS" + name: "ACCESS_CONTROL_EXPOSE_HEADERS" + nameWithType: "HttpHeaderName.ACCESS_CONTROL_EXPOSE_HEADERS" + summary: "`Access-Control-Expose-Headers`/`access-control-expose-headers`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCESS_CONTROL_EXPOSE_HEADERS" + desc: "`Access-Control-Expose-Headers`/`access-control-expose-headers`" +- uid: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_MAX_AGE" + fullName: "com.azure.core.http.HttpHeaderName.ACCESS_CONTROL_MAX_AGE" + name: "ACCESS_CONTROL_MAX_AGE" + nameWithType: "HttpHeaderName.ACCESS_CONTROL_MAX_AGE" + summary: "`Access-Control-Max-Age`/`access-control-max-age`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ACCESS_CONTROL_MAX_AGE" + desc: "`Access-Control-Max-Age`/`access-control-max-age`" +- uid: "com.azure.core.http.HttpHeaderName.AGE" + fullName: "com.azure.core.http.HttpHeaderName.AGE" + name: "AGE" + nameWithType: "HttpHeaderName.AGE" + summary: "`Age`/`age`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName AGE" + desc: "`Age`/`age`" +- uid: "com.azure.core.http.HttpHeaderName.ALLOW" + fullName: "com.azure.core.http.HttpHeaderName.ALLOW" + name: "ALLOW" + nameWithType: "HttpHeaderName.ALLOW" + summary: "`Allow`/`allow`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ALLOW" + desc: "`Allow`/`allow`" +- uid: "com.azure.core.http.HttpHeaderName.AUTHORIZATION" + fullName: "com.azure.core.http.HttpHeaderName.AUTHORIZATION" + name: "AUTHORIZATION" + nameWithType: "HttpHeaderName.AUTHORIZATION" + summary: "`Authorization`/`authorization`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName AUTHORIZATION" + desc: "`Authorization`/`authorization`" +- uid: "com.azure.core.http.HttpHeaderName.CACHE_CONTROL" + fullName: "com.azure.core.http.HttpHeaderName.CACHE_CONTROL" + name: "CACHE_CONTROL" + nameWithType: "HttpHeaderName.CACHE_CONTROL" + summary: "`Cache-Control`/`cache-control`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName CACHE_CONTROL" + desc: "`Cache-Control`/`cache-control`" +- uid: "com.azure.core.http.HttpHeaderName.CONNECTION" + fullName: "com.azure.core.http.HttpHeaderName.CONNECTION" + name: "CONNECTION" + nameWithType: "HttpHeaderName.CONNECTION" + summary: "`Connection`/`connection`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName CONNECTION" + desc: "`Connection`/`connection`" +- uid: "com.azure.core.http.HttpHeaderName.CONTENT_DISPOSITION" + fullName: "com.azure.core.http.HttpHeaderName.CONTENT_DISPOSITION" + name: "CONTENT_DISPOSITION" + nameWithType: "HttpHeaderName.CONTENT_DISPOSITION" + summary: "`Content-Disposition`/`content-disposition`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName CONTENT_DISPOSITION" + desc: "`Content-Disposition`/`content-disposition`" +- uid: "com.azure.core.http.HttpHeaderName.CONTENT_ENCODING" + fullName: "com.azure.core.http.HttpHeaderName.CONTENT_ENCODING" + name: "CONTENT_ENCODING" + nameWithType: "HttpHeaderName.CONTENT_ENCODING" + summary: "`Content-Encoding`/`content-encoding`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName CONTENT_ENCODING" + desc: "`Content-Encoding`/`content-encoding`" +- uid: "com.azure.core.http.HttpHeaderName.CONTENT_LANGUAGE" + fullName: "com.azure.core.http.HttpHeaderName.CONTENT_LANGUAGE" + name: "CONTENT_LANGUAGE" + nameWithType: "HttpHeaderName.CONTENT_LANGUAGE" + summary: "`Content-Language`/`content-language`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName CONTENT_LANGUAGE" + desc: "`Content-Language`/`content-language`" +- uid: "com.azure.core.http.HttpHeaderName.CONTENT_LENGTH" + fullName: "com.azure.core.http.HttpHeaderName.CONTENT_LENGTH" + name: "CONTENT_LENGTH" + nameWithType: "HttpHeaderName.CONTENT_LENGTH" + summary: "`Content-Length`/`content-length`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName CONTENT_LENGTH" + desc: "`Content-Length`/`content-length`" +- uid: "com.azure.core.http.HttpHeaderName.CONTENT_LOCATION" + fullName: "com.azure.core.http.HttpHeaderName.CONTENT_LOCATION" + name: "CONTENT_LOCATION" + nameWithType: "HttpHeaderName.CONTENT_LOCATION" + summary: "`Content-Location`/`content-location`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName CONTENT_LOCATION" + desc: "`Content-Location`/`content-location`" +- uid: "com.azure.core.http.HttpHeaderName.CONTENT_MD5" + fullName: "com.azure.core.http.HttpHeaderName.CONTENT_MD5" + name: "CONTENT_MD5" + nameWithType: "HttpHeaderName.CONTENT_MD5" + summary: "`Content-MD5`/`content-md5`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName CONTENT_MD5" + desc: "`Content-MD5`/`content-md5`" +- uid: "com.azure.core.http.HttpHeaderName.CONTENT_RANGE" + fullName: "com.azure.core.http.HttpHeaderName.CONTENT_RANGE" + name: "CONTENT_RANGE" + nameWithType: "HttpHeaderName.CONTENT_RANGE" + summary: "`Content-Range`/`content-range`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName CONTENT_RANGE" + desc: "`Content-Range`/`content-range`" +- uid: "com.azure.core.http.HttpHeaderName.CONTENT_TYPE" + fullName: "com.azure.core.http.HttpHeaderName.CONTENT_TYPE" + name: "CONTENT_TYPE" + nameWithType: "HttpHeaderName.CONTENT_TYPE" + summary: "`Content-Type`/`content-type`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName CONTENT_TYPE" + desc: "`Content-Type`/`content-type`" +- uid: "com.azure.core.http.HttpHeaderName.COOKIE" + fullName: "com.azure.core.http.HttpHeaderName.COOKIE" + name: "COOKIE" + nameWithType: "HttpHeaderName.COOKIE" + summary: "`Cookie`/`cookie`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName COOKIE" + desc: "`Cookie`/`cookie`" +- uid: "com.azure.core.http.HttpHeaderName.DATE" + fullName: "com.azure.core.http.HttpHeaderName.DATE" + name: "DATE" + nameWithType: "HttpHeaderName.DATE" + summary: "`Date`/`date`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName DATE" + desc: "`Date`/`date`" +- uid: "com.azure.core.http.HttpHeaderName.ETAG" + fullName: "com.azure.core.http.HttpHeaderName.ETAG" + name: "ETAG" + nameWithType: "HttpHeaderName.ETAG" + summary: "`ETag`/`etag`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ETAG" + desc: "`ETag`/`etag`" +- uid: "com.azure.core.http.HttpHeaderName.EXPECT" + fullName: "com.azure.core.http.HttpHeaderName.EXPECT" + name: "EXPECT" + nameWithType: "HttpHeaderName.EXPECT" + summary: "`Expect`/`expect`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName EXPECT" + desc: "`Expect`/`expect`" +- uid: "com.azure.core.http.HttpHeaderName.EXPIRES" + fullName: "com.azure.core.http.HttpHeaderName.EXPIRES" + name: "EXPIRES" + nameWithType: "HttpHeaderName.EXPIRES" + summary: "`Expires`/`expires`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName EXPIRES" + desc: "`Expires`/`expires`" +- uid: "com.azure.core.http.HttpHeaderName.FORWARDED" + fullName: "com.azure.core.http.HttpHeaderName.FORWARDED" + name: "FORWARDED" + nameWithType: "HttpHeaderName.FORWARDED" + summary: "`Forwarded`/`forwarded`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName FORWARDED" + desc: "`Forwarded`/`forwarded`" +- uid: "com.azure.core.http.HttpHeaderName.FROM" + fullName: "com.azure.core.http.HttpHeaderName.FROM" + name: "FROM" + nameWithType: "HttpHeaderName.FROM" + summary: "`From`/`from`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName FROM" + desc: "`From`/`from`" +- uid: "com.azure.core.http.HttpHeaderName.HOST" + fullName: "com.azure.core.http.HttpHeaderName.HOST" + name: "HOST" + nameWithType: "HttpHeaderName.HOST" + summary: "`Host`/`host`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName HOST" + desc: "`Host`/`host`" +- uid: "com.azure.core.http.HttpHeaderName.HTTP2_SETTINGS" + fullName: "com.azure.core.http.HttpHeaderName.HTTP2_SETTINGS" + name: "HTTP2_SETTINGS" + nameWithType: "HttpHeaderName.HTTP2_SETTINGS" + summary: "`HTTP2-Settings`/`http2-settings`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName HTTP2_SETTINGS" + desc: "`HTTP2-Settings`/`http2-settings`" +- uid: "com.azure.core.http.HttpHeaderName.IF_MATCH" + fullName: "com.azure.core.http.HttpHeaderName.IF_MATCH" + name: "IF_MATCH" + nameWithType: "HttpHeaderName.IF_MATCH" + summary: "`If-Match`/`if-match`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName IF_MATCH" + desc: "`If-Match`/`if-match`" +- uid: "com.azure.core.http.HttpHeaderName.IF_MODIFIED_SINCE" + fullName: "com.azure.core.http.HttpHeaderName.IF_MODIFIED_SINCE" + name: "IF_MODIFIED_SINCE" + nameWithType: "HttpHeaderName.IF_MODIFIED_SINCE" + summary: "`If-Modified-Since`/`if-modified-since`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName IF_MODIFIED_SINCE" + desc: "`If-Modified-Since`/`if-modified-since`" +- uid: "com.azure.core.http.HttpHeaderName.IF_NONE_MATCH" + fullName: "com.azure.core.http.HttpHeaderName.IF_NONE_MATCH" + name: "IF_NONE_MATCH" + nameWithType: "HttpHeaderName.IF_NONE_MATCH" + summary: "`If-None-Match`/`if-none-match`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName IF_NONE_MATCH" + desc: "`If-None-Match`/`if-none-match`" +- uid: "com.azure.core.http.HttpHeaderName.IF_RANGE" + fullName: "com.azure.core.http.HttpHeaderName.IF_RANGE" + name: "IF_RANGE" + nameWithType: "HttpHeaderName.IF_RANGE" + summary: "`If-Range`/`if-range`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName IF_RANGE" + desc: "`If-Range`/`if-range`" +- uid: "com.azure.core.http.HttpHeaderName.IF_UNMODIFIED_SINCE" + fullName: "com.azure.core.http.HttpHeaderName.IF_UNMODIFIED_SINCE" + name: "IF_UNMODIFIED_SINCE" + nameWithType: "HttpHeaderName.IF_UNMODIFIED_SINCE" + summary: "`If-Unmodified-Since`/`if-unmodified-since`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName IF_UNMODIFIED_SINCE" + desc: "`If-Unmodified-Since`/`if-unmodified-since`" +- uid: "com.azure.core.http.HttpHeaderName.LAST_MODIFIED" + fullName: "com.azure.core.http.HttpHeaderName.LAST_MODIFIED" + name: "LAST_MODIFIED" + nameWithType: "HttpHeaderName.LAST_MODIFIED" + summary: "`Last-Modified`/`last-modified`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName LAST_MODIFIED" + desc: "`Last-Modified`/`last-modified`" +- uid: "com.azure.core.http.HttpHeaderName.LINK" + fullName: "com.azure.core.http.HttpHeaderName.LINK" + name: "LINK" + nameWithType: "HttpHeaderName.LINK" + summary: "`Link`/`link`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName LINK" + desc: "`Link`/`link`" +- uid: "com.azure.core.http.HttpHeaderName.LOCATION" + fullName: "com.azure.core.http.HttpHeaderName.LOCATION" + name: "LOCATION" + nameWithType: "HttpHeaderName.LOCATION" + summary: "`Location`/`location`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName LOCATION" + desc: "`Location`/`location`" +- uid: "com.azure.core.http.HttpHeaderName.MAX_FORWARDS" + fullName: "com.azure.core.http.HttpHeaderName.MAX_FORWARDS" + name: "MAX_FORWARDS" + nameWithType: "HttpHeaderName.MAX_FORWARDS" + summary: "`Max-Forwards`/`max-forwards`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName MAX_FORWARDS" + desc: "`Max-Forwards`/`max-forwards`" +- uid: "com.azure.core.http.HttpHeaderName.ORIGIN" + fullName: "com.azure.core.http.HttpHeaderName.ORIGIN" + name: "ORIGIN" + nameWithType: "HttpHeaderName.ORIGIN" + summary: "`Origin`/`origin`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName ORIGIN" + desc: "`Origin`/`origin`" +- uid: "com.azure.core.http.HttpHeaderName.PRAGMA" + fullName: "com.azure.core.http.HttpHeaderName.PRAGMA" + name: "PRAGMA" + nameWithType: "HttpHeaderName.PRAGMA" + summary: "`Pragma`/`pragma`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName PRAGMA" + desc: "`Pragma`/`pragma`" +- uid: "com.azure.core.http.HttpHeaderName.PREFER" + fullName: "com.azure.core.http.HttpHeaderName.PREFER" + name: "PREFER" + nameWithType: "HttpHeaderName.PREFER" + summary: "`Prefer`/`prefer`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName PREFER" + desc: "`Prefer`/`prefer`" +- uid: "com.azure.core.http.HttpHeaderName.PREFERENCE_APPLIED" + fullName: "com.azure.core.http.HttpHeaderName.PREFERENCE_APPLIED" + name: "PREFERENCE_APPLIED" + nameWithType: "HttpHeaderName.PREFERENCE_APPLIED" + summary: "`Preference-Applied`/`preference-applied`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName PREFERENCE_APPLIED" + desc: "`Preference-Applied`/`preference-applied`" +- uid: "com.azure.core.http.HttpHeaderName.PROXY_AUTHENTICATE" + fullName: "com.azure.core.http.HttpHeaderName.PROXY_AUTHENTICATE" + name: "PROXY_AUTHENTICATE" + nameWithType: "HttpHeaderName.PROXY_AUTHENTICATE" + summary: "`Proxy-Authenticate`/`proxy-authenticate`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName PROXY_AUTHENTICATE" + desc: "`Proxy-Authenticate`/`proxy-authenticate`" +- uid: "com.azure.core.http.HttpHeaderName.PROXY_AUTHORIZATION" + fullName: "com.azure.core.http.HttpHeaderName.PROXY_AUTHORIZATION" + name: "PROXY_AUTHORIZATION" + nameWithType: "HttpHeaderName.PROXY_AUTHORIZATION" + summary: "`Proxy-Authorization`/`proxy-authorization`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName PROXY_AUTHORIZATION" + desc: "`Proxy-Authorization`/`proxy-authorization`" +- uid: "com.azure.core.http.HttpHeaderName.RANGE" + fullName: "com.azure.core.http.HttpHeaderName.RANGE" + name: "RANGE" + nameWithType: "HttpHeaderName.RANGE" + summary: "`Range`/`range`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName RANGE" + desc: "`Range`/`range`" +- uid: "com.azure.core.http.HttpHeaderName.REFERER" + fullName: "com.azure.core.http.HttpHeaderName.REFERER" + name: "REFERER" + nameWithType: "HttpHeaderName.REFERER" + summary: "`Referer`/`referer`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName REFERER" + desc: "`Referer`/`referer`" +- uid: "com.azure.core.http.HttpHeaderName.RETRY_AFTER" + fullName: "com.azure.core.http.HttpHeaderName.RETRY_AFTER" + name: "RETRY_AFTER" + nameWithType: "HttpHeaderName.RETRY_AFTER" + summary: "`Retry-After`/`retry-after`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName RETRY_AFTER" + desc: "`Retry-After`/`retry-after`" +- uid: "com.azure.core.http.HttpHeaderName.SERVER" + fullName: "com.azure.core.http.HttpHeaderName.SERVER" + name: "SERVER" + nameWithType: "HttpHeaderName.SERVER" + summary: "`Server`/`server`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName SERVER" + desc: "`Server`/`server`" +- uid: "com.azure.core.http.HttpHeaderName.SET_COOKIE" + fullName: "com.azure.core.http.HttpHeaderName.SET_COOKIE" + name: "SET_COOKIE" + nameWithType: "HttpHeaderName.SET_COOKIE" + summary: "`Set-Cookie`/`set-cookie`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName SET_COOKIE" + desc: "`Set-Cookie`/`set-cookie`" +- uid: "com.azure.core.http.HttpHeaderName.STRICT_TRANSPORT_SECURITY" + fullName: "com.azure.core.http.HttpHeaderName.STRICT_TRANSPORT_SECURITY" + name: "STRICT_TRANSPORT_SECURITY" + nameWithType: "HttpHeaderName.STRICT_TRANSPORT_SECURITY" + summary: "`Strict-Transport-Security`/`strict-transport-security`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName STRICT_TRANSPORT_SECURITY" + desc: "`Strict-Transport-Security`/`strict-transport-security`" +- uid: "com.azure.core.http.HttpHeaderName.TE" + fullName: "com.azure.core.http.HttpHeaderName.TE" + name: "TE" + nameWithType: "HttpHeaderName.TE" + summary: "`TE`/`te`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName TE" + desc: "`TE`/`te`" +- uid: "com.azure.core.http.HttpHeaderName.TRAILER" + fullName: "com.azure.core.http.HttpHeaderName.TRAILER" + name: "TRAILER" + nameWithType: "HttpHeaderName.TRAILER" + summary: "`Trailer`/`trailer`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName TRAILER" + desc: "`Trailer`/`trailer`" +- uid: "com.azure.core.http.HttpHeaderName.TRANSFER_ENCODING" + fullName: "com.azure.core.http.HttpHeaderName.TRANSFER_ENCODING" + name: "TRANSFER_ENCODING" + nameWithType: "HttpHeaderName.TRANSFER_ENCODING" + summary: "`Transfer-Encoding`/`transfer-encoding`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName TRANSFER_ENCODING" + desc: "`Transfer-Encoding`/`transfer-encoding`" +- uid: "com.azure.core.http.HttpHeaderName.UPGRADE" + fullName: "com.azure.core.http.HttpHeaderName.UPGRADE" + name: "UPGRADE" + nameWithType: "HttpHeaderName.UPGRADE" + summary: "`Upgrade`/`upgrade`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName UPGRADE" + desc: "`Upgrade`/`upgrade`" +- uid: "com.azure.core.http.HttpHeaderName.USER_AGENT" + fullName: "com.azure.core.http.HttpHeaderName.USER_AGENT" + name: "USER_AGENT" + nameWithType: "HttpHeaderName.USER_AGENT" + summary: "`User-Agent`/`user-agent`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName USER_AGENT" + desc: "`User-Agent`/`user-agent`" +- uid: "com.azure.core.http.HttpHeaderName.VARY" + fullName: "com.azure.core.http.HttpHeaderName.VARY" + name: "VARY" + nameWithType: "HttpHeaderName.VARY" + summary: "`Vary`/`vary`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName VARY" + desc: "`Vary`/`vary`" +- uid: "com.azure.core.http.HttpHeaderName.VIA" + fullName: "com.azure.core.http.HttpHeaderName.VIA" + name: "VIA" + nameWithType: "HttpHeaderName.VIA" + summary: "`Via`/`via`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName VIA" + desc: "`Via`/`via`" +- uid: "com.azure.core.http.HttpHeaderName.WARNING" + fullName: "com.azure.core.http.HttpHeaderName.WARNING" + name: "WARNING" + nameWithType: "HttpHeaderName.WARNING" + summary: "`Warning`/`warning`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName WARNING" + desc: "`Warning`/`warning`" +- uid: "com.azure.core.http.HttpHeaderName.WWW_AUTHENTICATE" + fullName: "com.azure.core.http.HttpHeaderName.WWW_AUTHENTICATE" + name: "WWW_AUTHENTICATE" + nameWithType: "HttpHeaderName.WWW_AUTHENTICATE" + summary: "`WWW-Authenticate`/`www-authenticate`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName WWW_AUTHENTICATE" + desc: "`WWW-Authenticate`/`www-authenticate`" +- uid: "com.azure.core.http.HttpHeaderName.X_MS_CLIENT_REQUEST_ID" + fullName: "com.azure.core.http.HttpHeaderName.X_MS_CLIENT_REQUEST_ID" + name: "X_MS_CLIENT_REQUEST_ID" + nameWithType: "HttpHeaderName.X_MS_CLIENT_REQUEST_ID" + summary: "`x-ms-client-request-id`" + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final HttpHeaderName X_MS_CLIENT_REQUEST_ID" + desc: "`x-ms-client-request-id`" +methods: +- uid: "com.azure.core.http.HttpHeaderName.equals(java.lang.Object)" + fullName: "com.azure.core.http.HttpHeaderName.equals(Object obj)" + name: "equals(Object obj)" + nameWithType: "HttpHeaderName.equals(Object obj)" + overridden: "com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)" + parameters: + - name: "obj" + type: "Object" + syntax: "public boolean equals(Object obj)" + returns: + type: "" +- uid: "com.azure.core.http.HttpHeaderName.fromString(java.lang.String)" + fullName: "com.azure.core.http.HttpHeaderName.fromString(String name)" + name: "fromString(String name)" + nameWithType: "HttpHeaderName.fromString(String name)" + summary: "Gets or creates the for the passed `name`." + modifiers: + - "static" + parameters: + - description: "The name." + name: "name" + type: "String" + syntax: "public static HttpHeaderName fromString(String name)" + desc: "Gets or creates the for the passed `name`.\n\nnull will be returned if `name` is null." + returns: + description: "The HttpHeaderName of the passed name, or null if name was null." + type: "" +- uid: "com.azure.core.http.HttpHeaderName.getCaseInsensitiveName()" + fullName: "com.azure.core.http.HttpHeaderName.getCaseInsensitiveName()" + name: "getCaseInsensitiveName()" + nameWithType: "HttpHeaderName.getCaseInsensitiveName()" + summary: "Gets the HTTP header name lower cased." + syntax: "public String getCaseInsensitiveName()" + desc: "Gets the HTTP header name lower cased." + returns: + description: "The HTTP header name lower cased." + type: "String" +- uid: "com.azure.core.http.HttpHeaderName.getCaseSensitiveName()" + fullName: "com.azure.core.http.HttpHeaderName.getCaseSensitiveName()" + name: "getCaseSensitiveName()" + nameWithType: "HttpHeaderName.getCaseSensitiveName()" + summary: "Gets the HTTP header name based on the name passed into ." + syntax: "public String getCaseSensitiveName()" + desc: "Gets the HTTP header name based on the name passed into ." + returns: + description: "The HTTP header name based on the construction of this ." + type: "String" +- uid: "com.azure.core.http.HttpHeaderName.hashCode()" + fullName: "com.azure.core.http.HttpHeaderName.hashCode()" + name: "hashCode()" + nameWithType: "HttpHeaderName.hashCode()" + overridden: "com.azure.core.util.ExpandableStringEnum.hashCode()" + syntax: "public int hashCode()" + returns: + type: "" +type: "class" +desc: "Represents HTTP header names for multiple versions of HTTP." +metadata: {} +package: "com.azure.core.http" +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpHeaders.yml b/docs-ref-autogen/com.azure.core.http.HttpHeaders.yml index a04e27d3c436..0c68d83e69d2 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpHeaders.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpHeaders.yml @@ -63,6 +63,23 @@ constructors: syntax: "public HttpHeaders(Map headers)" desc: "Create a HttpHeaders instance with the provided initial headers." methods: +- uid: "com.azure.core.http.HttpHeaders.add(com.azure.core.http.HttpHeaderName,java.lang.String)" + fullName: "com.azure.core.http.HttpHeaders.add(HttpHeaderName name, String value)" + name: "add(HttpHeaderName name, String value)" + nameWithType: "HttpHeaders.add(HttpHeaderName name, String value)" + summary: "Adds a with the given name and value if a header with that name doesn't already exist, otherwise adds the `value` to the existing header." + parameters: + - description: "The name of the header." + name: "name" + type: "" + - description: "The value of the header." + name: "value" + type: "String" + syntax: "public HttpHeaders add(HttpHeaderName name, String value)" + desc: "Adds a with the given name and value if a header with that name doesn't already exist, otherwise adds the `value` to the existing header." + returns: + description: "The updated HttpHeaders object." + type: "" - uid: "com.azure.core.http.HttpHeaders.add(java.lang.String,java.lang.String)" fullName: "com.azure.core.http.HttpHeaders.add(String name, String value)" name: "add(String name, String value)" @@ -80,6 +97,20 @@ methods: returns: description: "The updated HttpHeaders object." type: "" +- uid: "com.azure.core.http.HttpHeaders.get(com.azure.core.http.HttpHeaderName)" + fullName: "com.azure.core.http.HttpHeaders.get(HttpHeaderName name)" + name: "get(HttpHeaderName name)" + nameWithType: "HttpHeaders.get(HttpHeaderName name)" + summary: "Gets the for the provided header name." + parameters: + - description: "the name of the header to find." + name: "name" + type: "" + syntax: "public HttpHeader get(HttpHeaderName name)" + desc: "Gets the for the provided header name. `Null` is returned if the header isn't found." + returns: + description: "the header if found, null otherwise." + type: "" - uid: "com.azure.core.http.HttpHeaders.get(java.lang.String)" fullName: "com.azure.core.http.HttpHeaders.get(String name)" name: "get(String name)" @@ -104,6 +135,20 @@ methods: returns: description: "the number of headers in this collection." type: "" +- uid: "com.azure.core.http.HttpHeaders.getValue(com.azure.core.http.HttpHeaderName)" + fullName: "com.azure.core.http.HttpHeaders.getValue(HttpHeaderName name)" + name: "getValue(HttpHeaderName name)" + nameWithType: "HttpHeaders.getValue(HttpHeaderName name)" + summary: "Get the value for the provided header name." + parameters: + - description: "the name of the header whose value is being retrieved." + name: "name" + type: "" + syntax: "public String getValue(HttpHeaderName name)" + desc: "Get the value for the provided header name. `Null` is returned if the header name isn't found." + returns: + description: "the value of the header, or null if the header isn't found" + type: "String" - uid: "com.azure.core.http.HttpHeaders.getValue(java.lang.String)" fullName: "com.azure.core.http.HttpHeaders.getValue(String name)" name: "getValue(String name)" @@ -118,6 +163,20 @@ methods: returns: description: "the value of the header, or null if the header isn't found" type: "String" +- uid: "com.azure.core.http.HttpHeaders.getValues(com.azure.core.http.HttpHeaderName)" + fullName: "com.azure.core.http.HttpHeaders.getValues(HttpHeaderName name)" + name: "getValues(HttpHeaderName name)" + nameWithType: "HttpHeaders.getValues(HttpHeaderName name)" + summary: "Get the values for the provided header name." + parameters: + - description: "the name of the header whose value is being retrieved." + name: "name" + type: "" + syntax: "public String[] getValues(HttpHeaderName name)" + desc: "Get the values for the provided header name. `Null` is returned if the header name isn't found.\n\nThis returns split by `comma`." + returns: + description: "the values of the header, or null if the header isn't found" + type: "String[]" - uid: "com.azure.core.http.HttpHeaders.getValues(java.lang.String)" fullName: "com.azure.core.http.HttpHeaders.getValues(String name)" name: "getValues(String name)" @@ -158,6 +217,20 @@ methods: returns: description: "The updated HttpHeaders object" type: "" +- uid: "com.azure.core.http.HttpHeaders.remove(com.azure.core.http.HttpHeaderName)" + fullName: "com.azure.core.http.HttpHeaders.remove(HttpHeaderName name)" + name: "remove(HttpHeaderName name)" + nameWithType: "HttpHeaders.remove(HttpHeaderName name)" + summary: "Removes the with the provided header name." + parameters: + - description: "the name of the header to remove." + name: "name" + type: "" + syntax: "public HttpHeader remove(HttpHeaderName name)" + desc: "Removes the with the provided header name. `Null` is returned if the header isn't found." + returns: + description: "the header if removed, null otherwise." + type: "" - uid: "com.azure.core.http.HttpHeaders.remove(java.lang.String)" fullName: "com.azure.core.http.HttpHeaders.remove(String name)" name: "remove(String name)" @@ -172,6 +245,40 @@ methods: returns: description: "the header if removed, null otherwise." type: "" +- uid: "com.azure.core.http.HttpHeaders.set(com.azure.core.http.HttpHeaderName,java.lang.String)" + fullName: "com.azure.core.http.HttpHeaders.set(HttpHeaderName name, String value)" + name: "set(HttpHeaderName name, String value)" + nameWithType: "HttpHeaders.set(HttpHeaderName name, String value)" + summary: "Sets a with the given name and value." + parameters: + - description: "the name to set in the header. If it is null, this method will return with no changes to the\n headers." + name: "name" + type: "" + - description: "the value" + name: "value" + type: "String" + syntax: "public HttpHeaders set(HttpHeaderName name, String value)" + desc: "Sets a with the given name and value. If a header with same name already exists then the value will be overwritten. If the given value is null, the header with the given name will be removed." + returns: + description: "The updated HttpHeaders object" + type: "" +- uid: "com.azure.core.http.HttpHeaders.set(com.azure.core.http.HttpHeaderName,java.util.List)" + fullName: "com.azure.core.http.HttpHeaders.set(HttpHeaderName name, List values)" + name: "set(HttpHeaderName name, List values)" + nameWithType: "HttpHeaders.set(HttpHeaderName name, List values)" + summary: "Sets a with the given name and the list of values provided, such that the given values will be comma-separated when necessary." + parameters: + - description: "the name" + name: "name" + type: "" + - description: "the values that will be comma-separated as appropriate" + name: "values" + type: "List<String>" + syntax: "public HttpHeaders set(HttpHeaderName name, List values)" + desc: "Sets a with the given name and the list of values provided, such that the given values will be comma-separated when necessary. If a header with same name already exists then the values will be overwritten. If the given values list is null, the header with the given name will be removed." + returns: + description: "The updated HttpHeaders object" + type: "" - uid: "com.azure.core.http.HttpHeaders.set(java.lang.String,java.lang.String)" fullName: "com.azure.core.http.HttpHeaders.set(String name, String value)" name: "set(String name, String value)" @@ -254,4 +361,4 @@ implements: - "Iterable<>" metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpMethod.yml b/docs-ref-autogen/com.azure.core.http.HttpMethod.yml index d2cc908983b2..8f4dea87d4b8 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpMethod.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpMethod.yml @@ -109,4 +109,4 @@ methods: desc: "The HTTP request methods." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpPipeline.yml b/docs-ref-autogen/com.azure.core.http.HttpPipeline.yml index 44595cee1c3a..f93828b6655d 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpPipeline.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpPipeline.yml @@ -122,4 +122,4 @@ type: "class" desc: "The HTTP pipeline that HTTP requests and responses will flow through.\n\nThe HTTP pipeline may apply a set of to the request before it is sent and on the response as it is being returned." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpPipelineBuilder.yml b/docs-ref-autogen/com.azure.core.http.HttpPipelineBuilder.yml index 8832afdcd058..d8ec796e529f 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpPipelineBuilder.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpPipelineBuilder.yml @@ -86,4 +86,4 @@ type: "class" desc: "This class provides a fluent builder API to help aid the configuration and instantiation of the , calling constructs an instance of the pipeline.\n\nA pipeline is configured with a HttpClient that sends the request, if no client is set a default is used. A pipeline may be configured with a list of policies that are applied to each request.\n\n**Code Samples**\n\nCreate a pipeline without configuration\n\n```java\nHttpPipeline pipeline = new HttpPipelineBuilder().build();\n```\n\nCreate a pipeline using the default HTTP client and a retry policy\n\n```java\nHttpPipeline pipeline = new HttpPipelineBuilder()\n .httpClient(HttpClient.createDefault())\n .policies(new RetryPolicy())\n .build();\n```" metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpPipelineCallContext.yml b/docs-ref-autogen/com.azure.core.http.HttpPipelineCallContext.yml index bc855343619a..d62658887f43 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpPipelineCallContext.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpPipelineCallContext.yml @@ -88,4 +88,4 @@ type: "class" desc: "Represents the information used to make a single HTTP request." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpPipelineNextPolicy.yml b/docs-ref-autogen/com.azure.core.http.HttpPipelineNextPolicy.yml index b9e39b6fb540..7bd8d9fca65d 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpPipelineNextPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpPipelineNextPolicy.yml @@ -47,4 +47,4 @@ type: "class" desc: "A type that invokes next policy in the pipeline." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpPipelineNextSyncPolicy.yml b/docs-ref-autogen/com.azure.core.http.HttpPipelineNextSyncPolicy.yml index 439b04f33953..13ecafec1a4d 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpPipelineNextSyncPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpPipelineNextSyncPolicy.yml @@ -47,4 +47,4 @@ type: "class" desc: "A type that invokes next policy in the pipeline." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpPipelinePosition.yml b/docs-ref-autogen/com.azure.core.http.HttpPipelinePosition.yml index e4232f000249..b696ebbdda47 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpPipelinePosition.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpPipelinePosition.yml @@ -67,4 +67,4 @@ methods: desc: "Indicates the position in an to place an ." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpRange.yml b/docs-ref-autogen/com.azure.core.http.HttpRange.yml index feb2e4d9ee0c..b5f42ae1e3cb 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpRange.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpRange.yml @@ -102,4 +102,4 @@ type: "class" desc: "Represents a range of bytes within an HTTP resource.\n\nThe range starts at the inclusively and ends at \\+ exclusively, or offset + length - 1.\n\nIf is unspecified, null, then the range extends to the end of the HTTP resource." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpRequest.yml b/docs-ref-autogen/com.azure.core.http.HttpRequest.yml index 1176eaca059b..6a92c3f65cdd 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpRequest.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpRequest.yml @@ -301,4 +301,4 @@ type: "class" desc: "The outgoing Http request. It provides ways to construct with , , and request body." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.HttpResponse.yml b/docs-ref-autogen/com.azure.core.http.HttpResponse.yml index f79bcfecd835..0ee2ea8cda3e 100644 --- a/docs-ref-autogen/com.azure.core.http.HttpResponse.yml +++ b/docs-ref-autogen/com.azure.core.http.HttpResponse.yml @@ -211,4 +211,4 @@ implements: - "Closeable" metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.MatchConditions.yml b/docs-ref-autogen/com.azure.core.http.MatchConditions.yml index b1c545ff3451..cc0ddc1cca53 100644 --- a/docs-ref-autogen/com.azure.core.http.MatchConditions.yml +++ b/docs-ref-autogen/com.azure.core.http.MatchConditions.yml @@ -26,7 +26,9 @@ constructors: fullName: "com.azure.core.http.MatchConditions.MatchConditions()" name: "MatchConditions()" nameWithType: "MatchConditions.MatchConditions()" + summary: "Creates a new instance of ." syntax: "public MatchConditions()" + desc: "Creates a new instance of ." methods: - uid: "com.azure.core.http.MatchConditions.getIfMatch()" fullName: "com.azure.core.http.MatchConditions.getIfMatch()" @@ -80,4 +82,4 @@ type: "class" desc: "Specifies HTTP options for conditional requests." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.ProxyOptions.Type.yml b/docs-ref-autogen/com.azure.core.http.ProxyOptions.Type.yml index e836c481fee2..3c70f7eafe09 100644 --- a/docs-ref-autogen/com.azure.core.http.ProxyOptions.Type.yml +++ b/docs-ref-autogen/com.azure.core.http.ProxyOptions.Type.yml @@ -83,4 +83,4 @@ methods: desc: "The type of the proxy." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.ProxyOptions.yml b/docs-ref-autogen/com.azure.core.http.ProxyOptions.yml index 6e960bbdce83..7e77f2f4279d 100644 --- a/docs-ref-autogen/com.azure.core.http.ProxyOptions.yml +++ b/docs-ref-autogen/com.azure.core.http.ProxyOptions.yml @@ -76,7 +76,9 @@ methods: fullName: "com.azure.core.http.ProxyOptions.getAddress()" name: "getAddress()" nameWithType: "ProxyOptions.getAddress()" + summary: "Gets the address of the proxy." syntax: "public InetSocketAddress getAddress()" + desc: "Gets the address of the proxy." returns: description: "the address of the proxy." type: "InetSocketAddress" @@ -84,7 +86,9 @@ methods: fullName: "com.azure.core.http.ProxyOptions.getNonProxyHosts()" name: "getNonProxyHosts()" nameWithType: "ProxyOptions.getNonProxyHosts()" + summary: "Gets the host that bypass the proxy." syntax: "public String getNonProxyHosts()" + desc: "Gets the host that bypass the proxy." returns: description: "the hosts that bypass the proxy." type: "String" @@ -92,7 +96,9 @@ methods: fullName: "com.azure.core.http.ProxyOptions.getPassword()" name: "getPassword()" nameWithType: "ProxyOptions.getPassword()" + summary: "Gets the proxy password." syntax: "public String getPassword()" + desc: "Gets the proxy password." returns: description: "the proxy password." type: "String" @@ -100,7 +106,9 @@ methods: fullName: "com.azure.core.http.ProxyOptions.getType()" name: "getType()" nameWithType: "ProxyOptions.getType()" + summary: "Gets the type of the prxoy." syntax: "public ProxyOptions.Type getType()" + desc: "Gets the type of the prxoy." returns: description: "the type of the proxy." type: "" @@ -108,9 +116,11 @@ methods: fullName: "com.azure.core.http.ProxyOptions.getUsername()" name: "getUsername()" nameWithType: "ProxyOptions.getUsername()" + summary: "Gets the proxy username." syntax: "public String getUsername()" + desc: "Gets the proxy username." returns: - description: "the proxy user name." + description: "the proxy username." type: "String" - uid: "com.azure.core.http.ProxyOptions.setCredentials(java.lang.String,java.lang.String)" fullName: "com.azure.core.http.ProxyOptions.setCredentials(String username, String password)" @@ -147,4 +157,4 @@ type: "class" desc: "This represents proxy configuration to be used in http clients.." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.RequestConditions.yml b/docs-ref-autogen/com.azure.core.http.RequestConditions.yml index 70b0b9120517..240f8b53984b 100644 --- a/docs-ref-autogen/com.azure.core.http.RequestConditions.yml +++ b/docs-ref-autogen/com.azure.core.http.RequestConditions.yml @@ -33,7 +33,9 @@ constructors: fullName: "com.azure.core.http.RequestConditions.RequestConditions()" name: "RequestConditions()" nameWithType: "RequestConditions.RequestConditions()" + summary: "Creates a new instance of ." syntax: "public RequestConditions()" + desc: "Creates a new instance of ." methods: - uid: "com.azure.core.http.RequestConditions.getIfModifiedSince()" fullName: "com.azure.core.http.RequestConditions.getIfModifiedSince()" @@ -117,4 +119,4 @@ type: "class" desc: "Specifies HTTP options for conditional requests based on modification time." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.netty.NettyAsyncHttpClientBuilder.yml b/docs-ref-autogen/com.azure.core.http.netty.NettyAsyncHttpClientBuilder.yml index 6a4cab502394..5b530e441ea4 100644 --- a/docs-ref-autogen/com.azure.core.http.netty.NettyAsyncHttpClientBuilder.yml +++ b/docs-ref-autogen/com.azure.core.http.netty.NettyAsyncHttpClientBuilder.yml @@ -225,4 +225,4 @@ type: "class" desc: "Builder class responsible for creating instances of backed by Reactor Netty.\n\n**Building a new HttpClient instance**\n\n```java\nHttpClient client = new NettyAsyncHttpClientBuilder()\n .port(8080)\n .wiretap(true)\n .build();\n```" metadata: {} package: "com.azure.core.http.netty" -artifact: com.azure:azure-core-http-netty:1.12.6 +artifact: com.azure:azure-core-http-netty:1.12.7 diff --git a/docs-ref-autogen/com.azure.core.http.netty.NettyAsyncHttpClientProvider.yml b/docs-ref-autogen/com.azure.core.http.netty.NettyAsyncHttpClientProvider.yml index c50de13a27a4..6061f6de249d 100644 --- a/docs-ref-autogen/com.azure.core.http.netty.NettyAsyncHttpClientProvider.yml +++ b/docs-ref-autogen/com.azure.core.http.netty.NettyAsyncHttpClientProvider.yml @@ -53,4 +53,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.netty" -artifact: com.azure:azure-core-http-netty:1.12.6 +artifact: com.azure:azure-core-http-netty:1.12.7 diff --git a/docs-ref-autogen/com.azure.core.http.netty.yml b/docs-ref-autogen/com.azure.core.http.netty.yml index ae8ab5a5f964..fa22fbbb588c 100644 --- a/docs-ref-autogen/com.azure.core.http.netty.yml +++ b/docs-ref-autogen/com.azure.core.http.netty.yml @@ -9,4 +9,4 @@ classes: desc: "Package containing the types for instantiating and using the Netty HTTP client." metadata: {} package: "com.azure.core.http.netty" -artifact: com.azure:azure-core-http-netty:1.12.6 +artifact: com.azure:azure-core-http-netty:1.12.7 diff --git a/docs-ref-autogen/com.azure.core.http.okhttp.OkHttpAsyncClientProvider.yml b/docs-ref-autogen/com.azure.core.http.okhttp.OkHttpAsyncClientProvider.yml index 77b70700a7d1..6f22e2f63657 100644 --- a/docs-ref-autogen/com.azure.core.http.okhttp.OkHttpAsyncClientProvider.yml +++ b/docs-ref-autogen/com.azure.core.http.okhttp.OkHttpAsyncClientProvider.yml @@ -53,4 +53,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.okhttp" -artifact: com.azure:azure-core-http-okhttp:1.11.3 +artifact: com.azure:azure-core-http-okhttp:1.11.4 diff --git a/docs-ref-autogen/com.azure.core.http.okhttp.OkHttpAsyncHttpClientBuilder.yml b/docs-ref-autogen/com.azure.core.http.okhttp.OkHttpAsyncHttpClientBuilder.yml index 07f7d45925a7..83e02498c0b9 100644 --- a/docs-ref-autogen/com.azure.core.http.okhttp.OkHttpAsyncHttpClientBuilder.yml +++ b/docs-ref-autogen/com.azure.core.http.okhttp.OkHttpAsyncHttpClientBuilder.yml @@ -209,4 +209,4 @@ type: "class" desc: "Builder class responsible for creating instances of backed by OkHttp." metadata: {} package: "com.azure.core.http.okhttp" -artifact: com.azure:azure-core-http-okhttp:1.11.3 +artifact: com.azure:azure-core-http-okhttp:1.11.4 diff --git a/docs-ref-autogen/com.azure.core.http.okhttp.yml b/docs-ref-autogen/com.azure.core.http.okhttp.yml index b2999baa69e1..dbfb46839f9c 100644 --- a/docs-ref-autogen/com.azure.core.http.okhttp.yml +++ b/docs-ref-autogen/com.azure.core.http.okhttp.yml @@ -9,4 +9,4 @@ classes: desc: "Package containing OkHttp HTTP client plugin for azure-core." metadata: {} package: "com.azure.core.http.okhttp" -artifact: com.azure:azure-core-http-okhttp:1.11.3 +artifact: com.azure:azure-core-http-okhttp:1.11.4 diff --git a/docs-ref-autogen/com.azure.core.http.policy.AddDatePolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.AddDatePolicy.yml index 195903c88843..d3b8aa9c91c3 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.AddDatePolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.AddDatePolicy.yml @@ -26,7 +26,9 @@ constructors: fullName: "com.azure.core.http.policy.AddDatePolicy.AddDatePolicy()" name: "AddDatePolicy()" nameWithType: "AddDatePolicy.AddDatePolicy()" + summary: "Creates a new instance of ." syntax: "public AddDatePolicy()" + desc: "Creates a new instance of ." methods: - uid: "com.azure.core.http.policy.AddDatePolicy.process(com.azure.core.http.HttpPipelineCallContext,com.azure.core.http.HttpPipelineNextPolicy)" fullName: "com.azure.core.http.policy.AddDatePolicy.process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)" @@ -62,4 +64,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.AddHeadersFromContextPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.AddHeadersFromContextPolicy.yml index 03c1c56f2b67..2968f9091c96 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.AddHeadersFromContextPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.AddHeadersFromContextPolicy.yml @@ -26,7 +26,9 @@ constructors: fullName: "com.azure.core.http.policy.AddHeadersFromContextPolicy.AddHeadersFromContextPolicy()" name: "AddHeadersFromContextPolicy()" nameWithType: "AddHeadersFromContextPolicy.AddHeadersFromContextPolicy()" + summary: "Creates a new instance of ." syntax: "public AddHeadersFromContextPolicy()" + desc: "Creates a new instance of ." fields: - uid: "com.azure.core.http.policy.AddHeadersFromContextPolicy.AZURE_REQUEST_HTTP_HEADERS_KEY" fullName: "com.azure.core.http.policy.AddHeadersFromContextPolicy.AZURE_REQUEST_HTTP_HEADERS_KEY" @@ -76,4 +78,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.AddHeadersPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.AddHeadersPolicy.yml index 3924746531ba..5ea6512f5968 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.AddHeadersPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.AddHeadersPolicy.yml @@ -68,4 +68,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.AfterRetryPolicyProvider.yml b/docs-ref-autogen/com.azure.core.http.policy.AfterRetryPolicyProvider.yml index 1f182c137d07..43a58812e873 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.AfterRetryPolicyProvider.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.AfterRetryPolicyProvider.yml @@ -11,4 +11,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.AzureKeyCredentialPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.AzureKeyCredentialPolicy.yml index 71df5c43568b..8888d5d6b99b 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.AzureKeyCredentialPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.AzureKeyCredentialPolicy.yml @@ -71,4 +71,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.AzureSasCredentialPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.AzureSasCredentialPolicy.yml index d825aaf7db4e..f087b3c9a125 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.AzureSasCredentialPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.AzureSasCredentialPolicy.yml @@ -82,4 +82,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.BearerTokenAuthenticationPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.BearerTokenAuthenticationPolicy.yml index 5d69703e3789..9521a41f57f0 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.BearerTokenAuthenticationPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.BearerTokenAuthenticationPolicy.yml @@ -161,4 +161,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.BeforeRetryPolicyProvider.yml b/docs-ref-autogen/com.azure.core.http.policy.BeforeRetryPolicyProvider.yml index 19e3cc421781..7ba6505dd661 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.BeforeRetryPolicyProvider.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.BeforeRetryPolicyProvider.yml @@ -11,4 +11,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.CookiePolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.CookiePolicy.yml index dd33fa7e6d4e..2c5cc58be244 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.CookiePolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.CookiePolicy.yml @@ -26,7 +26,9 @@ constructors: fullName: "com.azure.core.http.policy.CookiePolicy.CookiePolicy()" name: "CookiePolicy()" nameWithType: "CookiePolicy.CookiePolicy()" + summary: "Creates a new instance of ." syntax: "public CookiePolicy()" + desc: "Creates a new instance of ." methods: - uid: "com.azure.core.http.policy.CookiePolicy.process(com.azure.core.http.HttpPipelineCallContext,com.azure.core.http.HttpPipelineNextPolicy)" fullName: "com.azure.core.http.policy.CookiePolicy.process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)" @@ -62,4 +64,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.DefaultRedirectStrategy.yml b/docs-ref-autogen/com.azure.core.http.policy.DefaultRedirectStrategy.yml index 206115debefe..67fc65ad1842 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.DefaultRedirectStrategy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.DefaultRedirectStrategy.yml @@ -103,4 +103,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.ExponentialBackoff.yml b/docs-ref-autogen/com.azure.core.http.policy.ExponentialBackoff.yml index 26ae98c1e726..e8a479cf2cac 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.ExponentialBackoff.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.ExponentialBackoff.yml @@ -85,4 +85,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.ExponentialBackoffOptions.yml b/docs-ref-autogen/com.azure.core.http.policy.ExponentialBackoffOptions.yml index bc8ea19b0ee1..40fa1accbd77 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.ExponentialBackoffOptions.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.ExponentialBackoffOptions.yml @@ -26,7 +26,9 @@ constructors: fullName: "com.azure.core.http.policy.ExponentialBackoffOptions.ExponentialBackoffOptions()" name: "ExponentialBackoffOptions()" nameWithType: "ExponentialBackoffOptions.ExponentialBackoffOptions()" + summary: "Creates a new instance of ." syntax: "public ExponentialBackoffOptions()" + desc: "Creates a new instance of ." methods: - uid: "com.azure.core.http.policy.ExponentialBackoffOptions.getBaseDelay()" fullName: "com.azure.core.http.policy.ExponentialBackoffOptions.getBaseDelay()" @@ -104,4 +106,4 @@ type: "class" desc: "The configuration for exponential backoff that has a delay duration that exponentially increases with each retry attempt until an upper bound is reached after which every retry attempt is delayed by the provided max delay duration." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.FixedDelay.yml b/docs-ref-autogen/com.azure.core.http.policy.FixedDelay.yml index 646c78cf45d7..0de611175539 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.FixedDelay.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.FixedDelay.yml @@ -75,4 +75,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.FixedDelayOptions.yml b/docs-ref-autogen/com.azure.core.http.policy.FixedDelayOptions.yml index b11c0f8e26c4..1ac0fa0c4aa4 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.FixedDelayOptions.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.FixedDelayOptions.yml @@ -61,4 +61,4 @@ type: "class" desc: "The configuration for a fixed-delay retry that has a fixed delay duration between each retry attempt." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HostPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.HostPolicy.yml index d70822433afb..5103e1a5e7da 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HostPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HostPolicy.yml @@ -68,4 +68,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpLogDetailLevel.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpLogDetailLevel.yml index 689b0113d034..43f22e2050ea 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpLogDetailLevel.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpLogDetailLevel.yml @@ -65,25 +65,31 @@ methods: fullName: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogBody()" name: "shouldLogBody()" nameWithType: "HttpLogDetailLevel.shouldLogBody()" + summary: "Whether a body should be logged." syntax: "public boolean shouldLogBody()" + desc: "Whether a body should be logged." returns: - description: "a value indicating whether HTTP message bodies should be logged." + description: "Whether a body should be logged." type: "" - uid: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogHeaders()" fullName: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogHeaders()" name: "shouldLogHeaders()" nameWithType: "HttpLogDetailLevel.shouldLogHeaders()" + summary: "Whether headers should be logged." syntax: "public boolean shouldLogHeaders()" + desc: "Whether headers should be logged." returns: - description: "a value indicating whether HTTP message headers should be logged." + description: "Whether headers should be logged." type: "" - uid: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogUrl()" fullName: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogUrl()" name: "shouldLogUrl()" nameWithType: "HttpLogDetailLevel.shouldLogUrl()" + summary: "Whether a URL should be logged." syntax: "public boolean shouldLogUrl()" + desc: "Whether a URL should be logged." returns: - description: "a value indicating whether a request's URL should be logged." + description: "Whether a URL should be logged." type: "" - uid: "com.azure.core.http.policy.HttpLogDetailLevel.valueOf(java.lang.String)" fullName: "com.azure.core.http.policy.HttpLogDetailLevel.valueOf(String name)" @@ -109,4 +115,4 @@ methods: desc: "The level of detail to log on HTTP messages." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpLogOptions.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpLogOptions.yml index b114d7737ceb..1af7e81bfd69 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpLogOptions.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpLogOptions.yml @@ -234,4 +234,4 @@ type: "class" desc: "The log configurations for HTTP messages." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpLoggingPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpLoggingPolicy.yml index d9729a36132e..f2f80ba17d12 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpLoggingPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpLoggingPolicy.yml @@ -82,4 +82,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpPipelinePolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpPipelinePolicy.yml index 8664833ebf21..5f1b7cf892f5 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpPipelinePolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpPipelinePolicy.yml @@ -60,4 +60,4 @@ type: "interface" desc: "A policy within the ." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpPipelineSyncPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpPipelineSyncPolicy.yml index 749a20b91f4b..c931a1f26d86 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpPipelineSyncPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpPipelineSyncPolicy.yml @@ -26,7 +26,9 @@ constructors: fullName: "com.azure.core.http.policy.HttpPipelineSyncPolicy.HttpPipelineSyncPolicy()" name: "HttpPipelineSyncPolicy()" nameWithType: "HttpPipelineSyncPolicy.HttpPipelineSyncPolicy()" + summary: "Creates a new instance of ." syntax: "public HttpPipelineSyncPolicy()" + desc: "Creates a new instance of ." methods: - uid: "com.azure.core.http.policy.HttpPipelineSyncPolicy.afterReceivedResponse(com.azure.core.http.HttpPipelineCallContext,com.azure.core.http.HttpResponse)" fullName: "com.azure.core.http.policy.HttpPipelineSyncPolicy.afterReceivedResponse(HttpPipelineCallContext context, HttpResponse response)" @@ -98,4 +100,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpPolicyProvider.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpPolicyProvider.yml index 49b0c11a4c9f..b2bb11a7684e 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpPolicyProvider.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpPolicyProvider.yml @@ -22,4 +22,4 @@ type: "interface" desc: "Implementing classes automatically provide policies." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpPolicyProviders.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpPolicyProviders.yml index b4cb8177cd3f..df265a30c16a 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpPolicyProviders.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpPolicyProviders.yml @@ -52,4 +52,4 @@ type: "class" desc: "This class handles adding SPI plug-able policies to a pipeline automatically." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpRequestLogger.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpRequestLogger.yml index 36d57dcfab04..664d6a91aab6 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpRequestLogger.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpRequestLogger.yml @@ -61,4 +61,4 @@ type: "interface" desc: "Manages logging HTTP requests in ." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpRequestLoggingContext.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpRequestLoggingContext.yml index 7b0a3ac8b3f3..d56e643119d5 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpRequestLoggingContext.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpRequestLoggingContext.yml @@ -56,4 +56,4 @@ type: "class" desc: "Options class containing information available during HTTP request logging." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpResponseLogger.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpResponseLogger.yml index f7ee7eaa885f..4353ba080374 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpResponseLogger.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpResponseLogger.yml @@ -64,4 +64,4 @@ type: "interface" desc: "Manages logging HTTP responses in ." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.HttpResponseLoggingContext.yml b/docs-ref-autogen/com.azure.core.http.policy.HttpResponseLoggingContext.yml index 09606d557edc..235749c1997c 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.HttpResponseLoggingContext.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.HttpResponseLoggingContext.yml @@ -66,4 +66,4 @@ type: "class" desc: "Options class containing information available during HTTP response logging." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.PortPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.PortPolicy.yml index 14cf24428b5f..2f961b38a2d6 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.PortPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.PortPolicy.yml @@ -71,4 +71,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.ProtocolPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.ProtocolPolicy.yml index 6db7bfe25724..e7dbc0171774 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.ProtocolPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.ProtocolPolicy.yml @@ -71,4 +71,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.RedirectPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.RedirectPolicy.yml index 399087c50ab1..5ef32d0ecefc 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.RedirectPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.RedirectPolicy.yml @@ -75,4 +75,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.RedirectStrategy.yml b/docs-ref-autogen/com.azure.core.http.policy.RedirectStrategy.yml index 63312ee8af08..47948717210c 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.RedirectStrategy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.RedirectStrategy.yml @@ -63,4 +63,4 @@ type: "interface" desc: "The interface for determining the used in ." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.RequestIdPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.RequestIdPolicy.yml index 4a30b156df6d..22cc6d59f1f8 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.RequestIdPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.RequestIdPolicy.yml @@ -75,4 +75,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.RetryOptions.yml b/docs-ref-autogen/com.azure.core.http.policy.RetryOptions.yml index 3fd09e12ba16..02b459c49379 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.RetryOptions.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.RetryOptions.yml @@ -69,4 +69,4 @@ type: "class" desc: "The configuration for retries." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.RetryPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.RetryPolicy.yml index ea922d9f3ed5..a7709b439ffd 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.RetryPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.RetryPolicy.yml @@ -117,4 +117,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.RetryStrategy.yml b/docs-ref-autogen/com.azure.core.http.policy.RetryStrategy.yml index 3aeaabd3dd18..00904e5f125c 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.RetryStrategy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.RetryStrategy.yml @@ -84,4 +84,4 @@ type: "interface" desc: "The interface for determining the retry strategy used in ." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.TimeoutPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.TimeoutPolicy.yml index cc1a1bae5d34..1281dcc8d322 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.TimeoutPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.TimeoutPolicy.yml @@ -56,4 +56,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.UserAgentPolicy.yml b/docs-ref-autogen/com.azure.core.http.policy.UserAgentPolicy.yml index d37ce86c20c2..6b05d63b56a2 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.UserAgentPolicy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.UserAgentPolicy.yml @@ -150,4 +150,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.policy.yml b/docs-ref-autogen/com.azure.core.http.policy.yml index aef55060eacd..e682f5c6cc63 100644 --- a/docs-ref-autogen/com.azure.core.http.policy.yml +++ b/docs-ref-autogen/com.azure.core.http.policy.yml @@ -45,4 +45,4 @@ interfaces: desc: "Package containing HttpPipelinePolicy interface and its implementations." metadata: {} package: "com.azure.core.http.policy" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.Page.yml b/docs-ref-autogen/com.azure.core.http.rest.Page.yml index b95d0e1794ec..fb04302af766 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.Page.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.Page.yml @@ -29,4 +29,4 @@ implements: - "<String,>" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.PagedFlux.yml b/docs-ref-autogen/com.azure.core.http.rest.PagedFlux.yml index 7a07d5654dbe..4016ff4cd011 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.PagedFlux.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.PagedFlux.yml @@ -537,4 +537,4 @@ typeParameters: desc: "PagedFlux is a Flux that provides the ability to operate on paginated REST responses of type and individual items in such pages. When processing the response by page each response will contain the items in the page as well as the REST response details such as status code and headers.\n\nTo process one item at a time, simply subscribe to this flux as shown below\n\n**Code sample**\n\n```java\n// Subscribe to process one item at a time\n pagedFlux\n .log()\n .subscribe(item -> System.out.println(\"Processing item with value: \" + item),\n error -> System.err.println(\"An error occurred: \" + error),\n () -> System.out.println(\"Processing complete.\"));\n```\n\nTo process one page at a time, use method as shown below\n\n**Code sample**\n\n```java\n// Subscribe to process one page at a time from the beginning\n pagedFlux\n .byPage()\n .log()\n .subscribe(page -> System.out.printf(\"Processing page containing item values: %s%n\",\n page.getElements().stream().map(String::valueOf).collect(Collectors.joining(\", \"))),\n error -> System.err.println(\"An error occurred: \" + error),\n () -> System.out.println(\"Processing complete.\"));\n```\n\nTo process items one page at a time starting from any page associated with a continuation token, use as shown below\n\n**Code sample**\n\n```java\n// Subscribe to process one page at a time starting from a page associated with\n // a continuation token\n String continuationToken = getContinuationToken();\n pagedFlux\n .byPage(continuationToken)\n .log()\n .doOnSubscribe(ignored -> System.out.println(\n \"Subscribed to paged flux processing pages starting from: \" + continuationToken))\n .subscribe(page -> System.out.printf(\"Processing page containing item values: %s%n\",\n page.getElements().stream().map(String::valueOf).collect(Collectors.joining(\", \"))),\n error -> System.err.println(\"An error occurred: \" + error),\n () -> System.out.println(\"Processing complete.\"));\n```" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.PagedFluxBase.yml b/docs-ref-autogen/com.azure.core.http.rest.PagedFluxBase.yml index 51939ca10d16..addf39ddf43b 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.PagedFluxBase.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.PagedFluxBase.yml @@ -518,4 +518,4 @@ desc: "This class is a flux that can operate on any type that extends using and interfaces.\n\n**Code sample using by page**\n\n```java\n// process the streamByPage\n pagedIterableResponse.streamByPage().forEach(resp -> {\n System.out.printf(\"Response headers are %s. Url %s and status code %d %n\", resp.getHeaders(),\n resp.getRequest().getUrl(), resp.getStatusCode());\n resp.getElements().forEach(value -> System.out.printf(\"Response value is %d %n\", value));\n });\n```\n\n**Code sample using by page**\n\n```java\n// process the iterableByPage\n pagedIterableResponse.iterableByPage().forEach(resp -> {\n System.out.printf(\"Response headers are %s. Url %s and status code %d %n\", resp.getHeaders(),\n resp.getRequest().getUrl(), resp.getStatusCode());\n resp.getElements().forEach(value -> System.out.printf(\"Response value is %d %n\", value));\n });\n```\n\n**Code sample using by page and while loop**\n\n```java\n// iterate over each page\n for (PagedResponse resp : pagedIterableResponse.iterableByPage()) {\n System.out.printf(\"Response headers are %s. Url %s and status code %d %n\", resp.getHeaders(),\n resp.getRequest().getUrl(), resp.getStatusCode());\n resp.getElements().forEach(value -> System.out.printf(\"Response value is %d %n\", value));\n }\n```\n\n**Code sample using by page and continuation token**\n\n```java\nString continuationToken = getContinuationToken();\n pagedIterable\n .iterableByPage(continuationToken)\n .forEach(page -> System.out.printf(\"Processing page containing item values: %s%n\",\n page.getElements().stream().map(String::valueOf).collect(Collectors.joining(\", \"))));\n```" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.PagedIterableBase.yml b/docs-ref-autogen/com.azure.core.http.rest.PagedIterableBase.yml index 74397ee635d3..b4f2cd9d7036 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.PagedIterableBase.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.PagedIterableBase.yml @@ -59,4 +59,4 @@ typeParameters: desc: "This class provides utility to iterate over responses that extend using and interfaces.\n\n**Code sample using by page**\n\n```java\n// process the streamByPage\n CustomPagedFlux customPagedFlux = createCustomInstance();\n PagedIterableBase> customPagedIterableResponse =\n new PagedIterableBase<>(customPagedFlux);\n customPagedIterableResponse.streamByPage().forEach(resp -> {\n System.out.printf(\"Response headers are %s. Url %s and status code %d %n\", resp.getHeaders(),\n resp.getRequest().getUrl(), resp.getStatusCode());\n resp.getElements().forEach(value -> System.out.printf(\"Response value is %s %n\", value));\n });\n```\n\n**Code sample using by page**\n\n```java\n// process the iterableByPage\n customPagedIterableResponse.iterableByPage().forEach(resp -> {\n System.out.printf(\"Response headers are %s. Url %s and status code %d %n\", resp.getHeaders(),\n resp.getRequest().getUrl(), resp.getStatusCode());\n resp.getElements().forEach(value -> System.out.printf(\"Response value is %s %n\", value));\n });\n```\n\n**Code sample using by page and while loop**\n\n```java\n// iterate over each page\n for (PagedResponse resp : customPagedIterableResponse.iterableByPage()) {\n System.out.printf(\"Response headers are %s. Url %s and status code %d %n\", resp.getHeaders(),\n resp.getRequest().getUrl(), resp.getStatusCode());\n resp.getElements().forEach(value -> System.out.printf(\"Response value is %s %n\", value));\n }\n```" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.PagedResponse.yml b/docs-ref-autogen/com.azure.core.http.rest.PagedResponse.yml index 295b47bcfab9..3f174c745979 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.PagedResponse.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.PagedResponse.yml @@ -29,4 +29,4 @@ implements: - "<List<>>" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.PagedResponseBase.yml b/docs-ref-autogen/com.azure.core.http.rest.PagedResponseBase.yml index 86c6df11c8cd..d7cbb2d4421e 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.PagedResponseBase.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.PagedResponseBase.yml @@ -144,4 +144,4 @@ implements: - "<>" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.RequestOptions.yml b/docs-ref-autogen/com.azure.core.http.rest.RequestOptions.yml index 32ef06b2ae38..962a861b3cfe 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.RequestOptions.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.RequestOptions.yml @@ -26,7 +26,9 @@ constructors: fullName: "com.azure.core.http.rest.RequestOptions.RequestOptions()" name: "RequestOptions()" nameWithType: "RequestOptions.RequestOptions()" + summary: "Creates a new instance of ." syntax: "public RequestOptions()" + desc: "Creates a new instance of ." methods: - uid: "com.azure.core.http.rest.RequestOptions.addHeader(java.lang.String,java.lang.String)" fullName: "com.azure.core.http.rest.RequestOptions.addHeader(String header, String value)" @@ -155,4 +157,4 @@ type: "class" desc: "This class contains the options to customize an HTTP request. can be used to configure the request headers, query params, the request body, or add a callback to modify all aspects of the HTTP request.\n\nAn instance of fully configured can be passed to a service method that preconfigures known components of the request like URL, path params etc, further modifying both un-configured, or preconfigured components.\n\nTo demonstrate how this class can be used to construct a request, let's use a Pet Store service as an example. The list of APIs available on this service are [documented in the swagger definition.][]\n\n**Creating an instance of RequestOptions**\n\n```java\nRequestOptions options = new RequestOptions()\n .setBody(BinaryData.fromString(\"{\\\"name\\\":\\\"Fluffy\\\"}\"))\n .addHeader(\"x-ms-pet-version\", \"2021-06-01\");\n```\n\n**Configuring the request with JSON body and making a HTTP POST request**\n\nTo [add a new pet to the pet store][], an HTTP POST call should be made to the service with the details of the pet that is to be added. The details of the pet are included as the request body in JSON format. The JSON structure for the request is defined as follows:\n\n```java\n{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n }\n```\n\nTo create a concrete request, Json builder provided in javax package is used here for demonstration. However, any other Json building library can be used to achieve similar results.\n\n```java\nJsonArray photoUrls = Json.createArrayBuilder()\n .add(\"https://imgur.com/pet1\")\n .add(\"https://imgur.com/pet2\")\n .build();\n\n JsonArray tags = Json.createArrayBuilder()\n .add(Json.createObjectBuilder()\n .add(\"id\", 0)\n .add(\"name\", \"Labrador\")\n .build())\n .add(Json.createObjectBuilder()\n .add(\"id\", 1)\n .add(\"name\", \"2021\")\n .build())\n .build();\n\n JsonObject requestBody = Json.createObjectBuilder()\n .add(\"id\", 0)\n .add(\"name\", \"foo\")\n .add(\"status\", \"available\")\n .add(\"category\", Json.createObjectBuilder().add(\"id\", 0).add(\"name\", \"dog\"))\n .add(\"photoUrls\", photoUrls)\n .add(\"tags\", tags)\n .build();\n\n String requestBodyStr = requestBody.toString();\n```\n\nNow, this string representation of the JSON request can be set as body of RequestOptions\n\n```java\nRequestOptions options = new RequestOptions()\n .addRequestCallback(request -> request\n // may already be set if request is created from a client\n .setUrl(\"https://petstore.example.com/pet\")\n .setHttpMethod(HttpMethod.POST)\n .setBody(requestBodyStr)\n .setHeader(\"Content-Type\", \"application/json\"));\n```\n\n\n[documented in the swagger definition.]: https://petstore.swagger.io/#/pet\n[add a new pet to the pet store]: https://petstore.swagger.io/#/pet/addPet" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.Response.yml b/docs-ref-autogen/com.azure.core.http.rest.Response.yml index 9449a68683fa..cd36aff299f6 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.Response.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.Response.yml @@ -61,4 +61,4 @@ typeParameters: desc: "REST response with a strongly-typed content specified." metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.ResponseBase.yml b/docs-ref-autogen/com.azure.core.http.rest.ResponseBase.yml index acd470731189..343dd235be86 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.ResponseBase.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.ResponseBase.yml @@ -104,4 +104,4 @@ implements: - "<>" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.RestProxy.yml b/docs-ref-autogen/com.azure.core.http.rest.RestProxy.yml index 8aee619e21d3..440058d5ca09 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.RestProxy.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.RestProxy.yml @@ -116,4 +116,4 @@ implements: - "InvocationHandler" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.SimpleResponse.yml b/docs-ref-autogen/com.azure.core.http.rest.SimpleResponse.yml index f25dbd9e817a..9c9a775efd0b 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.SimpleResponse.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.SimpleResponse.yml @@ -105,4 +105,4 @@ implements: - "<>" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.StreamResponse.yml b/docs-ref-autogen/com.azure.core.http.rest.StreamResponse.yml index aff33b454cbd..80a34e117d30 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.StreamResponse.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.StreamResponse.yml @@ -112,4 +112,4 @@ implements: - "Closeable" metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.rest.yml b/docs-ref-autogen/com.azure.core.http.rest.yml index 459d095b4215..6d5fe63a0878 100644 --- a/docs-ref-autogen/com.azure.core.http.rest.yml +++ b/docs-ref-autogen/com.azure.core.http.rest.yml @@ -21,4 +21,4 @@ interfaces: desc: "Package containing REST-related APIs." metadata: {} package: "com.azure.core.http.rest" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.http.yml b/docs-ref-autogen/com.azure.core.http.yml index ccf7e45c1d2a..82d26a5c1a5b 100644 --- a/docs-ref-autogen/com.azure.core.http.yml +++ b/docs-ref-autogen/com.azure.core.http.yml @@ -7,6 +7,7 @@ classes: - "com.azure.core.http.ContentType" - "com.azure.core.http.HttpAuthorization" - "com.azure.core.http.HttpHeader" +- "com.azure.core.http.HttpHeaderName" - "com.azure.core.http.HttpHeaders" - "com.azure.core.http.HttpPipeline" - "com.azure.core.http.HttpPipelineBuilder" @@ -29,4 +30,4 @@ interfaces: desc: "Package containing HTTP abstractions between the AnnotationParser, RestProxy, and HTTP client." metadata: {} package: "com.azure.core.http" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.management.AzureEnvironment.Endpoint.yml b/docs-ref-autogen/com.azure.core.management.AzureEnvironment.Endpoint.yml index b9513ee403fd..f2c1e655320f 100644 --- a/docs-ref-autogen/com.azure.core.management.AzureEnvironment.Endpoint.yml +++ b/docs-ref-autogen/com.azure.core.management.AzureEnvironment.Endpoint.yml @@ -143,4 +143,4 @@ methods: desc: "The enum representing available endpoints in an environment." metadata: {} package: "com.azure.core.management" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.AzureEnvironment.yml b/docs-ref-autogen/com.azure.core.management.AzureEnvironment.yml index d9768c970f01..9d4fb2811ca8 100644 --- a/docs-ref-autogen/com.azure.core.management.AzureEnvironment.yml +++ b/docs-ref-autogen/com.azure.core.management.AzureEnvironment.yml @@ -271,4 +271,4 @@ type: "class" desc: "An instance of this class describes an environment in Azure." metadata: {} package: "com.azure.core.management" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.ProxyResource.yml b/docs-ref-autogen/com.azure.core.management.ProxyResource.yml index 4e308b5e3756..ab2dcd1a7c73 100644 --- a/docs-ref-autogen/com.azure.core.management.ProxyResource.yml +++ b/docs-ref-autogen/com.azure.core.management.ProxyResource.yml @@ -62,4 +62,4 @@ type: "class" desc: "The Proxy Resource model." metadata: {} package: "com.azure.core.management" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.Region.yml b/docs-ref-autogen/com.azure.core.management.Region.yml index 6e4daa8a0545..7a7d419996af 100644 --- a/docs-ref-autogen/com.azure.core.management.Region.yml +++ b/docs-ref-autogen/com.azure.core.management.Region.yml @@ -811,4 +811,4 @@ type: "class" desc: "Enumeration of the Azure datacenter regions. See https://azure.microsoft.com/regions/" metadata: {} package: "com.azure.core.management" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.Resource.yml b/docs-ref-autogen/com.azure.core.management.Resource.yml index 5e3854693187..77f736b525e8 100644 --- a/docs-ref-autogen/com.azure.core.management.Resource.yml +++ b/docs-ref-autogen/com.azure.core.management.Resource.yml @@ -86,4 +86,4 @@ type: "class" desc: "The Resource model." metadata: {} package: "com.azure.core.management" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.ResourceAuthorIdentityType.yml b/docs-ref-autogen/com.azure.core.management.ResourceAuthorIdentityType.yml index 2826d3e6fc7d..edd4773f9c40 100644 --- a/docs-ref-autogen/com.azure.core.management.ResourceAuthorIdentityType.yml +++ b/docs-ref-autogen/com.azure.core.management.ResourceAuthorIdentityType.yml @@ -31,7 +31,11 @@ constructors: fullName: "com.azure.core.management.ResourceAuthorIdentityType.ResourceAuthorIdentityType()" name: "ResourceAuthorIdentityType()" nameWithType: "ResourceAuthorIdentityType.ResourceAuthorIdentityType()" - syntax: "public ResourceAuthorIdentityType()" + summary: "Creates a new instance of without a value." + deprecatedTag: "Use one of the constants or the factory method." + syntax: "@Deprecated
public ResourceAuthorIdentityType()" + desc: "Creates a new instance of without a value.\n\nThis constructor shouldn't be called as it will produce a which doesn't have a String enum value." + hasDeprecatedTag: true fields: - uid: "com.azure.core.management.ResourceAuthorIdentityType.APPLICATION" fullName: "com.azure.core.management.ResourceAuthorIdentityType.APPLICATION" @@ -112,4 +116,4 @@ type: "class" desc: "Defines values for identity type of resource author." metadata: {} package: "com.azure.core.management" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.SubResource.yml b/docs-ref-autogen/com.azure.core.management.SubResource.yml index 5bd6aa97d3ff..bf48ca42adff 100644 --- a/docs-ref-autogen/com.azure.core.management.SubResource.yml +++ b/docs-ref-autogen/com.azure.core.management.SubResource.yml @@ -56,4 +56,4 @@ type: "class" desc: "The SubResource model." metadata: {} package: "com.azure.core.management" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.SystemData.yml b/docs-ref-autogen/com.azure.core.management.SystemData.yml index 6a4bbab6f611..31bc0c4005ab 100644 --- a/docs-ref-autogen/com.azure.core.management.SystemData.yml +++ b/docs-ref-autogen/com.azure.core.management.SystemData.yml @@ -92,4 +92,4 @@ type: "class" desc: "Metadata pertaining to creation and last modification of the resource." metadata: {} package: "com.azure.core.management" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.exception.AdditionalInfo.yml b/docs-ref-autogen/com.azure.core.management.exception.AdditionalInfo.yml index 70a813973b88..fd5c8402ca8b 100644 --- a/docs-ref-autogen/com.azure.core.management.exception.AdditionalInfo.yml +++ b/docs-ref-autogen/com.azure.core.management.exception.AdditionalInfo.yml @@ -69,4 +69,4 @@ type: "class" desc: "An instance of this class provides additional information about a ." metadata: {} package: "com.azure.core.management.exception" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.exception.ManagementError.yml b/docs-ref-autogen/com.azure.core.management.exception.ManagementError.yml index 8cc09697f4bc..2a5909e7473b 100644 --- a/docs-ref-autogen/com.azure.core.management.exception.ManagementError.yml +++ b/docs-ref-autogen/com.azure.core.management.exception.ManagementError.yml @@ -96,4 +96,4 @@ type: "class" desc: "An instance of this class provides additional information about an http error response." metadata: {} package: "com.azure.core.management.exception" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.exception.ManagementException.yml b/docs-ref-autogen/com.azure.core.management.exception.ManagementException.yml index f41ed321c7b7..5ae23e070693 100644 --- a/docs-ref-autogen/com.azure.core.management.exception.ManagementException.yml +++ b/docs-ref-autogen/com.azure.core.management.exception.ManagementException.yml @@ -97,4 +97,4 @@ type: "class" desc: "Exception thrown for an invalid response with custom error information." metadata: {} package: "com.azure.core.management.exception" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.exception.yml b/docs-ref-autogen/com.azure.core.management.exception.yml index 5a7850d84e30..ee69af364650 100644 --- a/docs-ref-autogen/com.azure.core.management.exception.yml +++ b/docs-ref-autogen/com.azure.core.management.exception.yml @@ -10,4 +10,4 @@ classes: desc: "Package containing the error types for Azure ARM client." metadata: {} package: "com.azure.core.management.exception" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.http.policy.ArmChallengeAuthenticationPolicy.yml b/docs-ref-autogen/com.azure.core.management.http.policy.ArmChallengeAuthenticationPolicy.yml index 0a5c51ca2ae5..ad30c971fc31 100644 --- a/docs-ref-autogen/com.azure.core.management.http.policy.ArmChallengeAuthenticationPolicy.yml +++ b/docs-ref-autogen/com.azure.core.management.http.policy.ArmChallengeAuthenticationPolicy.yml @@ -115,4 +115,4 @@ type: "class" desc: "The pipeline policy that applies a token credential to an HTTP request with \"Bearer\" scheme in ARM challenge based authentication scenarios." metadata: {} package: "com.azure.core.management.http.policy" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.http.policy.yml b/docs-ref-autogen/com.azure.core.management.http.policy.yml index 0587e242b1f8..b509652d4c49 100644 --- a/docs-ref-autogen/com.azure.core.management.http.policy.yml +++ b/docs-ref-autogen/com.azure.core.management.http.policy.yml @@ -8,4 +8,4 @@ classes: desc: "Package containing the implementations of HttpPipelinePolicy interface." metadata: {} package: "com.azure.core.management.http.policy" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.polling.PollResult.Error.yml b/docs-ref-autogen/com.azure.core.management.polling.PollResult.Error.yml index 6cc160e7311d..2a6187ec0b23 100644 --- a/docs-ref-autogen/com.azure.core.management.polling.PollResult.Error.yml +++ b/docs-ref-autogen/com.azure.core.management.polling.PollResult.Error.yml @@ -79,4 +79,4 @@ type: "class" desc: "Type represents the error that poll-operation received from the service." metadata: {} package: "com.azure.core.management.polling" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.polling.PollResult.yml b/docs-ref-autogen/com.azure.core.management.polling.PollResult.yml index a285b16ea6ef..1e10021473b9 100644 --- a/docs-ref-autogen/com.azure.core.management.polling.PollResult.yml +++ b/docs-ref-autogen/com.azure.core.management.polling.PollResult.yml @@ -72,4 +72,4 @@ typeParameters: desc: "Type representing result (succeeded or failed result) of a long-running-poll operation." metadata: {} package: "com.azure.core.management.polling" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.polling.PollerFactory.yml b/docs-ref-autogen/com.azure.core.management.polling.PollerFactory.yml index 6f86e084ff2f..03312cb09e0e 100644 --- a/docs-ref-autogen/com.azure.core.management.polling.PollerFactory.yml +++ b/docs-ref-autogen/com.azure.core.management.polling.PollerFactory.yml @@ -221,4 +221,4 @@ type: "class" desc: "Factory to create PollerFlux for Azure resource manager (ARM) long-running-operation (LRO)." metadata: {} package: "com.azure.core.management.polling" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.polling.yml b/docs-ref-autogen/com.azure.core.management.polling.yml index f41f7a98206c..8a2767b50e20 100644 --- a/docs-ref-autogen/com.azure.core.management.polling.yml +++ b/docs-ref-autogen/com.azure.core.management.polling.yml @@ -10,4 +10,4 @@ classes: desc: "Package containing the classes that handling long-running operation\n for Azure ARM client side http communication with a REST endpoint." metadata: {} package: "com.azure.core.management.polling" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.profile.AzureProfile.yml b/docs-ref-autogen/com.azure.core.management.profile.AzureProfile.yml index d4cfcda8c93d..bffc2a5d951e 100644 --- a/docs-ref-autogen/com.azure.core.management.profile.AzureProfile.yml +++ b/docs-ref-autogen/com.azure.core.management.profile.AzureProfile.yml @@ -85,4 +85,4 @@ type: "class" desc: "Azure profile for client." metadata: {} package: "com.azure.core.management.profile" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.profile.yml b/docs-ref-autogen/com.azure.core.management.profile.yml index 1631d9833e00..5db80c1a81a3 100644 --- a/docs-ref-autogen/com.azure.core.management.profile.yml +++ b/docs-ref-autogen/com.azure.core.management.profile.yml @@ -8,4 +8,4 @@ classes: desc: "Package containing the profile types for Azure ARM client." metadata: {} package: "com.azure.core.management.profile" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.provider.DelayProvider.yml b/docs-ref-autogen/com.azure.core.management.provider.DelayProvider.yml index 43c1e202e357..65768b37ae29 100644 --- a/docs-ref-autogen/com.azure.core.management.provider.DelayProvider.yml +++ b/docs-ref-autogen/com.azure.core.management.provider.DelayProvider.yml @@ -26,4 +26,4 @@ type: "interface" desc: "The DelayProvider to help thread sleep." metadata: {} package: "com.azure.core.management.provider" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.provider.IdentifierProvider.yml b/docs-ref-autogen/com.azure.core.management.provider.IdentifierProvider.yml index e64fd43d8087..c3eeb1974e30 100644 --- a/docs-ref-autogen/com.azure.core.management.provider.IdentifierProvider.yml +++ b/docs-ref-autogen/com.azure.core.management.provider.IdentifierProvider.yml @@ -41,4 +41,4 @@ type: "interface" desc: "The IdentifierProvider to help generate distinct values." metadata: {} package: "com.azure.core.management.provider" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.provider.yml b/docs-ref-autogen/com.azure.core.management.provider.yml index 21754a77c873..e09a6a4a4984 100644 --- a/docs-ref-autogen/com.azure.core.management.provider.yml +++ b/docs-ref-autogen/com.azure.core.management.provider.yml @@ -9,4 +9,4 @@ interfaces: desc: "Package containing the provider types for Azure ARM client." metadata: {} package: "com.azure.core.management.provider" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.serializer.SerializerFactory.yml b/docs-ref-autogen/com.azure.core.management.serializer.SerializerFactory.yml index 6739475c3bd2..92b5795596c7 100644 --- a/docs-ref-autogen/com.azure.core.management.serializer.SerializerFactory.yml +++ b/docs-ref-autogen/com.azure.core.management.serializer.SerializerFactory.yml @@ -39,4 +39,4 @@ type: "class" desc: "Factory to create SerializerAdapter for Azure resource manager (ARM)." metadata: {} package: "com.azure.core.management.serializer" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.serializer.yml b/docs-ref-autogen/com.azure.core.management.serializer.yml index e6d6d17cdece..68c50b238a6f 100644 --- a/docs-ref-autogen/com.azure.core.management.serializer.yml +++ b/docs-ref-autogen/com.azure.core.management.serializer.yml @@ -8,4 +8,4 @@ classes: desc: "Package containing the classes that handle serialization and deserialization for the REST call payloads in Azure ARM." metadata: {} package: "com.azure.core.management.serializer" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.management.yml b/docs-ref-autogen/com.azure.core.management.yml index 046c8d42c9ed..1e340e403bf4 100644 --- a/docs-ref-autogen/com.azure.core.management.yml +++ b/docs-ref-autogen/com.azure.core.management.yml @@ -16,4 +16,4 @@ enums: desc: "Package containing the types for Azure ARM client side http communication with a REST endpoint." metadata: {} package: "com.azure.core.management" -artifact: com.azure:azure-core-management:1.8.1 +artifact: com.azure:azure-core-management:1.9.0 diff --git a/docs-ref-autogen/com.azure.core.models.CloudEvent.yml b/docs-ref-autogen/com.azure.core.models.CloudEvent.yml index e20c299fc419..450d1e937964 100644 --- a/docs-ref-autogen/com.azure.core.models.CloudEvent.yml +++ b/docs-ref-autogen/com.azure.core.models.CloudEvent.yml @@ -248,4 +248,4 @@ type: "class" desc: "Represents the CloudEvent conforming to the 1.0 schema defined by the [Cloud Native Computing Foundation][]. CloudEvents is a specification for describing event data in common formats to provide interoperability across services, platforms and systems. \n\nSome Azure services, for instance, EventGrid, are compatible with this specification. You can use this class to communicate with these Azure services.\n\nDepending on your scenario, you can either use the constructor to create a CloudEvent, or use the factory method to deserialize CloudEvent instances from a Json String representation of CloudEvents.\n\nIf you have the data payload of a CloudEvent and want to send it out, use the constructor to create it. Then you can serialize the CloudEvent into its Json String representation and send it.\n\n**Create CloudEvent Samples**\n\n```java\n// Use BinaryData.fromBytes() to create data in format CloudEventDataFormat.BYTES\n byte[] exampleBytes = \"Hello World\".getBytes(StandardCharsets.UTF_8);\n CloudEvent cloudEvent = new CloudEvent(\"/cloudevents/example/source\", \"Example.EventType\",\n BinaryData.fromBytes(exampleBytes), CloudEventDataFormat.BYTES, \"application/octet-stream\");\n\n // Use BinaryData.fromObject() to create CloudEvent data in format CloudEventDataFormat.JSON\n // From a model class\n User user = new User(\"Stephen\", \"James\");\n CloudEvent cloudEventDataObject = new CloudEvent(\"/cloudevents/example/source\", \"Example.EventType\",\n BinaryData.fromObject(user), CloudEventDataFormat.JSON, \"application/json\");\n\n // From a String\n CloudEvent cloudEventDataStr = new CloudEvent(\"/cloudevents/example/source\", \"Example.EventType\",\n BinaryData.fromObject(\"Hello World\"), CloudEventDataFormat.JSON, \"text/plain\");\n\n // From an Integer\n CloudEvent cloudEventDataInt = new CloudEvent(\"/cloudevents/example/source\", \"Example.EventType\",\n BinaryData.fromObject(1), CloudEventDataFormat.JSON, \"int\");\n\n // From a Boolean\n CloudEvent cloudEventDataBool = new CloudEvent(\"/cloudevents/example/source\", \"Example.EventType\",\n BinaryData.fromObject(true), CloudEventDataFormat.JSON, \"bool\");\n\n // From null\n CloudEvent cloudEventDataNull = new CloudEvent(\"/cloudevents/example/source\", \"Example.EventType\",\n BinaryData.fromObject(null), CloudEventDataFormat.JSON, \"null\");\n\n // Use BinaryData.fromString() if you have a Json String for the CloudEvent data.\n String jsonStringForData = \"\\\"Hello World\\\"\"; // A json String.\n CloudEvent cloudEventDataJsonStr = new CloudEvent(\"/cloudevents/example/source\", \"Example.EventType\",\n BinaryData.fromString(jsonStringForData), CloudEventDataFormat.JSON, \"text/plain\");\n```\n\nOn the contrary, if you receive CloudEvents and have the Json string representation of one or more of CloudEvents, use to deserialize them from the Json string.\n\n**Deserialize CloudEvent Samples**\n\n```java\nList cloudEventList = CloudEvent.fromString(cloudEventJsonString);\n CloudEvent cloudEvent = cloudEventList.get(0);\n BinaryData cloudEventData = cloudEvent.getData();\n\n byte[] bytesValue = cloudEventData.toBytes(); // If data payload is in bytes (data_base64 is not null).\n User objectValue = cloudEventData.toObject(User.class); // If data payload is a User object.\n int intValue = cloudEventData.toObject(Integer.class); // If data payload is an int.\n boolean boolValue = cloudEventData.toObject(Boolean.class); // If data payload is boolean.\n String stringValue = cloudEventData.toObject(String.class); // If data payload is String.\n String jsonStringValue = cloudEventData.toString(); // The data payload represented in Json String.\n```\n\n\n[Cloud Native Computing Foundation]: https://github.com/cloudevents/spec/blob/v1.0.1/spec.md" metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.CloudEventDataFormat.yml b/docs-ref-autogen/com.azure.core.models.CloudEventDataFormat.yml index f075919579d6..8ec9621ab0e9 100644 --- a/docs-ref-autogen/com.azure.core.models.CloudEventDataFormat.yml +++ b/docs-ref-autogen/com.azure.core.models.CloudEventDataFormat.yml @@ -31,7 +31,11 @@ constructors: fullName: "com.azure.core.models.CloudEventDataFormat.CloudEventDataFormat()" name: "CloudEventDataFormat()" nameWithType: "CloudEventDataFormat.CloudEventDataFormat()" - syntax: "public CloudEventDataFormat()" + summary: "Creates a new instance of without a value." + deprecatedTag: "Use one of the constants or the factory method." + syntax: "@Deprecated
public CloudEventDataFormat()" + desc: "Creates a new instance of without a value.\n\nThis constructor shouldn't be called as it will produce a which doesn't have a String enum value." + hasDeprecatedTag: true fields: - uid: "com.azure.core.models.CloudEventDataFormat.BYTES" fullName: "com.azure.core.models.CloudEventDataFormat.BYTES" @@ -57,8 +61,25 @@ fields: type: "" syntax: "public static final CloudEventDataFormat JSON" desc: "JSON format." +methods: +- uid: "com.azure.core.models.CloudEventDataFormat.fromString(java.lang.String)" + fullName: "com.azure.core.models.CloudEventDataFormat.fromString(String name)" + name: "fromString(String name)" + nameWithType: "CloudEventDataFormat.fromString(String name)" + summary: "Creates or gets a CloudEventDataFormat from its string representation." + modifiers: + - "static" + parameters: + - description: "Name of the CloudEventDataFormat." + name: "name" + type: "String" + syntax: "public static CloudEventDataFormat fromString(String name)" + desc: "Creates or gets a CloudEventDataFormat from its string representation." + returns: + description: "The corresponding CloudEventDataFormat." + type: "" type: "class" desc: "Representation of the data format for a .\n\nWhen constructing a this is passed to determine the serialized format of the event's data. If is used the data will be stored as a Base64 encoded string, otherwise it will be stored as a JSON serialized object." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoBoundingBox.yml b/docs-ref-autogen/com.azure.core.models.GeoBoundingBox.yml index e65232c5fff6..0bedf18c111f 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoBoundingBox.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoBoundingBox.yml @@ -160,4 +160,4 @@ type: "class" desc: "Represents a geometric bounding box." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoCollection.yml b/docs-ref-autogen/com.azure.core.models.GeoCollection.yml index bcdacaa23878..f049834060f5 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoCollection.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoCollection.yml @@ -100,4 +100,4 @@ type: "class" desc: "Represents a heterogeneous collection of ." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoLineString.yml b/docs-ref-autogen/com.azure.core.models.GeoLineString.yml index 4174b951bf8b..98399e2319c7 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoLineString.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoLineString.yml @@ -100,4 +100,4 @@ type: "class" desc: "Represents a geometric line." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoLineStringCollection.yml b/docs-ref-autogen/com.azure.core.models.GeoLineStringCollection.yml index fe441be27ccc..6750ae2aee19 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoLineStringCollection.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoLineStringCollection.yml @@ -100,4 +100,4 @@ type: "class" desc: "Represents a collection of ." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoLinearRing.yml b/docs-ref-autogen/com.azure.core.models.GeoLinearRing.yml index 3ee6b4ccbef8..1542b5941426 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoLinearRing.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoLinearRing.yml @@ -67,4 +67,4 @@ type: "class" desc: "Represents a linear ring that is part of a ." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoObject.yml b/docs-ref-autogen/com.azure.core.models.GeoObject.yml index 76dcadd5bb96..9c93cf0ce04e 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoObject.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoObject.yml @@ -98,4 +98,4 @@ type: "class" desc: "An abstract geo object." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoObjectType.yml b/docs-ref-autogen/com.azure.core.models.GeoObjectType.yml index 48752676b6f3..e3a9acba50d4 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoObjectType.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoObjectType.yml @@ -3,7 +3,7 @@ uid: "com.azure.core.models.GeoObjectType" fullName: "com.azure.core.models.GeoObjectType" name: "GeoObjectType" nameWithType: "GeoObjectType" -summary: "Represents the type of a GeoJSON object." +summary: "Represents the type of GeoJSON object." inheritances: - "" - "" @@ -31,7 +31,11 @@ constructors: fullName: "com.azure.core.models.GeoObjectType.GeoObjectType()" name: "GeoObjectType()" nameWithType: "GeoObjectType.GeoObjectType()" - syntax: "public GeoObjectType()" + summary: "Creates a new instance of without a value." + deprecatedTag: "Use one of the constants or the factory method." + syntax: "@Deprecated
public GeoObjectType()" + desc: "Creates a new instance of without a value.\n\nThis constructor shouldn't be called as it will produce a which doesn't have a String enum value." + hasDeprecatedTag: true fields: - uid: "com.azure.core.models.GeoObjectType.GEOMETRY_COLLECTION" fullName: "com.azure.core.models.GeoObjectType.GEOMETRY_COLLECTION" @@ -147,7 +151,7 @@ methods: description: "All known GeoObjectType values." type: "Collection<>" type: "class" -desc: "Represents the type of a GeoJSON object." +desc: "Represents the type of GeoJSON object." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoPoint.yml b/docs-ref-autogen/com.azure.core.models.GeoPoint.yml index 06ef9e179ced..d1622605486b 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoPoint.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoPoint.yml @@ -131,4 +131,4 @@ type: "class" desc: "Represents a geometric point." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoPointCollection.yml b/docs-ref-autogen/com.azure.core.models.GeoPointCollection.yml index 42cd54a1d06b..bdd1b3a9b0ce 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoPointCollection.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoPointCollection.yml @@ -100,4 +100,4 @@ type: "class" desc: "Represents a collection of ." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoPolygon.yml b/docs-ref-autogen/com.azure.core.models.GeoPolygon.yml index 61da638ed7b0..95748d4870da 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoPolygon.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoPolygon.yml @@ -138,4 +138,4 @@ type: "class" desc: "Represents a geometric polygon." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoPolygonCollection.yml b/docs-ref-autogen/com.azure.core.models.GeoPolygonCollection.yml index 62b02445a59f..f7ddf3ebd1e1 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoPolygonCollection.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoPolygonCollection.yml @@ -100,4 +100,4 @@ type: "class" desc: "Represents a collection of ." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.GeoPosition.yml b/docs-ref-autogen/com.azure.core.models.GeoPosition.yml index afd9769326d8..21f7347f1f07 100644 --- a/docs-ref-autogen/com.azure.core.models.GeoPosition.yml +++ b/docs-ref-autogen/com.azure.core.models.GeoPosition.yml @@ -125,4 +125,4 @@ type: "class" desc: "Represents a geo position." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.JsonPatchDocument.yml b/docs-ref-autogen/com.azure.core.models.JsonPatchDocument.yml index a3d69859d9c3..8c44a3fb361a 100644 --- a/docs-ref-autogen/com.azure.core.models.JsonPatchDocument.yml +++ b/docs-ref-autogen/com.azure.core.models.JsonPatchDocument.yml @@ -206,4 +206,4 @@ type: "class" desc: "Represents a JSON Patch document." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.MessageContent.yml b/docs-ref-autogen/com.azure.core.models.MessageContent.yml index ed8ef6172cc9..12c735c91db4 100644 --- a/docs-ref-autogen/com.azure.core.models.MessageContent.yml +++ b/docs-ref-autogen/com.azure.core.models.MessageContent.yml @@ -26,7 +26,9 @@ constructors: fullName: "com.azure.core.models.MessageContent.MessageContent()" name: "MessageContent()" nameWithType: "MessageContent.MessageContent()" + summary: "Creates a new instance of ." syntax: "public MessageContent()" + desc: "Creates a new instance of ." methods: - uid: "com.azure.core.models.MessageContent.getBodyAsBinaryData()" fullName: "com.azure.core.models.MessageContent.getBodyAsBinaryData()" @@ -80,4 +82,4 @@ type: "class" desc: "An abstraction for a message containing a content type along with its data." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.ResponseError.yml b/docs-ref-autogen/com.azure.core.models.ResponseError.yml index 62a99e07e0f1..4a3a13b349e3 100644 --- a/docs-ref-autogen/com.azure.core.models.ResponseError.yml +++ b/docs-ref-autogen/com.azure.core.models.ResponseError.yml @@ -61,4 +61,4 @@ type: "class" desc: "This class represents the error details of an HTTP response." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.models.yml b/docs-ref-autogen/com.azure.core.models.yml index d3c78618ffdc..dd82caaeac30 100644 --- a/docs-ref-autogen/com.azure.core.models.yml +++ b/docs-ref-autogen/com.azure.core.models.yml @@ -24,4 +24,4 @@ classes: desc: "Package containing core model classes." metadata: {} package: "com.azure.core.models" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializer.yml b/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializer.yml index 8cc4c65da640..ee889231dce2 100644 --- a/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializer.yml +++ b/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializer.yml @@ -95,4 +95,4 @@ implements: - "" metadata: {} package: "com.azure.core.serializer.json.gson" -artifact: com.azure:azure-core-serializer-json-gson:1.1.21 +artifact: com.azure:azure-core-serializer-json-gson:1.1.22 diff --git a/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializerBuilder.yml b/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializerBuilder.yml index c33f1b5f44c2..16da5249351f 100644 --- a/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializerBuilder.yml +++ b/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializerBuilder.yml @@ -56,4 +56,4 @@ type: "class" desc: "Fluent builder class that configures and instantiates instances of ." metadata: {} package: "com.azure.core.serializer.json.gson" -artifact: com.azure:azure-core-serializer-json-gson:1.1.21 +artifact: com.azure:azure-core-serializer-json-gson:1.1.22 diff --git a/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializerProvider.yml b/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializerProvider.yml index df55fc5e529c..c90d7ad15aae 100644 --- a/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializerProvider.yml +++ b/docs-ref-autogen/com.azure.core.serializer.json.gson.GsonJsonSerializerProvider.yml @@ -42,4 +42,4 @@ implements: - "" metadata: {} package: "com.azure.core.serializer.json.gson" -artifact: com.azure:azure-core-serializer-json-gson:1.1.21 +artifact: com.azure:azure-core-serializer-json-gson:1.1.22 diff --git a/docs-ref-autogen/com.azure.core.serializer.json.gson.yml b/docs-ref-autogen/com.azure.core.serializer.json.gson.yml index 14e8edf4987c..02f558cd4232 100644 --- a/docs-ref-autogen/com.azure.core.serializer.json.gson.yml +++ b/docs-ref-autogen/com.azure.core.serializer.json.gson.yml @@ -10,4 +10,4 @@ classes: desc: "Package containing the types for instantiating and using the Gson JSON serializer." metadata: {} package: "com.azure.core.serializer.json.gson" -artifact: com.azure:azure-core-serializer-json-gson:1.1.21 +artifact: com.azure:azure-core-serializer-json-gson:1.1.22 diff --git a/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializer.yml b/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializer.yml index 226c353319d5..15fedbeab066 100644 --- a/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializer.yml +++ b/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializer.yml @@ -129,4 +129,4 @@ implements: - "" metadata: {} package: "com.azure.core.serializer.json.jackson" -artifact: com.azure:azure-core-serializer-json-jackson:1.2.22 +artifact: com.azure:azure-core-serializer-json-jackson:1.2.23 diff --git a/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializerBuilder.yml b/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializerBuilder.yml index 078017886538..6a5cd08f849e 100644 --- a/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializerBuilder.yml +++ b/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializerBuilder.yml @@ -56,4 +56,4 @@ type: "class" desc: "Fluent builder class that configures and instantiates instances of ." metadata: {} package: "com.azure.core.serializer.json.jackson" -artifact: com.azure:azure-core-serializer-json-jackson:1.2.22 +artifact: com.azure:azure-core-serializer-json-jackson:1.2.23 diff --git a/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializerProvider.yml b/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializerProvider.yml index 967af60644e7..c547e1c3c5b7 100644 --- a/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializerProvider.yml +++ b/docs-ref-autogen/com.azure.core.serializer.json.jackson.JacksonJsonSerializerProvider.yml @@ -42,4 +42,4 @@ implements: - "" metadata: {} package: "com.azure.core.serializer.json.jackson" -artifact: com.azure:azure-core-serializer-json-jackson:1.2.22 +artifact: com.azure:azure-core-serializer-json-jackson:1.2.23 diff --git a/docs-ref-autogen/com.azure.core.serializer.json.jackson.yml b/docs-ref-autogen/com.azure.core.serializer.json.jackson.yml index eebf116b95b6..b7d906acd4ad 100644 --- a/docs-ref-autogen/com.azure.core.serializer.json.jackson.yml +++ b/docs-ref-autogen/com.azure.core.serializer.json.jackson.yml @@ -10,4 +10,4 @@ classes: desc: "Package containing the types for instantiating and using the Jackson JSON serializer." metadata: {} package: "com.azure.core.serializer.json.jackson" -artifact: com.azure:azure-core-serializer-json-jackson:1.2.22 +artifact: com.azure:azure-core-serializer-json-jackson:1.2.23 diff --git a/docs-ref-autogen/com.azure.core.util.AsyncCloseable.yml b/docs-ref-autogen/com.azure.core.util.AsyncCloseable.yml index efe2f4cf0e58..5ea6175ca1f6 100644 --- a/docs-ref-autogen/com.azure.core.util.AsyncCloseable.yml +++ b/docs-ref-autogen/com.azure.core.util.AsyncCloseable.yml @@ -22,4 +22,4 @@ type: "interface" desc: "Interface for close operations that are asynchronous.\n\n**Asynchronously closing a class**\n\nIn the snippet below, we have a long-lived `NetworkResource` class. There are some operations such as closing I/O. Instead of returning a sync `close()`, we use `closeAsync()` so users' programs don't block waiting for this operation to complete.\n\n```java\nNetworkResource resource = new NetworkResource();\n resource.longRunningDownload(\"https://longdownload.com\")\n .subscribe(\n byteBuffer -> System.out.println(\"Buffer received: \" + byteBuffer),\n error -> System.err.printf(\"Error occurred while downloading: %s%n\", error),\n () -> System.out.println(\"Completed download operation.\"));\n\n System.out.println(\"Press enter to stop downloading.\");\n System.in.read();\n\n // We block here because it is the end of the main Program function. A real-life program may chain this\n // with some other close operations like save download/program state, etc.\n resource.closeAsync().block();\n```" metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.AuthorizationChallengeHandler.yml b/docs-ref-autogen/com.azure.core.util.AuthorizationChallengeHandler.yml index 5f93e231ee9a..fd649234f8f6 100644 --- a/docs-ref-autogen/com.azure.core.util.AuthorizationChallengeHandler.yml +++ b/docs-ref-autogen/com.azure.core.util.AuthorizationChallengeHandler.yml @@ -208,4 +208,4 @@ type: "class" desc: "This class handles Basic and Digest authorization challenges, complying to RFC 2617 and RFC 7616." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.Base64Url.yml b/docs-ref-autogen/com.azure.core.util.Base64Url.yml index 53e874b6d287..6a93accc8866 100644 --- a/docs-ref-autogen/com.azure.core.util.Base64Url.yml +++ b/docs-ref-autogen/com.azure.core.util.Base64Url.yml @@ -112,4 +112,4 @@ type: "class" desc: "Encodes and decodes using Base64 URL encoding." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.Base64Util.yml b/docs-ref-autogen/com.azure.core.util.Base64Util.yml index b7ec2444d520..7415db72e814 100644 --- a/docs-ref-autogen/com.azure.core.util.Base64Util.yml +++ b/docs-ref-autogen/com.azure.core.util.Base64Util.yml @@ -122,4 +122,4 @@ type: "class" desc: "Utility type exposing Base64 encoding and decoding methods." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.BinaryData.yml b/docs-ref-autogen/com.azure.core.util.BinaryData.yml index 589c17081d8f..9dd7f31fd5b9 100644 --- a/docs-ref-autogen/com.azure.core.util.BinaryData.yml +++ b/docs-ref-autogen/com.azure.core.util.BinaryData.yml @@ -313,7 +313,7 @@ methods: name: "bufferContent" type: "" syntax: "public static Mono fromFlux(Flux data, Long length, boolean bufferContent)" - desc: "Creates an instance of from the given of .\n\n**Create an instance from a Flux of ByteBuffer**\n\n```java\nfinal byte[] data = \"Some Data\".getBytes(StandardCharsets.UTF_8);\n final long length = data.length;\n final boolean shouldAggregateData = false;\n final Flux dataFlux = Flux.just(ByteBuffer.wrap(data));\n\n Mono binaryDataMono = BinaryData.fromFlux(dataFlux, length, shouldAggregateData);\n\n Disposable subscriber = binaryDataMono\n .map(binaryData -> {\n System.out.println(binaryData.toString());\n return true;\n })\n .subscribe();\n\n // So that your program wait for above subscribe to complete.\n TimeUnit.SECONDS.sleep(5);\n subscriber.dispose();\n```" + desc: "Creates an instance of from the given of .\n\nIf `bufferContent` is true and `length` is null the length of the returned will be based on the length calculated by buffering. If `length` is non-null it will always be used as the length even if buffering determines a different length.\n\n**Create an instance from a Flux of ByteBuffer**\n\n```java\nfinal byte[] data = \"Some Data\".getBytes(StandardCharsets.UTF_8);\n final long length = data.length;\n final boolean shouldAggregateData = false;\n final Flux dataFlux = Flux.just(ByteBuffer.wrap(data));\n\n Mono binaryDataMono = BinaryData.fromFlux(dataFlux, length, shouldAggregateData);\n\n Disposable subscriber = binaryDataMono\n .map(binaryData -> {\n System.out.println(binaryData.toString());\n return true;\n })\n .subscribe();\n\n // So that your program wait for above subscribe to complete.\n TimeUnit.SECONDS.sleep(5);\n subscriber.dispose();\n```" returns: description: "A of representing the of ." type: "Mono<>" @@ -509,7 +509,7 @@ methods: nameWithType: "BinaryData.toBytes()" summary: "Returns a byte array representation of this ." syntax: "public byte[] toBytes()" - desc: "Returns a byte array representation of this . This method returns a reference to the underlying byte array. Modifying the contents of the returned byte array will also change the content of this BinaryData instance. If the content source of this BinaryData instance is a file, an Inputstream or a `Flux` the source is not modified. To safely update the byte array, it is recommended to make a copy of the contents first." + desc: "Returns a byte array representation of this .\n\nThis method returns a reference to the underlying byte array. Modifying the contents of the returned byte array may change the content of this BinaryData instance. If the content source of this BinaryData instance is a file, an , or a `Flux` the source is not modified. To safely update the byte array, it is recommended to make a copy of the contents first.\n\nIf the is larger than the maximum size allowed for a `byte[]` this will throw an ." returns: description: "A byte array representing this ." type: "[]" @@ -560,7 +560,7 @@ methods: summary: "Returns a representation of this by converting its data using the UTF-8 character set." overridden: "java.lang.Object.toString()" syntax: "public String toString()" - desc: "Returns a representation of this by converting its data using the UTF-8 character set. A new instance of String is created each time this method is called." + desc: "Returns a representation of this by converting its data using the UTF-8 character set. A new instance of String is created each time this method is called.\n\nIf the is larger than the maximum size allowed for a this will throw an ." returns: description: "A representing this ." type: "String" @@ -568,4 +568,4 @@ type: "class" desc: "BinaryData is a convenient data interchange class for use throughout the Azure SDK for Java. Put simply, BinaryData enables developers to bring data in from external sources, and read it back from Azure services, in formats that appeal to them. This leaves BinaryData, and the Azure SDK for Java, the task of converting this data into appropriate formats to be transferred to and from these external services. This enables developers to focus on their business logic, and enables the Azure SDK for Java to optimize operations for best performance.\n\nBinaryData in its simplest form can be thought of as a container for content. Often this content is already in-memory as a String, byte array, or an Object that can be serialized into a String or byte\\[\\]. When the BinaryData is about to be sent to an Azure Service, this in-memory content is copied into the network request and sent to the service.\n\nIn more performance critical scenarios, where copying data into memory results in increased memory pressure, it is possible to create a BinaryData instance from a stream of data. From this, BinaryData can be connected directly to the outgoing network connection so that the stream is read directly to the network, without needing to first be read into memory on the system. Similarly, it is possible to read a stream of data from a BinaryData returned from an Azure Service without it first being read into memory. In many situations, these streaming operations can drastically reduce the memory pressure in applications, and so it is encouraged that all developers very carefully consider their ability to use the most appropriate API in BinaryData whenever they encounter an client library that makes use of BinaryData.\n\nRefer to the documentation of each method in the BinaryData class to better understand its performance characteristics, and refer to the samples below to understand the common usage scenarios of this class.\n\n can be created from an , a of , a , an , a , or a byte array.\n\n**A note on data mutability**\n\n does not copy data on construction. BinaryData keeps a reference to the source content and is accessed when a read request is made. So, any modifications to the underlying source before the content is read can result in undefined behavior.\n\nTo create an instance of , use the various static factory methods available. They all start with `'from'` prefix, for example .\n\n**Create an instance from a byte array**\n\n```java\nfinal byte[] data = \"Some Data\".getBytes(StandardCharsets.UTF_8);\n BinaryData binaryData = BinaryData.fromBytes(data);\n System.out.println(new String(binaryData.toBytes(), StandardCharsets.UTF_8));\n```\n\n**Create an instance from a String**\n\n```java\nfinal String data = \"Some Data\";\n // Following will use default character set as StandardCharsets.UTF_8\n BinaryData binaryData = BinaryData.fromString(data);\n System.out.println(binaryData.toString());\n```\n\n**Create an instance from an InputStream**\n\n```java\nfinal ByteArrayInputStream inputStream = new ByteArrayInputStream(\"Some Data\".getBytes(StandardCharsets.UTF_8));\n BinaryData binaryData = BinaryData.fromStream(inputStream);\n System.out.println(binaryData.toString());\n```\n\n**Create an instance from an Object**\n\n```java\nclass Person {\n @JsonProperty\n private String name;\n\n @JsonSetter\n public Person setName(String name) {\n this.name = name;\n return this;\n }\n\n @JsonGetter\n public String getName() {\n return name;\n }\n }\n final Person data = new Person().setName(\"John\");\n\n // Provide your custom serializer or use Azure provided serializers.\n // https://mvnrepository.com/artifact/com.azure/azure-core-serializer-json-jackson or\n // https://mvnrepository.com/artifact/com.azure/azure-core-serializer-json-gson\n BinaryData binaryData = BinaryData.fromObject(data);\n\n System.out.println(binaryData.toString());\n```\n\n**Create an instance from `Flux`**\n\n```java\nfinal byte[] data = \"Some Data\".getBytes(StandardCharsets.UTF_8);\n final Flux dataFlux = Flux.just(ByteBuffer.wrap(data));\n\n Mono binaryDataMono = BinaryData.fromFlux(dataFlux);\n\n Disposable subscriber = binaryDataMono\n .map(binaryData -> {\n System.out.println(binaryData.toString());\n return true;\n })\n .subscribe();\n\n // So that your program wait for above subscribe to complete.\n TimeUnit.SECONDS.sleep(5);\n subscriber.dispose();\n```\n\n**Create an instance from a file**\n\n```java\nBinaryData binaryData = BinaryData.fromFile(new File(\"path/to/file\").toPath());\n System.out.println(new String(binaryData.toBytes(), StandardCharsets.UTF_8));\n```" metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ClientOptions.yml b/docs-ref-autogen/com.azure.core.util.ClientOptions.yml index 4f4dffca2459..e1878d219c53 100644 --- a/docs-ref-autogen/com.azure.core.util.ClientOptions.yml +++ b/docs-ref-autogen/com.azure.core.util.ClientOptions.yml @@ -26,7 +26,9 @@ constructors: fullName: "com.azure.core.util.ClientOptions.ClientOptions()" name: "ClientOptions()" nameWithType: "ClientOptions.ClientOptions()" + summary: "Creates a new instance of ." syntax: "public ClientOptions()" + desc: "Creates a new instance of ." methods: - uid: "com.azure.core.util.ClientOptions.getApplicationId()" fullName: "com.azure.core.util.ClientOptions.getApplicationId()" @@ -104,4 +106,4 @@ type: "class" desc: "General configuration options for clients." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.Configuration.yml b/docs-ref-autogen/com.azure.core.util.Configuration.yml index 5fc91210f0d3..d67d909b8ed5 100644 --- a/docs-ref-autogen/com.azure.core.util.Configuration.yml +++ b/docs-ref-autogen/com.azure.core.util.Configuration.yml @@ -617,4 +617,4 @@ implements: - "Cloneable" metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ConfigurationBuilder.yml b/docs-ref-autogen/com.azure.core.util.ConfigurationBuilder.yml index bf0ea7ab1ed0..56a6b6ed4d35 100644 --- a/docs-ref-autogen/com.azure.core.util.ConfigurationBuilder.yml +++ b/docs-ref-autogen/com.azure.core.util.ConfigurationBuilder.yml @@ -117,4 +117,4 @@ type: "class" desc: "Builds with external source." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ConfigurationProperty.yml b/docs-ref-autogen/com.azure.core.util.ConfigurationProperty.yml index 896350a01cda..c30969f70d4e 100644 --- a/docs-ref-autogen/com.azure.core.util.ConfigurationProperty.yml +++ b/docs-ref-autogen/com.azure.core.util.ConfigurationProperty.yml @@ -119,4 +119,4 @@ typeParameters: desc: "Represents configuration property." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ConfigurationPropertyBuilder.yml b/docs-ref-autogen/com.azure.core.util.ConfigurationPropertyBuilder.yml index 58342810370a..d67669a2b224 100644 --- a/docs-ref-autogen/com.azure.core.util.ConfigurationPropertyBuilder.yml +++ b/docs-ref-autogen/com.azure.core.util.ConfigurationPropertyBuilder.yml @@ -216,4 +216,4 @@ typeParameters: desc: "Builds configuration property." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ConfigurationSource.yml b/docs-ref-autogen/com.azure.core.util.ConfigurationSource.yml index 1fc2105747eb..bc5963be1dd4 100644 --- a/docs-ref-autogen/com.azure.core.util.ConfigurationSource.yml +++ b/docs-ref-autogen/com.azure.core.util.ConfigurationSource.yml @@ -26,4 +26,4 @@ type: "interface" desc: "Configuration property source which provides configuration values from a specific place. Samples may include properties file supported by frameworks or other source. Note that environment configuration (environment variables and system properties) are supported by default and don't need a source implementation." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.Context.yml b/docs-ref-autogen/com.azure.core.util.Context.yml index ce034b283bd9..5fcb23bd8de4 100644 --- a/docs-ref-autogen/com.azure.core.util.Context.yml +++ b/docs-ref-autogen/com.azure.core.util.Context.yml @@ -111,4 +111,4 @@ type: "class" desc: "`Context` offers a means of passing arbitrary data (key-value pairs) to pipeline policies. Most applications do not need to pass arbitrary data to the pipeline and can pass `Context.NONE` or `null`.\n\nEach context object is immutable. The method creates a new `Context` object that refers to its parent, forming a linked list." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.Contexts.yml b/docs-ref-autogen/com.azure.core.util.Contexts.yml index ab09687a86a6..ec54a0b6fb94 100644 --- a/docs-ref-autogen/com.azure.core.util.Contexts.yml +++ b/docs-ref-autogen/com.azure.core.util.Contexts.yml @@ -88,4 +88,4 @@ type: "class" desc: "A utility type that can be used to add and retrieve instances commonly used in ." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.CoreUtils.yml b/docs-ref-autogen/com.azure.core.util.CoreUtils.yml index 488db1d1c2f4..23aa8031ab78 100644 --- a/docs-ref-autogen/com.azure.core.util.CoreUtils.yml +++ b/docs-ref-autogen/com.azure.core.util.CoreUtils.yml @@ -333,4 +333,4 @@ type: "class" desc: "This class contains utility methods useful for building client libraries." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.DateTimeRfc1123.yml b/docs-ref-autogen/com.azure.core.util.DateTimeRfc1123.yml index 4b9bb32fb8aa..1258a2130788 100644 --- a/docs-ref-autogen/com.azure.core.util.DateTimeRfc1123.yml +++ b/docs-ref-autogen/com.azure.core.util.DateTimeRfc1123.yml @@ -102,4 +102,4 @@ type: "class" desc: "Wrapper over java.time.OffsetDateTime used for specifying RFC1123 format during serialization and deserialization." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ETag.yml b/docs-ref-autogen/com.azure.core.util.ETag.yml index 2929eb8b1b96..6aca6e998574 100644 --- a/docs-ref-autogen/com.azure.core.util.ETag.yml +++ b/docs-ref-autogen/com.azure.core.util.ETag.yml @@ -78,4 +78,4 @@ type: "class" desc: "This class represents an HTTP ETag. An ETag value could be strong or weak ETag. For more information, check out [Wikipedia's HTTP Etag][Wikipedia_s HTTP Etag].\n\n\n[Wikipedia_s HTTP Etag]: https://en.wikipedia.org/wiki/HTTP_ETag" metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ExpandableStringEnum.yml b/docs-ref-autogen/com.azure.core.util.ExpandableStringEnum.yml index 3b3344c62389..c71cba1e7ed9 100644 --- a/docs-ref-autogen/com.azure.core.util.ExpandableStringEnum.yml +++ b/docs-ref-autogen/com.azure.core.util.ExpandableStringEnum.yml @@ -26,7 +26,11 @@ constructors: fullName: "com.azure.core.util.ExpandableStringEnum.ExpandableStringEnum()" name: "ExpandableStringEnum()" nameWithType: "ExpandableStringEnum.ExpandableStringEnum()" - syntax: "public ExpandableStringEnum()" + summary: "Creates a new instance of without a value." + deprecatedTag: "Use the fromString(java.lang.String,java.lang.Class)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String, Class)\"> factory method." + syntax: "@Deprecated
public ExpandableStringEnum()" + desc: "Creates a new instance of without a value.\n\nThis constructor shouldn't be called as it will produce a which doesn't have a String enum value." + hasDeprecatedTag: true methods: - uid: "com.azure.core.util.ExpandableStringEnum.fromString(java.lang.String,java.lang.Class)" fullName: "com.azure.core.util.ExpandableStringEnum.fromString(String name, Class clazz)" @@ -99,4 +103,4 @@ typeParameters: desc: "Base implementation for expandable, single string enums." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.FluxUtil.yml b/docs-ref-autogen/com.azure.core.util.FluxUtil.yml index 5fc903da0d4b..fe6088a02eaf 100644 --- a/docs-ref-autogen/com.azure.core.util.FluxUtil.yml +++ b/docs-ref-autogen/com.azure.core.util.FluxUtil.yml @@ -533,4 +533,4 @@ type: "class" desc: "Utility type exposing methods to deal with ." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.Header.yml b/docs-ref-autogen/com.azure.core.util.Header.yml index c1dd58e548e9..fb873217c703 100644 --- a/docs-ref-autogen/com.azure.core.util.Header.yml +++ b/docs-ref-autogen/com.azure.core.util.Header.yml @@ -131,4 +131,4 @@ type: "class" desc: "Represents a single header to be set on a request.\n\nIf multiple header values are added to a request with the same name (case-insensitive), then the values will be appended at the end of the same with commas separating them." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.HttpClientOptions.yml b/docs-ref-autogen/com.azure.core.util.HttpClientOptions.yml index 306f98065e0b..b49a5841d5ba 100644 --- a/docs-ref-autogen/com.azure.core.util.HttpClientOptions.yml +++ b/docs-ref-autogen/com.azure.core.util.HttpClientOptions.yml @@ -35,7 +35,9 @@ constructors: fullName: "com.azure.core.util.HttpClientOptions.HttpClientOptions()" name: "HttpClientOptions()" nameWithType: "HttpClientOptions.HttpClientOptions()" + summary: "Creates a new instance of ." syntax: "public HttpClientOptions()" + desc: "Creates a new instance of ." methods: - uid: "com.azure.core.util.HttpClientOptions.getConfiguration()" fullName: "com.azure.core.util.HttpClientOptions.getConfiguration()" @@ -311,4 +313,4 @@ type: "class" desc: "General configuration options for .\n\n implementations may not support all configuration options in this class." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.IterableStream.yml b/docs-ref-autogen/com.azure.core.util.IterableStream.yml index 8b20e931efcc..53353c664a5f 100644 --- a/docs-ref-autogen/com.azure.core.util.IterableStream.yml +++ b/docs-ref-autogen/com.azure.core.util.IterableStream.yml @@ -90,4 +90,4 @@ implements: - "Iterable<>" metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.MetricsOptions.yml b/docs-ref-autogen/com.azure.core.util.MetricsOptions.yml index 5fb30329d160..3cfc2a3291cb 100644 --- a/docs-ref-autogen/com.azure.core.util.MetricsOptions.yml +++ b/docs-ref-autogen/com.azure.core.util.MetricsOptions.yml @@ -74,4 +74,4 @@ type: "class" desc: "Metrics configuration options for clients." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ProgressListener.yml b/docs-ref-autogen/com.azure.core.util.ProgressListener.yml index 7853d4042edc..6d29b17857b1 100644 --- a/docs-ref-autogen/com.azure.core.util.ProgressListener.yml +++ b/docs-ref-autogen/com.azure.core.util.ProgressListener.yml @@ -23,4 +23,4 @@ type: "interface" desc: "A is an interface that can be used to listen to the progress of the I/O transfers. The method will be called periodically with the total progress accumulated at the given point of time.\n\n**Code samples**\n\n```java\n/**\n * A simple operation that simulates I/O activity.\n * @param progressReporter The {@link ProgressReporter}.\n */\n public static void simpleOperation(ProgressReporter progressReporter) {\n for (long i = 0; i < 100; i++) {\n // Simulate 100 I/Os with 10 progress.\n progressReporter.reportProgress(10);\n }\n }\n\n /**\n * A complex operation that simulates I/O activity by invoking multiple {@link #simpleOperation(ProgressReporter)}.\n * @param progressReporter The {@link ProgressReporter}.\n */\n public static void complexOperation(ProgressReporter progressReporter) {\n simpleOperation(progressReporter.createChild());\n simpleOperation(progressReporter.createChild());\n simpleOperation(progressReporter.createChild());\n }\n\n /**\n * The main method.\n * @param args Program arguments.\n */\n public static void main(String[] args) {\n // Execute simpleOperation\n ProgressReporter simpleOperationProgressReporter = ProgressReporter\n .withProgressListener(progress -> System.out.println(\"Simple operation progress \" + progress));\n simpleOperation(simpleOperationProgressReporter);\n\n // Execute complexOperation\n ProgressReporter complexOperationProgressReporter = ProgressReporter\n .withProgressListener(progress -> System.out.println(\"Complex operation progress \" + progress));\n complexOperation(complexOperationProgressReporter);\n }\n```" metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ProgressReporter.yml b/docs-ref-autogen/com.azure.core.util.ProgressReporter.yml index 24e46cb2fea5..9b451ffb6e8c 100644 --- a/docs-ref-autogen/com.azure.core.util.ProgressReporter.yml +++ b/docs-ref-autogen/com.azure.core.util.ProgressReporter.yml @@ -70,4 +70,4 @@ type: "class" desc: " offers a convenient way to add progress tracking to I/O operations.\n\nThe can be used to track a single operation as well as the progress of complex operations that involve multiple sub-operations. In the latter case forms a tree where child nodes track the progress of sub-operations and report to the parent which in turn aggregates the total progress. The reporting tree can have arbitrary level of nesting.\n\n**Code samples**\n\n```java\n/**\n * A simple operation that simulates I/O activity.\n * @param progressReporter The {@link ProgressReporter}.\n */\n public static void simpleOperation(ProgressReporter progressReporter) {\n for (long i = 0; i < 100; i++) {\n // Simulate 100 I/Os with 10 progress.\n progressReporter.reportProgress(10);\n }\n }\n\n /**\n * A complex operation that simulates I/O activity by invoking multiple {@link #simpleOperation(ProgressReporter)}.\n * @param progressReporter The {@link ProgressReporter}.\n */\n public static void complexOperation(ProgressReporter progressReporter) {\n simpleOperation(progressReporter.createChild());\n simpleOperation(progressReporter.createChild());\n simpleOperation(progressReporter.createChild());\n }\n\n /**\n * The main method.\n * @param args Program arguments.\n */\n public static void main(String[] args) {\n // Execute simpleOperation\n ProgressReporter simpleOperationProgressReporter = ProgressReporter\n .withProgressListener(progress -> System.out.println(\"Simple operation progress \" + progress));\n simpleOperation(simpleOperationProgressReporter);\n\n // Execute complexOperation\n ProgressReporter complexOperationProgressReporter = ProgressReporter\n .withProgressListener(progress -> System.out.println(\"Complex operation progress \" + progress));\n complexOperation(complexOperationProgressReporter);\n }\n```" metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ReferenceManager.yml b/docs-ref-autogen/com.azure.core.util.ReferenceManager.yml index e1fc78c80da0..1f7f226908ea 100644 --- a/docs-ref-autogen/com.azure.core.util.ReferenceManager.yml +++ b/docs-ref-autogen/com.azure.core.util.ReferenceManager.yml @@ -39,4 +39,4 @@ type: "interface" desc: "This interface represents managing references to and providing the ability to run a cleaning operation once the object is no longer able to be reference.\n\nExpected usage of this is through ." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.ServiceVersion.yml b/docs-ref-autogen/com.azure.core.util.ServiceVersion.yml index 358a3980cdd5..70e58012aeb5 100644 --- a/docs-ref-autogen/com.azure.core.util.ServiceVersion.yml +++ b/docs-ref-autogen/com.azure.core.util.ServiceVersion.yml @@ -22,4 +22,4 @@ type: "interface" desc: "A generic interface for sending HTTP requests using the provided service version." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.TelemetryAttributes.yml b/docs-ref-autogen/com.azure.core.util.TelemetryAttributes.yml index 67cfc2bc34af..b8d3463313f4 100644 --- a/docs-ref-autogen/com.azure.core.util.TelemetryAttributes.yml +++ b/docs-ref-autogen/com.azure.core.util.TelemetryAttributes.yml @@ -9,4 +9,4 @@ type: "interface" desc: "Generic attribute collection applicable to metrics, tracing and logging implementations. Implementation is capable of handling different attribute types, caching and optimizing the internal representation." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.UrlBuilder.yml b/docs-ref-autogen/com.azure.core.util.UrlBuilder.yml index 1bf84ee83797..256611b454bd 100644 --- a/docs-ref-autogen/com.azure.core.util.UrlBuilder.yml +++ b/docs-ref-autogen/com.azure.core.util.UrlBuilder.yml @@ -278,4 +278,4 @@ type: "class" desc: "A builder class that is used to create URLs." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.UserAgentProperties.yml b/docs-ref-autogen/com.azure.core.util.UserAgentProperties.yml index d73d7f468e08..91fb1501b0ee 100644 --- a/docs-ref-autogen/com.azure.core.util.UserAgentProperties.yml +++ b/docs-ref-autogen/com.azure.core.util.UserAgentProperties.yml @@ -46,4 +46,4 @@ type: "class" desc: "Class to hold the properties used in user agent strings." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.UserAgentUtil.yml b/docs-ref-autogen/com.azure.core.util.UserAgentUtil.yml index c6c000935e15..f3267ad8cf79 100644 --- a/docs-ref-autogen/com.azure.core.util.UserAgentUtil.yml +++ b/docs-ref-autogen/com.azure.core.util.UserAgentUtil.yml @@ -65,4 +65,4 @@ type: "class" desc: "Utility for building user agent string for Azure client libraries as specified in the [design guidelines][].\n\n\n[design guidelines]: https://azure.github.io/azure-sdk/general_azurecore.html#telemetry-policy" metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.builder.ClientBuilderUtil.yml b/docs-ref-autogen/com.azure.core.util.builder.ClientBuilderUtil.yml index 9bbbe6489718..96862c8f74c2 100644 --- a/docs-ref-autogen/com.azure.core.util.builder.ClientBuilderUtil.yml +++ b/docs-ref-autogen/com.azure.core.util.builder.ClientBuilderUtil.yml @@ -67,4 +67,4 @@ type: "class" desc: "This class contains utility methods useful for client builders." metadata: {} package: "com.azure.core.util.builder" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.builder.yml b/docs-ref-autogen/com.azure.core.util.builder.yml index bcc832c4a2c4..bcde852ebda8 100644 --- a/docs-ref-autogen/com.azure.core.util.builder.yml +++ b/docs-ref-autogen/com.azure.core.util.builder.yml @@ -8,4 +8,4 @@ classes: desc: "Package containing utilities for client builders." metadata: {} package: "com.azure.core.util.builder" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.io.IOUtils.yml b/docs-ref-autogen/com.azure.core.util.io.IOUtils.yml index d228c7149194..2f849c2fc658 100644 --- a/docs-ref-autogen/com.azure.core.util.io.IOUtils.yml +++ b/docs-ref-autogen/com.azure.core.util.io.IOUtils.yml @@ -111,4 +111,4 @@ type: "class" desc: "Utilities related to IO operations that involve channels, streams, byte transfers." metadata: {} package: "com.azure.core.util.io" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.io.yml b/docs-ref-autogen/com.azure.core.util.io.yml index a42f2ef1d9a4..4d0ade527199 100644 --- a/docs-ref-autogen/com.azure.core.util.io.yml +++ b/docs-ref-autogen/com.azure.core.util.io.yml @@ -8,4 +8,4 @@ classes: desc: "Package containing APIs for IO operations." metadata: {} package: "com.azure.core.util.io" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.logging.ClientLogger.yml b/docs-ref-autogen/com.azure.core.util.logging.ClientLogger.yml index 772896454a0d..276e116991be 100644 --- a/docs-ref-autogen/com.azure.core.util.logging.ClientLogger.yml +++ b/docs-ref-autogen/com.azure.core.util.logging.ClientLogger.yml @@ -334,4 +334,4 @@ type: "class" desc: "This is a fluent logger helper class that wraps a pluggable .\n\nThis logger logs format-able messages that use `{}` as the placeholder. When a is the last argument of the format varargs and the logger is enabled for , the stack trace for the throwable is logged.\n\nA minimum logging level threshold is determined by the environment configuration. By default logging is **disabled**.\n\n**Log level hierarchy**\n\n1. \n2. \n3. \n4. \n\nThe logger is capable of producing json-formatted messages enriched with key value pairs. Context can be provided in the constructor and populated on every message or added per each log record." metadata: {} package: "com.azure.core.util.logging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.logging.LogLevel.yml b/docs-ref-autogen/com.azure.core.util.logging.LogLevel.yml index b57396c03f47..e179e41f4cbe 100644 --- a/docs-ref-autogen/com.azure.core.util.logging.LogLevel.yml +++ b/docs-ref-autogen/com.azure.core.util.logging.LogLevel.yml @@ -111,4 +111,4 @@ methods: desc: "Enum which represent logging levels used in Azure SDKs." metadata: {} package: "com.azure.core.util.logging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.logging.LoggingEventBuilder.yml b/docs-ref-autogen/com.azure.core.util.logging.LoggingEventBuilder.yml index 37db60855e33..3fc330e3a583 100644 --- a/docs-ref-autogen/com.azure.core.util.logging.LoggingEventBuilder.yml +++ b/docs-ref-autogen/com.azure.core.util.logging.LoggingEventBuilder.yml @@ -189,4 +189,4 @@ type: "class" desc: "This class provides fluent API to write logs using and enrich them with additional context.\n\n**Code samples**\n\nLogging event with context.\n\n```java\nlogger.atInfo()\n .addKeyValue(\"key1\", \"value1\")\n .addKeyValue(\"key2\", true)\n .addKeyValue(\"key3\", () -> getName())\n .log(\"A formattable message. Hello, {}\", name);\n```" metadata: {} package: "com.azure.core.util.logging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.logging.yml b/docs-ref-autogen/com.azure.core.util.logging.yml index 86dbe1ffca68..7b1356436f99 100644 --- a/docs-ref-autogen/com.azure.core.util.logging.yml +++ b/docs-ref-autogen/com.azure.core.util.logging.yml @@ -11,4 +11,4 @@ enums: desc: "Package containing logging APIs." metadata: {} package: "com.azure.core.util.logging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.metrics.DoubleHistogram.yml b/docs-ref-autogen/com.azure.core.util.metrics.DoubleHistogram.yml index 40761374ee61..454e89ff0074 100644 --- a/docs-ref-autogen/com.azure.core.util.metrics.DoubleHistogram.yml +++ b/docs-ref-autogen/com.azure.core.util.metrics.DoubleHistogram.yml @@ -41,4 +41,4 @@ type: "interface" desc: "A histogram instrument that records `long` values." metadata: {} package: "com.azure.core.util.metrics" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.metrics.LongCounter.yml b/docs-ref-autogen/com.azure.core.util.metrics.LongCounter.yml index c48abe4a648a..2fdc47091aa2 100644 --- a/docs-ref-autogen/com.azure.core.util.metrics.LongCounter.yml +++ b/docs-ref-autogen/com.azure.core.util.metrics.LongCounter.yml @@ -41,4 +41,4 @@ type: "interface" desc: "A counter instrument that records `long` values.\n\nCounters only allow adding positive values, and guarantee the resulting metrics will be always-increasing monotonic sums." metadata: {} package: "com.azure.core.util.metrics" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.metrics.LongGauge.yml b/docs-ref-autogen/com.azure.core.util.metrics.LongGauge.yml index e1daea085d1f..8e9746d0c879 100644 --- a/docs-ref-autogen/com.azure.core.util.metrics.LongGauge.yml +++ b/docs-ref-autogen/com.azure.core.util.metrics.LongGauge.yml @@ -41,4 +41,4 @@ type: "interface" desc: "A counter instrument that records `long` values.\n\nCounters only allow adding positive values, and guarantee the resulting metrics will be always-increasing monotonic sums." metadata: {} package: "com.azure.core.util.metrics" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.metrics.Meter.yml b/docs-ref-autogen/com.azure.core.util.metrics.Meter.yml index a436eaa5a9cd..650d6badff33 100644 --- a/docs-ref-autogen/com.azure.core.util.metrics.Meter.yml +++ b/docs-ref-autogen/com.azure.core.util.metrics.Meter.yml @@ -135,4 +135,4 @@ implements: - "AutoCloseable" metadata: {} package: "com.azure.core.util.metrics" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.metrics.MeterProvider.yml b/docs-ref-autogen/com.azure.core.util.metrics.MeterProvider.yml index 9e033a06a743..ffb14a7c1e92 100644 --- a/docs-ref-autogen/com.azure.core.util.metrics.MeterProvider.yml +++ b/docs-ref-autogen/com.azure.core.util.metrics.MeterProvider.yml @@ -44,4 +44,4 @@ type: "interface" desc: "Resolves and provides implementation. This class is intended to be used by Azure client libraries and provides abstraction over different metrics implementations. Application developers should use metrics implementations such as OpenTelemetry or Micrometer directly." metadata: {} package: "com.azure.core.util.metrics" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.metrics.yml b/docs-ref-autogen/com.azure.core.util.metrics.yml index b40976c7e9ba..14aec0b6a1f5 100644 --- a/docs-ref-autogen/com.azure.core.util.metrics.yml +++ b/docs-ref-autogen/com.azure.core.util.metrics.yml @@ -12,4 +12,4 @@ interfaces: desc: "Package containing core utility classes." metadata: {} package: "com.azure.core.util.metrics" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.paging.ContinuablePage.yml b/docs-ref-autogen/com.azure.core.util.paging.ContinuablePage.yml index a8e9f60be2de..10c29f478ee5 100644 --- a/docs-ref-autogen/com.azure.core.util.paging.ContinuablePage.yml +++ b/docs-ref-autogen/com.azure.core.util.paging.ContinuablePage.yml @@ -39,4 +39,4 @@ typeParameters: desc: "Represents a page returned, this page may contain a reference to additional pages known as a continuation token." metadata: {} package: "com.azure.core.util.paging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedFlux.yml b/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedFlux.yml index 466d9a436a4d..1e485b148b48 100644 --- a/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedFlux.yml +++ b/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedFlux.yml @@ -539,4 +539,4 @@ typeParameters: desc: "This class is a implementation that provides the ability to operate on pages of type and individual items in such pages. This type supports user-provided continuation tokens, allowing for restarting from a previously-retrieved continuation token." metadata: {} package: "com.azure.core.util.paging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedFluxCore.yml b/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedFluxCore.yml index 0e161b5c1486..5eec9aed8840 100644 --- a/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedFluxCore.yml +++ b/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedFluxCore.yml @@ -572,4 +572,4 @@ typeParameters: desc: "The default implementation of . This type is a Flux that provides the ability to operate on pages of type and individual items in such pages. This type supports user-provided continuation tokens, allowing for restarting from a previously-retrieved continuation token. The type is backed by the Page Retriever provider provided in it's constructor. The provider is expected to return when called. The provider is invoked for each Subscription to this Flux. Given provider is called per Subscription, the provider implementation can create one or more objects to store any state and Page Retriever can capture and use those objects. This indirectly associate the state objects to the Subscription. The Page Retriever can get called multiple times in serial fashion, each time after the completion of the Flux returned by the previous invocation. The final completion signal will be send to the Subscriber when the last Page emitted by the Flux returned by the Page Retriever has `null` continuation token.\n\n**Extending PagedFluxCore for Custom Continuation Token support**\n\n```java\nclass ContinuationState {\n private C lastContinuationToken;\n private boolean isDone;\n\n ContinuationState(C token) {\n this.lastContinuationToken = token;\n }\n\n void setLastContinuationToken(C token) {\n this.isDone = token == null;\n this.lastContinuationToken = token;\n }\n\n C getLastContinuationToken() {\n return this.lastContinuationToken;\n }\n\n boolean isDone() {\n return this.isDone;\n }\n }\n\n class FileContinuationToken {\n private final int nextLinkId;\n\n FileContinuationToken(int nextLinkId) {\n this.nextLinkId = nextLinkId;\n }\n\n public int getNextLinkId() {\n return nextLinkId;\n }\n }\n\n class File {\n private final String guid;\n\n File(String guid) {\n this.guid = guid;\n }\n\n public String getGuid() {\n return guid;\n }\n }\n\n class FilePage implements ContinuablePage {\n private final IterableStream elements;\n private final FileContinuationToken fileContinuationToken;\n\n FilePage(List elements, FileContinuationToken fileContinuationToken) {\n this.elements = IterableStream.of(elements);\n this.fileContinuationToken = fileContinuationToken;\n }\n\n @Override\n public IterableStream getElements() {\n return elements;\n }\n\n @Override\n public FileContinuationToken getContinuationToken() {\n return fileContinuationToken;\n }\n }\n\n class FileShareServiceClient {\n Flux getFilePages(FileContinuationToken token) {\n List files = Collections.singletonList(new File(UUID.randomUUID().toString()));\n if (token.getNextLinkId() < 10) {\n return Flux.just(new FilePage(files, null));\n } else {\n return Flux.just(new FilePage(files,\n new FileContinuationToken((int) Math.floor(Math.random() * 20))));\n }\n }\n }\n\n FileShareServiceClient client = new FileShareServiceClient();\n\n Supplier> pageRetrieverProvider = () ->\n (continuationToken, pageSize) -> client.getFilePages(continuationToken);\n\n class FilePagedFlux extends ContinuablePagedFluxCore {\n FilePagedFlux(Supplier>\n pageRetrieverProvider) {\n super(pageRetrieverProvider);\n }\n }\n\n FilePagedFlux filePagedFlux = new FilePagedFlux(pageRetrieverProvider);\n```" metadata: {} package: "com.azure.core.util.paging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedIterable.yml b/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedIterable.yml index d540d5fc85bc..5b94ce6472e8 100644 --- a/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedIterable.yml +++ b/docs-ref-autogen/com.azure.core.util.paging.ContinuablePagedIterable.yml @@ -212,4 +212,4 @@ typeParameters: desc: "This class provides utility to iterate over using interfaces." metadata: {} package: "com.azure.core.util.paging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.paging.PageRetriever.yml b/docs-ref-autogen/com.azure.core.util.paging.PageRetriever.yml index 810f94ce92b9..a7711503d3fd 100644 --- a/docs-ref-autogen/com.azure.core.util.paging.PageRetriever.yml +++ b/docs-ref-autogen/com.azure.core.util.paging.PageRetriever.yml @@ -34,4 +34,4 @@ typeParameters: desc: "This class handles retrieving pages." metadata: {} package: "com.azure.core.util.paging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.paging.PageRetrieverSync.yml b/docs-ref-autogen/com.azure.core.util.paging.PageRetrieverSync.yml index c3dedfd89265..7bf031fc821a 100644 --- a/docs-ref-autogen/com.azure.core.util.paging.PageRetrieverSync.yml +++ b/docs-ref-autogen/com.azure.core.util.paging.PageRetrieverSync.yml @@ -34,4 +34,4 @@ typeParameters: desc: "This class handles retrieving page synchronously." metadata: {} package: "com.azure.core.util.paging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.paging.yml b/docs-ref-autogen/com.azure.core.util.paging.yml index 8196b66aa528..d42fbcece901 100644 --- a/docs-ref-autogen/com.azure.core.util.paging.yml +++ b/docs-ref-autogen/com.azure.core.util.paging.yml @@ -14,4 +14,4 @@ interfaces: desc: "Package containing paging abstraction." metadata: {} package: "com.azure.core.util.paging" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.AsyncPollResponse.yml b/docs-ref-autogen/com.azure.core.util.polling.AsyncPollResponse.yml index f89e64fcee20..619dd13e990c 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.AsyncPollResponse.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.AsyncPollResponse.yml @@ -26,17 +26,21 @@ methods: fullName: "com.azure.core.util.polling.AsyncPollResponse.cancelOperation()" name: "cancelOperation()" nameWithType: "AsyncPollResponse.cancelOperation()" + summary: "Gets a whereupon subscription it cancels the remote long-running operation if cancellation is supported by the service." syntax: "public Mono cancelOperation()" + desc: "Gets a whereupon subscription it cancels the remote long-running operation if cancellation is supported by the service." returns: - description: "a Mono, upon subscription it cancels the remote long-running operation if cancellation\n is supported by the service." + description: "A whereupon subscription it cancels the remote long-running operation if cancellation\n is supported by the service." type: "Mono<>" - uid: "com.azure.core.util.polling.AsyncPollResponse.getFinalResult()" fullName: "com.azure.core.util.polling.AsyncPollResponse.getFinalResult()" name: "getFinalResult()" nameWithType: "AsyncPollResponse.getFinalResult()" + summary: "Gets a whereupon subscription it fetches the final result of the long-running operation if it is supported by the service." syntax: "public Mono getFinalResult()" + desc: "Gets a whereupon subscription it fetches the final result of the long-running operation if it is supported by the service.\n\nIf the long-running operation isn't complete an empty will be returned." returns: - description: "a Mono, upon subscription it fetches the final result of long-running operation if it\n is supported by the service. If the long-running operation is not completed, then an empty\n Mono will be returned." + description: "A whereupon subscription it fetches the final result of the long-running operation if it is\n supported by the service. If the long-running operation is not completed, then an empty will be\n returned." type: "Mono<>" - uid: "com.azure.core.util.polling.AsyncPollResponse.getStatus()" fullName: "com.azure.core.util.polling.AsyncPollResponse.getStatus()" @@ -67,4 +71,4 @@ typeParameters: desc: "AsyncPollResponse represents an event emitted by the that asynchronously polls a long-running operation (LRO). An AsyncPollResponse event provides information such as the current of the LRO, any returned by the poll, as well as other useful information provided by the service. AsyncPollResponse also exposes method to cancel the long-running operation from reactor operator chain and method that returns final result of the long-running operation." metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.ChainedPollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.ChainedPollingStrategy.yml index e197b5b6d315..d56903f13f47 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.ChainedPollingStrategy.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.ChainedPollingStrategy.yml @@ -115,4 +115,4 @@ implements: - "<,>" metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.DefaultPollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.DefaultPollingStrategy.yml index f88a200ad70c..9789c9170c93 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.DefaultPollingStrategy.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.DefaultPollingStrategy.yml @@ -152,4 +152,4 @@ implements: - "<,>" metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.LocationPollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.LocationPollingStrategy.yml index 9c5b122519f8..34c085c4c59a 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.LocationPollingStrategy.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.LocationPollingStrategy.yml @@ -152,4 +152,4 @@ implements: - "<,>" metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.LongRunningOperationStatus.yml b/docs-ref-autogen/com.azure.core.util.polling.LongRunningOperationStatus.yml index 33f30bd45b48..103f3002beba 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.LongRunningOperationStatus.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.LongRunningOperationStatus.yml @@ -31,7 +31,11 @@ constructors: fullName: "com.azure.core.util.polling.LongRunningOperationStatus.LongRunningOperationStatus()" name: "LongRunningOperationStatus()" nameWithType: "LongRunningOperationStatus.LongRunningOperationStatus()" - syntax: "public LongRunningOperationStatus()" + summary: "Creates a new instance of without a value." + deprecatedTag: "Use one of the constants or the factory method." + syntax: "@Deprecated
public LongRunningOperationStatus()" + desc: "Creates a new instance of without a value.\n\nThis constructor shouldn't be called as it will produce a which doesn't have a String enum value." + hasDeprecatedTag: true fields: - uid: "com.azure.core.util.polling.LongRunningOperationStatus.FAILED" fullName: "com.azure.core.util.polling.LongRunningOperationStatus.FAILED" @@ -127,4 +131,4 @@ type: "class" desc: "An enum to represent all possible states that a long-running operation may find itself in. The poll operation is considered complete when the status is one of `SUCCESSFULLY_COMPLETED`, `USER_CANCELLED` or `FAILED`." metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.OperationResourcePollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.OperationResourcePollingStrategy.yml index bb7b03e9d7f6..f032c4fbd637 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.OperationResourcePollingStrategy.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.OperationResourcePollingStrategy.yml @@ -161,4 +161,4 @@ implements: - "<,>" metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.PollResponse.yml b/docs-ref-autogen/com.azure.core.util.polling.PollResponse.yml index 70a149bd438f..415022a04d81 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.PollResponse.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.PollResponse.yml @@ -91,4 +91,4 @@ typeParameters: desc: "PollResponse represents a single response from a service for a long-running polling operation. It provides information such as the current of the long-running operation, any returned in the poll, as well as other useful information provided by the service.\n\n**Code Sample Creating PollResponse Object**\n\n```java\n// Lets say we want to crete poll response with status as IN_PROGRESS\n\n PollResponse inProgressPollResponse\n = new PollResponse<>(LongRunningOperationStatus.IN_PROGRESS, \"my custom response\");\n```\n\n**Code Sample Creating PollResponse Object with custom status**\n\n```java\n// Lets say we want to crete poll response with custom status as OTHER_CUSTOM_STATUS\n\n PollResponse pollResponseWithCustomStatus\n = new PollResponse<>(LongRunningOperationStatus.fromString(\"OTHER_CUSTOM_STATUS\", false),\n \"my custom status response\");\n```" metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.PollerFlux.yml b/docs-ref-autogen/com.azure.core.util.polling.PollerFlux.yml index bf1e52410803..18b9f1e7ffb7 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.PollerFlux.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.PollerFlux.yml @@ -541,7 +541,9 @@ methods: fullName: "com.azure.core.util.polling.PollerFlux.getSyncPoller()" name: "getSyncPoller()" nameWithType: "PollerFlux.getSyncPoller()" + summary: "Gets a synchronous blocking poller." syntax: "public SyncPoller getSyncPoller()" + desc: "Gets a synchronous blocking poller." returns: description: "a synchronous blocking poller." type: "<,>" @@ -577,4 +579,4 @@ typeParameters: desc: "A Flux that simplifies the task of executing long running operations against an Azure service. A subscription to initiates a long running operation and polls the status until it completes.\n\n**Code samples**\n\n**Instantiating and subscribing to PollerFlux**\n\n```java\nLocalDateTime timeToReturnFinalResponse = LocalDateTime.now().plus(Duration.ofMillis(800));\n\n // Create poller instance\n PollerFlux poller = new PollerFlux<>(Duration.ofMillis(100),\n (context) -> Mono.empty(),\n // Define your custom poll operation\n (context) -> {\n if (LocalDateTime.now().isBefore(timeToReturnFinalResponse)) {\n System.out.println(\"Returning intermediate response.\");\n return Mono.just(new PollResponse<>(LongRunningOperationStatus.IN_PROGRESS,\n \"Operation in progress.\"));\n } else {\n System.out.println(\"Returning final response.\");\n return Mono.just(new PollResponse<>(LongRunningOperationStatus.SUCCESSFULLY_COMPLETED,\n \"Operation completed.\"));\n }\n },\n (activationResponse, context) -> Mono.error(new RuntimeException(\"Cancellation is not supported\")),\n (context) -> Mono.just(\"Final Output\"));\n\n // Listen to poll responses\n poller.subscribe(response -> {\n // Process poll response\n System.out.printf(\"Got response. Status: %s, Value: %s%n\", response.getStatus(), response.getValue());\n });\n // Do something else\n```\n\n**Asynchronously wait for polling to complete and then retrieve the final result**\n\n```java\nLocalDateTime timeToReturnFinalResponse = LocalDateTime.now().plus(Duration.ofMinutes(5));\n\n // Create poller instance\n PollerFlux poller = new PollerFlux<>(Duration.ofMillis(100),\n (context) -> Mono.empty(),\n (context) -> {\n if (LocalDateTime.now().isBefore(timeToReturnFinalResponse)) {\n System.out.println(\"Returning intermediate response.\");\n return Mono.just(new PollResponse<>(LongRunningOperationStatus.IN_PROGRESS,\n \"Operation in progress.\"));\n } else {\n System.out.println(\"Returning final response.\");\n return Mono.just(new PollResponse<>(LongRunningOperationStatus.SUCCESSFULLY_COMPLETED,\n \"Operation completed.\"));\n }\n },\n (activationResponse, context) -> Mono.just(\"FromServer:OperationIsCancelled\"),\n (context) -> Mono.just(\"FromServer:FinalOutput\"));\n\n poller.take(Duration.ofMinutes(30))\n .last()\n .flatMap(asyncPollResponse -> {\n if (asyncPollResponse.getStatus() == LongRunningOperationStatus.SUCCESSFULLY_COMPLETED) {\n // operation completed successfully, retrieving final result.\n return asyncPollResponse\n .getFinalResult();\n } else {\n return Mono.error(new RuntimeException(\"polling completed unsuccessfully with status:\"\n + asyncPollResponse.getStatus()));\n }\n }).block();\n```\n\n**Block for polling to complete and then retrieve the final result**\n\n```java\nAsyncPollResponse terminalResponse = pollerFlux.blockLast();\n System.out.printf(\"Polling complete. Final Status: %s\", terminalResponse.getStatus());\n if (terminalResponse.getStatus() == LongRunningOperationStatus.SUCCESSFULLY_COMPLETED) {\n String finalResult = terminalResponse.getFinalResult().block();\n System.out.printf(\"Polling complete. Final Status: %s\", finalResult);\n }\n```\n\n**Asynchronously poll until poller receives matching status**\n\n```java\nfinal Predicate> isComplete = response -> {\n return response.getStatus() != LongRunningOperationStatus.IN_PROGRESS\n && response.getStatus() != LongRunningOperationStatus.NOT_STARTED;\n };\n\n pollerFlux\n .takeUntil(isComplete)\n .subscribe(completed -> {\n System.out.println(\"Completed poll response, status: \" + completed.getStatus());\n });\n```\n\n**Asynchronously cancel the long running operation**\n\n```java\nLocalDateTime timeToReturnFinalResponse = LocalDateTime.now().plus(Duration.ofMinutes(5));\n\n // Create poller instance\n PollerFlux poller = new PollerFlux<>(Duration.ofMillis(100),\n (context) -> Mono.empty(),\n (context) -> {\n if (LocalDateTime.now().isBefore(timeToReturnFinalResponse)) {\n System.out.println(\"Returning intermediate response.\");\n return Mono.just(new PollResponse<>(LongRunningOperationStatus.IN_PROGRESS,\n \"Operation in progress.\"));\n } else {\n System.out.println(\"Returning final response.\");\n return Mono.just(new PollResponse<>(LongRunningOperationStatus.SUCCESSFULLY_COMPLETED,\n \"Operation completed.\"));\n }\n },\n (activationResponse, context) -> Mono.just(\"FromServer:OperationIsCancelled\"),\n (context) -> Mono.just(\"FromServer:FinalOutput\"));\n\n // Asynchronously wait 30 minutes to complete the polling, if not completed\n // within in the time then cancel the server operation.\n poller.take(Duration.ofMinutes(30))\n .last()\n .flatMap(asyncPollResponse -> {\n if (!asyncPollResponse.getStatus().isComplete()) {\n return asyncPollResponse\n .cancelOperation()\n .then(Mono.error(new RuntimeException(\"Operation is cancelled!\")));\n } else {\n return Mono.just(asyncPollResponse);\n }\n }).block();\n```\n\n**Instantiating and subscribing to PollerFlux from a known polling strategy**\n\n```java\n// Create poller instance\n PollerFlux poller = PollerFlux.create(\n Duration.ofMillis(100),\n // pass in your custom activation operation\n () -> Mono.just(new SimpleResponse(new HttpRequest(\n HttpMethod.POST,\n \"http://httpbin.org\"),\n 202,\n new HttpHeaders().set(\"Operation-Location\", \"http://httpbin.org\"),\n null)),\n new OperationResourcePollingStrategy<>(new HttpPipelineBuilder().build()),\n TypeReference.createInstance(BinaryData.class),\n TypeReference.createInstance(String.class));\n\n // Listen to poll responses\n poller.subscribe(response -> {\n // Process poll response\n System.out.printf(\"Got response. Status: %s, Value: %s%n\", response.getStatus(), response.getValue());\n });\n // Do something else\n```\n\n**Instantiating and subscribing to PollerFlux from a custom polling strategy**\n\n```java\n// Create custom polling strategy based on OperationResourcePollingStrategy\n PollingStrategy strategy = new OperationResourcePollingStrategy(\n new HttpPipelineBuilder().build()) {\n // override any interface method to customize the polling behavior\n @Override\n public Mono> poll(PollingContext context,\n TypeReference pollResponseType) {\n return Mono.just(new PollResponse<>(\n LongRunningOperationStatus.SUCCESSFULLY_COMPLETED,\n BinaryData.fromString(\"\")));\n }\n };\n\n // Create poller instance\n PollerFlux poller = PollerFlux.create(\n Duration.ofMillis(100),\n // pass in your custom activation operation\n () -> Mono.just(new SimpleResponse(new HttpRequest(\n HttpMethod.POST,\n \"http://httpbin.org\"),\n 202,\n new HttpHeaders().set(\"Operation-Location\", \"http://httpbin.org\"),\n null)),\n strategy,\n TypeReference.createInstance(BinaryData.class),\n TypeReference.createInstance(String.class));\n\n // Listen to poll responses\n poller.subscribe(response -> {\n // Process poll response\n System.out.printf(\"Got response. Status: %s, Value: %s%n\", response.getStatus(), response.getValue());\n });\n // Do something else\n```" metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.PollingContext.yml b/docs-ref-autogen/com.azure.core.util.polling.PollingContext.yml index 70bcc20e71ec..5fd1c811f697 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.PollingContext.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.PollingContext.yml @@ -26,9 +26,11 @@ methods: fullName: "com.azure.core.util.polling.PollingContext.getActivationResponse()" name: "getActivationResponse()" nameWithType: "PollingContext.getActivationResponse()" + summary: "Gets the activation holding the result of an activation operation call." syntax: "public PollResponse getActivationResponse()" + desc: "Gets the activation holding the result of an activation operation call." returns: - description: "the activation holding result of activation operation call." + description: "The activation holding the result of an activation operation call." type: "<>" - uid: "com.azure.core.util.polling.PollingContext.getData(java.lang.String)" fullName: "com.azure.core.util.polling.PollingContext.getData(String name)" @@ -48,9 +50,11 @@ methods: fullName: "com.azure.core.util.polling.PollingContext.getLatestResponse()" name: "getLatestResponse()" nameWithType: "PollingContext.getLatestResponse()" + summary: "Gets the latest in the polling operation." syntax: "public PollResponse getLatestResponse()" + desc: "Gets the latest in the polling operation." returns: - description: "the latest from pollOperation." + description: "The latest in the polling operation." type: "<>" - uid: "com.azure.core.util.polling.PollingContext.setData(java.lang.String,java.lang.String)" fullName: "com.azure.core.util.polling.PollingContext.setData(String name, String value)" @@ -76,4 +80,4 @@ typeParameters: desc: "A key/value store that is propagated between various poll related operations associated with and poller. The context also expose activation and latest ." metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.PollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.PollingStrategy.yml index ad0925b35905..503377fcf4ea 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.PollingStrategy.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.PollingStrategy.yml @@ -110,4 +110,4 @@ typeParameters: desc: "Represents a known strategy for polling a long-running operation in Azure.\n\nThe methods in the polling strategy will be invoked from the . The order of the invocations is:\n\n1. )\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#canPoll(Response)\"> \\- exits if returns false\n2. ,com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#onInitialResponse(Response, PollingContext, TypeReference)\"> \\- immediately after )\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#canPoll(Response)\"> returns true\n3. ,com.azure.core.util.serializer.TypeReference)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#poll(PollingContext, TypeReference)\"> \\- invoked after each polling interval, if the last polling response indicates an \"In Progress\" status. Returns a with the latest status\n4. ,com.azure.core.util.serializer.TypeReference)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getResult(PollingContext, TypeReference)\"> \\- invoked when the last polling response indicates a \"Successfully Completed\" status. Returns the final result of the given type\n\nIf the user decides to cancel the or , the ,com.azure.core.util.polling.PollResponse)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#cancel(PollingContext, PollResponse)\"> method will be invoked. If the strategy doesn't support cancellation, an error will be returned.\n\nUsers are not expected to provide their own implementation of this interface. Built-in polling strategies in this library and other client libraries are often sufficient for handling polling in most long-running operations in Azure. When there are special scenarios, built-in polling strategies can be inherited and select methods can be overridden to accomplish the polling requirements, without writing an entire polling strategy from scratch." metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.StatusCheckPollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.StatusCheckPollingStrategy.yml index 2da0ef10b8db..35bebcc8fc0c 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.StatusCheckPollingStrategy.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.StatusCheckPollingStrategy.yml @@ -108,4 +108,4 @@ implements: - "<,>" metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.SyncChainedPollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.SyncChainedPollingStrategy.yml new file mode 100644 index 000000000000..c03eb02064eb --- /dev/null +++ b/docs-ref-autogen/com.azure.core.util.polling.SyncChainedPollingStrategy.yml @@ -0,0 +1,118 @@ +### YamlMime:JavaType +uid: "com.azure.core.util.polling.SyncChainedPollingStrategy" +fullName: "com.azure.core.util.polling.SyncChainedPollingStrategy" +name: "SyncChainedPollingStrategy" +nameWithType: "SyncChainedPollingStrategy" +summary: "A synchronous polling strategy that chains multiple synchronous polling strategies, finds the first strategy that can poll the current long-running operation, and polls with that strategy." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **SyncChainedPollingStrategy**
implements <,>" +constructors: +- uid: "com.azure.core.util.polling.SyncChainedPollingStrategy.SyncChainedPollingStrategy(java.util.List>)" + fullName: "com.azure.core.util.polling.SyncChainedPollingStrategy.SyncChainedPollingStrategy(List> strategies)" + name: "SyncChainedPollingStrategy(List> strategies)" + nameWithType: "SyncChainedPollingStrategy.SyncChainedPollingStrategy(List> strategies)" + summary: "Creates a synchronous chained polling strategy with a list of polling strategies." + parameters: + - description: "the list of synchronous polling strategies" + name: "strategies" + type: "List<<,>>" + syntax: "public SyncChainedPollingStrategy(List> strategies)" + desc: "Creates a synchronous chained polling strategy with a list of polling strategies." +methods: +- uid: "com.azure.core.util.polling.SyncChainedPollingStrategy.canPoll(com.azure.core.http.rest.Response)" + fullName: "com.azure.core.util.polling.SyncChainedPollingStrategy.canPoll(Response initialResponse)" + name: "canPoll(Response initialResponse)" + nameWithType: "SyncChainedPollingStrategy.canPoll(Response initialResponse)" + summary: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + parameters: + - name: "initialResponse" + type: "<?>" + syntax: "public boolean canPoll(Response initialResponse)" + desc: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncChainedPollingStrategy.cancel(com.azure.core.util.polling.PollingContext,com.azure.core.util.polling.PollResponse)" + fullName: "com.azure.core.util.polling.SyncChainedPollingStrategy.cancel(PollingContext pollingContext, PollResponse initialResponse)" + name: "cancel(PollingContext pollingContext, PollResponse initialResponse)" + nameWithType: "SyncChainedPollingStrategy.cancel(PollingContext pollingContext, PollResponse initialResponse)" + summary: "Cancels the long-running operation if service supports cancellation." + parameters: + - name: "pollingContext" + type: "<>" + - name: "initialResponse" + type: "<>" + syntax: "public T cancel(PollingContext pollingContext, PollResponse initialResponse)" + desc: "Cancels the long-running operation if service supports cancellation. If service does not support cancellation then the implementer should throw an with an error message indicating absence of cancellation.\n\nImplementing this method is optional - by default, cancellation will not be supported unless overridden." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncChainedPollingStrategy.getResult(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncChainedPollingStrategy.getResult(PollingContext context, TypeReference resultType)" + name: "getResult(PollingContext context, TypeReference resultType)" + nameWithType: "SyncChainedPollingStrategy.getResult(PollingContext context, TypeReference resultType)" + summary: "Parses the response from the final GET call into the result type of the long-running operation." + parameters: + - name: "context" + type: "<>" + - name: "resultType" + type: "<>" + syntax: "public U getResult(PollingContext context, TypeReference resultType)" + desc: "Parses the response from the final GET call into the result type of the long-running operation." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncChainedPollingStrategy.onInitialResponse(com.azure.core.http.rest.Response,com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncChainedPollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + name: "onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + nameWithType: "SyncChainedPollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + summary: "Parses the initial response into a , and stores information useful for polling in the ." + parameters: + - name: "response" + type: "<?>" + - name: "pollingContext" + type: "<>" + - name: "pollResponseType" + type: "<>" + syntax: "public PollResponse onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + desc: "Parses the initial response into a , and stores information useful for polling in the . If the result is anything other than , the long-running operation will be terminated and none of the other methods will be invoked." + returns: + type: "<>" +- uid: "com.azure.core.util.polling.SyncChainedPollingStrategy.poll(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncChainedPollingStrategy.poll(PollingContext context, TypeReference pollResponseType)" + name: "poll(PollingContext context, TypeReference pollResponseType)" + nameWithType: "SyncChainedPollingStrategy.poll(PollingContext context, TypeReference pollResponseType)" + summary: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the ." + parameters: + - name: "context" + type: "<>" + - name: "pollResponseType" + type: "<>" + syntax: "public PollResponse poll(PollingContext context, TypeReference pollResponseType)" + desc: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the . The result must have the specified, and the entire polling response content as a ." + returns: + type: "<>" +type: "class" +typeParameters: +- description: "the type of the response type from a polling call, or BinaryData if raw response body should be kept" + name: "T" +- description: "the type of the final result object to deserialize into, or BinaryData if raw response body should be\n kept" + name: "U" +desc: "A synchronous polling strategy that chains multiple synchronous polling strategies, finds the first strategy that can poll the current long-running operation, and polls with that strategy." +implements: +- "<,>" +metadata: {} +package: "com.azure.core.util.polling" +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.SyncDefaultPollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.SyncDefaultPollingStrategy.yml new file mode 100644 index 000000000000..411c18f7db0e --- /dev/null +++ b/docs-ref-autogen/com.azure.core.util.polling.SyncDefaultPollingStrategy.yml @@ -0,0 +1,169 @@ +### YamlMime:JavaType +uid: "com.azure.core.util.polling.SyncDefaultPollingStrategy" +fullName: "com.azure.core.util.polling.SyncDefaultPollingStrategy" +name: "SyncDefaultPollingStrategy" +nameWithType: "SyncDefaultPollingStrategy" +summary: "The default synchronous polling strategy to use with Azure data plane services." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **SyncDefaultPollingStrategy**
implements <,>" +constructors: +- uid: "com.azure.core.util.polling.SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(com.azure.core.http.HttpPipeline)" + fullName: "com.azure.core.util.polling.SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(HttpPipeline httpPipeline)" + name: "SyncDefaultPollingStrategy(HttpPipeline httpPipeline)" + nameWithType: "SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(HttpPipeline httpPipeline)" + summary: "Creates a synchronous chained polling strategy with three known polling strategies, , , and , in this order, with a JSON serializer." + parameters: + - description: "an instance of to send requests with" + name: "httpPipeline" + type: "" + syntax: "public SyncDefaultPollingStrategy(HttpPipeline httpPipeline)" + desc: "Creates a synchronous chained polling strategy with three known polling strategies, , , and , in this order, with a JSON serializer." +- uid: "com.azure.core.util.polling.SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(com.azure.core.http.HttpPipeline,com.azure.core.util.serializer.JsonSerializer)" + fullName: "com.azure.core.util.polling.SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(HttpPipeline httpPipeline, JsonSerializer serializer)" + name: "SyncDefaultPollingStrategy(HttpPipeline httpPipeline, JsonSerializer serializer)" + nameWithType: "SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(HttpPipeline httpPipeline, JsonSerializer serializer)" + summary: "Creates a synchronous chained polling strategy with three known polling strategies, , , and , in this order, with a JSON serializer." + parameters: + - description: "an instance of to send requests with" + name: "httpPipeline" + type: "" + - description: "a custom serializer for serializing and deserializing polling responses" + name: "serializer" + type: "" + syntax: "public SyncDefaultPollingStrategy(HttpPipeline httpPipeline, JsonSerializer serializer)" + desc: "Creates a synchronous chained polling strategy with three known polling strategies, , , and , in this order, with a JSON serializer." +- uid: "com.azure.core.util.polling.SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(com.azure.core.http.HttpPipeline,com.azure.core.util.serializer.JsonSerializer,com.azure.core.util.Context)" + fullName: "com.azure.core.util.polling.SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(HttpPipeline httpPipeline, JsonSerializer serializer, Context context)" + name: "SyncDefaultPollingStrategy(HttpPipeline httpPipeline, JsonSerializer serializer, Context context)" + nameWithType: "SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(HttpPipeline httpPipeline, JsonSerializer serializer, Context context)" + summary: "Creates a synchronous chained polling strategy with three known polling strategies, , , and , in this order, with a JSON serializer." + parameters: + - description: "an instance of to send requests with" + name: "httpPipeline" + type: "" + - description: "a custom serializer for serializing and deserializing polling responses" + name: "serializer" + type: "" + - description: "an instance of " + name: "context" + type: "" + syntax: "public SyncDefaultPollingStrategy(HttpPipeline httpPipeline, JsonSerializer serializer, Context context)" + desc: "Creates a synchronous chained polling strategy with three known polling strategies, , , and , in this order, with a JSON serializer." +- uid: "com.azure.core.util.polling.SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(com.azure.core.http.HttpPipeline,java.lang.String,com.azure.core.util.serializer.JsonSerializer,com.azure.core.util.Context)" + fullName: "com.azure.core.util.polling.SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(HttpPipeline httpPipeline, String endpoint, JsonSerializer serializer, Context context)" + name: "SyncDefaultPollingStrategy(HttpPipeline httpPipeline, String endpoint, JsonSerializer serializer, Context context)" + nameWithType: "SyncDefaultPollingStrategy.SyncDefaultPollingStrategy(HttpPipeline httpPipeline, String endpoint, JsonSerializer serializer, Context context)" + summary: "Creates a synchronous chained polling strategy with three known polling strategies, , , and , in this order, with a JSON serializer." + parameters: + - description: "an instance of to send requests with." + name: "httpPipeline" + type: "" + - description: "an endpoint for creating an absolute path when the path itself is relative." + name: "endpoint" + type: "String" + - description: "a custom serializer for serializing and deserializing polling responses." + name: "serializer" + type: "" + - description: "an instance of ." + name: "context" + type: "" + syntax: "public SyncDefaultPollingStrategy(HttpPipeline httpPipeline, String endpoint, JsonSerializer serializer, Context context)" + desc: "Creates a synchronous chained polling strategy with three known polling strategies, , , and , in this order, with a JSON serializer." +methods: +- uid: "com.azure.core.util.polling.SyncDefaultPollingStrategy.canPoll(com.azure.core.http.rest.Response)" + fullName: "com.azure.core.util.polling.SyncDefaultPollingStrategy.canPoll(Response initialResponse)" + name: "canPoll(Response initialResponse)" + nameWithType: "SyncDefaultPollingStrategy.canPoll(Response initialResponse)" + summary: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + parameters: + - name: "initialResponse" + type: "<?>" + syntax: "public boolean canPoll(Response initialResponse)" + desc: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncDefaultPollingStrategy.cancel(com.azure.core.util.polling.PollingContext,com.azure.core.util.polling.PollResponse)" + fullName: "com.azure.core.util.polling.SyncDefaultPollingStrategy.cancel(PollingContext pollingContext, PollResponse initialResponse)" + name: "cancel(PollingContext pollingContext, PollResponse initialResponse)" + nameWithType: "SyncDefaultPollingStrategy.cancel(PollingContext pollingContext, PollResponse initialResponse)" + summary: "Cancels the long-running operation if service supports cancellation." + parameters: + - name: "pollingContext" + type: "<>" + - name: "initialResponse" + type: "<>" + syntax: "public T cancel(PollingContext pollingContext, PollResponse initialResponse)" + desc: "Cancels the long-running operation if service supports cancellation. If service does not support cancellation then the implementer should throw an with an error message indicating absence of cancellation.\n\nImplementing this method is optional - by default, cancellation will not be supported unless overridden." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncDefaultPollingStrategy.getResult(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncDefaultPollingStrategy.getResult(PollingContext pollingContext, TypeReference resultType)" + name: "getResult(PollingContext pollingContext, TypeReference resultType)" + nameWithType: "SyncDefaultPollingStrategy.getResult(PollingContext pollingContext, TypeReference resultType)" + summary: "Parses the response from the final GET call into the result type of the long-running operation." + parameters: + - name: "pollingContext" + type: "<>" + - name: "resultType" + type: "<>" + syntax: "public U getResult(PollingContext pollingContext, TypeReference resultType)" + desc: "Parses the response from the final GET call into the result type of the long-running operation." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncDefaultPollingStrategy.onInitialResponse(com.azure.core.http.rest.Response,com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncDefaultPollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + name: "onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + nameWithType: "SyncDefaultPollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + summary: "Parses the initial response into a , and stores information useful for polling in the ." + parameters: + - name: "response" + type: "<?>" + - name: "pollingContext" + type: "<>" + - name: "pollResponseType" + type: "<>" + syntax: "public PollResponse onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + desc: "Parses the initial response into a , and stores information useful for polling in the . If the result is anything other than , the long-running operation will be terminated and none of the other methods will be invoked." + returns: + type: "<>" +- uid: "com.azure.core.util.polling.SyncDefaultPollingStrategy.poll(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncDefaultPollingStrategy.poll(PollingContext pollingContext, TypeReference pollResponseType)" + name: "poll(PollingContext pollingContext, TypeReference pollResponseType)" + nameWithType: "SyncDefaultPollingStrategy.poll(PollingContext pollingContext, TypeReference pollResponseType)" + summary: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the ." + parameters: + - name: "pollingContext" + type: "<>" + - name: "pollResponseType" + type: "<>" + syntax: "public PollResponse poll(PollingContext pollingContext, TypeReference pollResponseType)" + desc: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the . The result must have the specified, and the entire polling response content as a ." + returns: + type: "<>" +type: "class" +typeParameters: +- description: "the type of the response type from a polling call, or BinaryData if raw response body should be kept" + name: "T" +- description: "the type of the final result object to deserialize into, or BinaryData if raw response body should be\n kept" + name: "U" +desc: "The default synchronous polling strategy to use with Azure data plane services. The default polling strategy will attempt three known strategies, , , and , in this order. The first strategy that can poll on the initial response will be used. The created chained polling strategy is capable of handling most of the polling scenarios in Azure." +implements: +- "<,>" +metadata: {} +package: "com.azure.core.util.polling" +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.SyncLocationPollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.SyncLocationPollingStrategy.yml new file mode 100644 index 000000000000..8b6120407425 --- /dev/null +++ b/docs-ref-autogen/com.azure.core.util.polling.SyncLocationPollingStrategy.yml @@ -0,0 +1,155 @@ +### YamlMime:JavaType +uid: "com.azure.core.util.polling.SyncLocationPollingStrategy" +fullName: "com.azure.core.util.polling.SyncLocationPollingStrategy" +name: "SyncLocationPollingStrategy" +nameWithType: "SyncLocationPollingStrategy" +summary: "Implements a synchronous Location polling strategy." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **SyncLocationPollingStrategy**
implements <,>" +constructors: +- uid: "com.azure.core.util.polling.SyncLocationPollingStrategy.SyncLocationPollingStrategy(com.azure.core.http.HttpPipeline)" + fullName: "com.azure.core.util.polling.SyncLocationPollingStrategy.SyncLocationPollingStrategy(HttpPipeline httpPipeline)" + name: "SyncLocationPollingStrategy(HttpPipeline httpPipeline)" + nameWithType: "SyncLocationPollingStrategy.SyncLocationPollingStrategy(HttpPipeline httpPipeline)" + summary: "Creates an instance of the location polling strategy using a JSON serializer." + parameters: + - description: "an instance of to send requests with" + name: "httpPipeline" + type: "" + syntax: "public SyncLocationPollingStrategy(HttpPipeline httpPipeline)" + desc: "Creates an instance of the location polling strategy using a JSON serializer." +- uid: "com.azure.core.util.polling.SyncLocationPollingStrategy.SyncLocationPollingStrategy(com.azure.core.http.HttpPipeline,com.azure.core.util.serializer.ObjectSerializer)" + fullName: "com.azure.core.util.polling.SyncLocationPollingStrategy.SyncLocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer)" + name: "SyncLocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer)" + nameWithType: "SyncLocationPollingStrategy.SyncLocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer)" + summary: "Creates an instance of the location polling strategy." + parameters: + - description: "an instance of to send requests with" + name: "httpPipeline" + type: "" + - description: "a custom serializer for serializing and deserializing polling responses" + name: "serializer" + type: "" + syntax: "public SyncLocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer)" + desc: "Creates an instance of the location polling strategy." +- uid: "com.azure.core.util.polling.SyncLocationPollingStrategy.SyncLocationPollingStrategy(com.azure.core.http.HttpPipeline,com.azure.core.util.serializer.ObjectSerializer,com.azure.core.util.Context)" + fullName: "com.azure.core.util.polling.SyncLocationPollingStrategy.SyncLocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, Context context)" + name: "SyncLocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, Context context)" + nameWithType: "SyncLocationPollingStrategy.SyncLocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, Context context)" + summary: "Creates an instance of the location polling strategy." + parameters: + - description: "an instance of to send requests with" + name: "httpPipeline" + type: "" + - description: "a custom serializer for serializing and deserializing polling responses" + name: "serializer" + type: "" + - description: "an instance of " + name: "context" + type: "" + syntax: "public SyncLocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, Context context)" + desc: "Creates an instance of the location polling strategy." +- uid: "com.azure.core.util.polling.SyncLocationPollingStrategy.SyncLocationPollingStrategy(com.azure.core.http.HttpPipeline,java.lang.String,com.azure.core.util.serializer.ObjectSerializer,com.azure.core.util.Context)" + fullName: "com.azure.core.util.polling.SyncLocationPollingStrategy.SyncLocationPollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, Context context)" + name: "SyncLocationPollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, Context context)" + nameWithType: "SyncLocationPollingStrategy.SyncLocationPollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, Context context)" + summary: "Creates an instance of the location polling strategy." + parameters: + - description: "an instance of to send requests with" + name: "httpPipeline" + type: "" + - description: "an endpoint for creating an absolute path when the path itself is relative." + name: "endpoint" + type: "String" + - description: "a custom serializer for serializing and deserializing polling responses" + name: "serializer" + type: "" + - description: "an instance of " + name: "context" + type: "" + syntax: "public SyncLocationPollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, Context context)" + desc: "Creates an instance of the location polling strategy." +methods: +- uid: "com.azure.core.util.polling.SyncLocationPollingStrategy.canPoll(com.azure.core.http.rest.Response)" + fullName: "com.azure.core.util.polling.SyncLocationPollingStrategy.canPoll(Response initialResponse)" + name: "canPoll(Response initialResponse)" + nameWithType: "SyncLocationPollingStrategy.canPoll(Response initialResponse)" + summary: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + parameters: + - name: "initialResponse" + type: "<?>" + syntax: "public boolean canPoll(Response initialResponse)" + desc: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncLocationPollingStrategy.getResult(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncLocationPollingStrategy.getResult(PollingContext pollingContext, TypeReference resultType)" + name: "getResult(PollingContext pollingContext, TypeReference resultType)" + nameWithType: "SyncLocationPollingStrategy.getResult(PollingContext pollingContext, TypeReference resultType)" + summary: "Parses the response from the final GET call into the result type of the long-running operation." + parameters: + - name: "pollingContext" + type: "<>" + - name: "resultType" + type: "<>" + syntax: "public U getResult(PollingContext pollingContext, TypeReference resultType)" + desc: "Parses the response from the final GET call into the result type of the long-running operation." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncLocationPollingStrategy.onInitialResponse(com.azure.core.http.rest.Response,com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncLocationPollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + name: "onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + nameWithType: "SyncLocationPollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + summary: "Parses the initial response into a , and stores information useful for polling in the ." + parameters: + - name: "response" + type: "<?>" + - name: "pollingContext" + type: "<>" + - name: "pollResponseType" + type: "<>" + syntax: "public PollResponse onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + desc: "Parses the initial response into a , and stores information useful for polling in the . If the result is anything other than , the long-running operation will be terminated and none of the other methods will be invoked." + returns: + type: "<>" +- uid: "com.azure.core.util.polling.SyncLocationPollingStrategy.poll(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncLocationPollingStrategy.poll(PollingContext pollingContext, TypeReference pollResponseType)" + name: "poll(PollingContext pollingContext, TypeReference pollResponseType)" + nameWithType: "SyncLocationPollingStrategy.poll(PollingContext pollingContext, TypeReference pollResponseType)" + summary: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the ." + parameters: + - name: "pollingContext" + type: "<>" + - name: "pollResponseType" + type: "<>" + syntax: "public PollResponse poll(PollingContext pollingContext, TypeReference pollResponseType)" + desc: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the . The result must have the specified, and the entire polling response content as a ." + returns: + type: "<>" +type: "class" +typeParameters: +- description: "the type of the response type from a polling call, or BinaryData if raw response body should be kept" + name: "T" +- description: "the type of the final result object to deserialize into, or BinaryData if raw response body should be\n kept" + name: "U" +desc: "Implements a synchronous Location polling strategy." +implements: +- "<,>" +metadata: {} +package: "com.azure.core.util.polling" +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.SyncOperationResourcePollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.SyncOperationResourcePollingStrategy.yml new file mode 100644 index 000000000000..40f4ef1a5d25 --- /dev/null +++ b/docs-ref-autogen/com.azure.core.util.polling.SyncOperationResourcePollingStrategy.yml @@ -0,0 +1,164 @@ +### YamlMime:JavaType +uid: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy" +fullName: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy" +name: "SyncOperationResourcePollingStrategy" +nameWithType: "SyncOperationResourcePollingStrategy" +summary: "Implements a synchronous operation resource polling strategy, typically from Operation-Location." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **SyncOperationResourcePollingStrategy**
implements <,>" +constructors: +- uid: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(com.azure.core.http.HttpPipeline)" + fullName: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline)" + name: "SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline)" + nameWithType: "SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline)" + summary: "Creates an instance of the operation resource polling strategy using a JSON serializer and \"Operation-Location\" as the header for polling." + parameters: + - description: "an instance of to send requests with" + name: "httpPipeline" + type: "" + syntax: "public SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline)" + desc: "Creates an instance of the operation resource polling strategy using a JSON serializer and \"Operation-Location\" as the header for polling." +- uid: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(com.azure.core.http.HttpPipeline,com.azure.core.util.serializer.ObjectSerializer,java.lang.String)" + fullName: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, String operationLocationHeaderName)" + name: "SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, String operationLocationHeaderName)" + nameWithType: "SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, String operationLocationHeaderName)" + summary: "Creates an instance of the operation resource polling strategy." + parameters: + - description: "an instance of to send requests with" + name: "httpPipeline" + type: "" + - description: "a custom serializer for serializing and deserializing polling responses" + name: "serializer" + type: "" + - description: "a custom header for polling the long-running operation" + name: "operationLocationHeaderName" + type: "String" + syntax: "public SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, String operationLocationHeaderName)" + desc: "Creates an instance of the operation resource polling strategy." +- uid: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(com.azure.core.http.HttpPipeline,com.azure.core.util.serializer.ObjectSerializer,java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, String operationLocationHeaderName, Context context)" + name: "SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, String operationLocationHeaderName, Context context)" + nameWithType: "SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, String operationLocationHeaderName, Context context)" + summary: "Creates an instance of the operation resource polling strategy." + parameters: + - description: "an instance of to send requests with" + name: "httpPipeline" + type: "" + - description: "a custom serializer for serializing and deserializing polling responses" + name: "serializer" + type: "" + - description: "a custom header for polling the long-running operation" + name: "operationLocationHeaderName" + type: "String" + - description: "an instance of " + name: "context" + type: "" + syntax: "public SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, String operationLocationHeaderName, Context context)" + desc: "Creates an instance of the operation resource polling strategy." +- uid: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(com.azure.core.http.HttpPipeline,java.lang.String,com.azure.core.util.serializer.ObjectSerializer,java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, String operationLocationHeaderName, Context context)" + name: "SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, String operationLocationHeaderName, Context context)" + nameWithType: "SyncOperationResourcePollingStrategy.SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, String operationLocationHeaderName, Context context)" + summary: "Creates an instance of the operation resource polling strategy." + parameters: + - description: "an instance of to send requests with." + name: "httpPipeline" + type: "" + - description: "an endpoint for creating an absolute path when the path itself is relative." + name: "endpoint" + type: "String" + - description: "a custom serializer for serializing and deserializing polling responses." + name: "serializer" + type: "" + - description: "a custom header for polling the long-running operation." + name: "operationLocationHeaderName" + type: "String" + - description: "an instance of ." + name: "context" + type: "" + syntax: "public SyncOperationResourcePollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, String operationLocationHeaderName, Context context)" + desc: "Creates an instance of the operation resource polling strategy." +methods: +- uid: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.canPoll(com.azure.core.http.rest.Response)" + fullName: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.canPoll(Response initialResponse)" + name: "canPoll(Response initialResponse)" + nameWithType: "SyncOperationResourcePollingStrategy.canPoll(Response initialResponse)" + summary: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + parameters: + - name: "initialResponse" + type: "<?>" + syntax: "public boolean canPoll(Response initialResponse)" + desc: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.getResult(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.getResult(PollingContext pollingContext, TypeReference resultType)" + name: "getResult(PollingContext pollingContext, TypeReference resultType)" + nameWithType: "SyncOperationResourcePollingStrategy.getResult(PollingContext pollingContext, TypeReference resultType)" + summary: "Parses the response from the final GET call into the result type of the long-running operation." + parameters: + - name: "pollingContext" + type: "<>" + - name: "resultType" + type: "<>" + syntax: "public U getResult(PollingContext pollingContext, TypeReference resultType)" + desc: "Parses the response from the final GET call into the result type of the long-running operation." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.onInitialResponse(com.azure.core.http.rest.Response,com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + name: "onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + nameWithType: "SyncOperationResourcePollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + summary: "Parses the initial response into a , and stores information useful for polling in the ." + parameters: + - name: "response" + type: "<?>" + - name: "pollingContext" + type: "<>" + - name: "pollResponseType" + type: "<>" + syntax: "public PollResponse onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + desc: "Parses the initial response into a , and stores information useful for polling in the . If the result is anything other than , the long-running operation will be terminated and none of the other methods will be invoked." + returns: + type: "<>" +- uid: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.poll(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncOperationResourcePollingStrategy.poll(PollingContext pollingContext, TypeReference pollResponseType)" + name: "poll(PollingContext pollingContext, TypeReference pollResponseType)" + nameWithType: "SyncOperationResourcePollingStrategy.poll(PollingContext pollingContext, TypeReference pollResponseType)" + summary: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the ." + parameters: + - name: "pollingContext" + type: "<>" + - name: "pollResponseType" + type: "<>" + syntax: "public PollResponse poll(PollingContext pollingContext, TypeReference pollResponseType)" + desc: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the . The result must have the specified, and the entire polling response content as a ." + returns: + type: "<>" +type: "class" +typeParameters: +- description: "the type of the response type from a polling call, or BinaryData if raw response body should be kept" + name: "T" +- description: "the type of the final result object to deserialize into, or BinaryData if raw response body should be\n kept" + name: "U" +desc: "Implements a synchronous operation resource polling strategy, typically from Operation-Location." +implements: +- "<,>" +metadata: {} +package: "com.azure.core.util.polling" +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.SyncPoller.yml b/docs-ref-autogen/com.azure.core.util.polling.SyncPoller.yml index 79f4c7eefa6c..0c49ebc5f2cc 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.SyncPoller.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.SyncPoller.yml @@ -17,16 +17,16 @@ methods: - description: "the polling interval." name: "pollInterval" type: "Duration" - - description: "the operation to synchronously activate (start) the long running operation,\n this operation will be called with a new ." + - description: "the operation to synchronously activate (start) the long-running operation, this\n operation will be called with a new ." name: "syncActivationOperation" type: "Function<<>,<>>" - - description: "the operation to poll the current state of long running operation, this parameter\n is required and the operation will be called with current ." + - description: "the operation to poll the current state of long-running operation, this parameter is\n required and the operation will be called with current ." name: "pollOperation" type: "Function<<>,<>>" - - description: "a that represents the operation to cancel the long running operation\n if service supports cancellation, this parameter is required and if service does not support cancellation\n then the implementer should return Mono.error with an error message indicating absence of cancellation\n support, the operation will be called with current ." + - description: "a that represents the operation to cancel the long-running operation if\n service supports cancellation, this parameter is required and if service does not support cancellation then the\n implementer should throw an exception with an error message indicating absence of cancellation support, the\n operation will be called with current ." name: "cancelOperation" type: "BiFunction<<>,<>,>" - - description: "a that represents the operation to retrieve final result of\n the long running operation if service support it, this parameter is required and operation will be called\n current , if service does not have an api to fetch final result and if final result\n is same as final poll response value then implementer can choose to simply return value from provided\n final poll response." + - description: "a that represents the operation to retrieve final result of the\n long-running operation if service support it, this parameter is required and operation will be called current\n , if service does not have an api to fetch final result and if final result is same as\n final poll response value then implementer can choose to simply return value from provided final poll response." name: "fetchResultOperation" type: "Function<<>,>" syntax: "public static SyncPoller createPoller(Duration pollInterval, Function,PollResponse> syncActivationOperation, Function,PollResponse> pollOperation, BiFunction,PollResponse,T> cancelOperation, Function,U> fetchResultOperation)" @@ -34,6 +34,34 @@ methods: returns: description: "new instance." type: "<,>" +- uid: "com.azure.core.util.polling.SyncPoller.createPoller(java.time.Duration,java.util.function.Supplier>,com.azure.core.util.polling.SyncPollingStrategy,com.azure.core.util.serializer.TypeReference,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncPoller.createPoller(Duration pollInterval, Supplier> initialOperation, SyncPollingStrategy strategy, TypeReference pollResponseType, TypeReference resultType)" + name: "createPoller(Duration pollInterval, Supplier> initialOperation, SyncPollingStrategy strategy, TypeReference pollResponseType, TypeReference resultType)" + nameWithType: "SyncPoller.createPoller(Duration pollInterval, Supplier> initialOperation, SyncPollingStrategy strategy, TypeReference pollResponseType, TypeReference resultType)" + summary: "Creates PollerFlux." + modifiers: + - "static" + parameters: + - description: "the polling interval" + name: "pollInterval" + type: "Duration" + - description: "the activation operation to activate (start) the long-running operation. This operation\n will be invoked at most once across all subscriptions. This parameter is required. If there is no specific\n activation work to be done then invocation should return null, this operation will be called with a new\n ." + name: "initialOperation" + type: "Supplier<<?>>" + - description: "a known syncrhonous strategy for polling a long-running operation in Azure" + name: "strategy" + type: "<,>" + - description: "the of the response type from a polling call, or BinaryData if raw\n response body should be kept. This should match the generic parameter ." + name: "pollResponseType" + type: "<>" + - description: "the of the final result object to deserialize into, or BinaryData if raw\n response body should be kept. This should match the generic parameter ." + name: "resultType" + type: "<>" + syntax: "public static SyncPoller createPoller(Duration pollInterval, Supplier> initialOperation, SyncPollingStrategy strategy, TypeReference pollResponseType, TypeReference resultType)" + desc: "Creates PollerFlux.\n\nThis create method uses a to poll the status of a long-running operation after the activation operation is invoked. See for more details of known polling strategies and how to create a custom strategy." + returns: + description: "new instance." + type: "<,>" - uid: "com.azure.core.util.polling.SyncPoller.cancelOperation()" fullName: "com.azure.core.util.polling.SyncPoller.cancelOperation()" name: "cancelOperation()" @@ -47,11 +75,11 @@ methods: fullName: "com.azure.core.util.polling.SyncPoller.getFinalResult()" name: "getFinalResult()" nameWithType: "SyncPoller.getFinalResult()" - summary: "Retrieve the final result of the long running operation." + summary: "Retrieve the final result of the long-running operation." modifiers: - "abstract" syntax: "public abstract U getFinalResult()" - desc: "Retrieve the final result of the long running operation." + desc: "Retrieve the final result of the long-running operation." returns: description: "the final result of the long-running operation if there is one." type: "" @@ -155,4 +183,4 @@ typeParameters: desc: "A type that offers API that simplifies the task of executing long-running operations against an Azure service.\n\nIt provides the following functionality:\n\n * Querying the current state of the long-running operation.\n * Requesting cancellation of long-running operation, if supported by the service.\n * Fetching final result of long-running operation, if supported by the service.\n * Wait for long-running operation to complete, with optional timeout.\n * Wait for long-running operation to reach a specific state." metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.SyncPollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.SyncPollingStrategy.yml new file mode 100644 index 000000000000..b19bb8d338ad --- /dev/null +++ b/docs-ref-autogen/com.azure.core.util.polling.SyncPollingStrategy.yml @@ -0,0 +1,113 @@ +### YamlMime:JavaType +uid: "com.azure.core.util.polling.SyncPollingStrategy" +fullName: "com.azure.core.util.polling.SyncPollingStrategy" +name: "SyncPollingStrategy" +nameWithType: "SyncPollingStrategy" +summary: "Represents a known strategy for polling a long-running operation in Azure." +syntax: "public interface **SyncPollingStrategy**" +methods: +- uid: "com.azure.core.util.polling.SyncPollingStrategy.canPoll(com.azure.core.http.rest.Response)" + fullName: "com.azure.core.util.polling.SyncPollingStrategy.canPoll(Response initialResponse)" + name: "canPoll(Response initialResponse)" + nameWithType: "SyncPollingStrategy.canPoll(Response initialResponse)" + summary: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + modifiers: + - "abstract" + parameters: + - description: "the response from the initial method call to activate the long-running operation" + name: "initialResponse" + type: "<?>" + syntax: "public abstract boolean canPoll(Response initialResponse)" + desc: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + returns: + description: "true if this polling strategy can handle the initial response, false if not" + type: "" +- uid: "com.azure.core.util.polling.SyncPollingStrategy.cancel(com.azure.core.util.polling.PollingContext,com.azure.core.util.polling.PollResponse)" + fullName: "com.azure.core.util.polling.SyncPollingStrategy.cancel(PollingContext pollingContext, PollResponse initialResponse)" + name: "cancel(PollingContext pollingContext, PollResponse initialResponse)" + nameWithType: "SyncPollingStrategy.cancel(PollingContext pollingContext, PollResponse initialResponse)" + summary: "Cancels the long-running operation if service supports cancellation." + modifiers: + - "default" + parameters: + - description: "the for the current polling operation, or null if the polling has\n started in a " + name: "pollingContext" + type: "<>" + - description: "the response from the initial operation" + name: "initialResponse" + type: "<>" + syntax: "public default T cancel(PollingContext pollingContext, PollResponse initialResponse)" + desc: "Cancels the long-running operation if service supports cancellation. If service does not support cancellation then the implementer should throw an with an error message indicating absence of cancellation.\n\nImplementing this method is optional - by default, cancellation will not be supported unless overridden." + returns: + description: "the cancellation response content" + type: "" +- uid: "com.azure.core.util.polling.SyncPollingStrategy.getResult(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncPollingStrategy.getResult(PollingContext pollingContext, TypeReference resultType)" + name: "getResult(PollingContext pollingContext, TypeReference resultType)" + nameWithType: "SyncPollingStrategy.getResult(PollingContext pollingContext, TypeReference resultType)" + summary: "Parses the response from the final GET call into the result type of the long-running operation." + modifiers: + - "abstract" + parameters: + - description: "the for the current polling operation" + name: "pollingContext" + type: "<>" + - description: "the of the final result object to deserialize into, or BinaryData if raw\n response body should be kept." + name: "resultType" + type: "<>" + syntax: "public abstract U getResult(PollingContext pollingContext, TypeReference resultType)" + desc: "Parses the response from the final GET call into the result type of the long-running operation." + returns: + description: "the final result" + type: "" +- uid: "com.azure.core.util.polling.SyncPollingStrategy.onInitialResponse(com.azure.core.http.rest.Response,com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncPollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + name: "onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + nameWithType: "SyncPollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + summary: "Parses the initial response into a , and stores information useful for polling in the ." + modifiers: + - "abstract" + parameters: + - description: "the response from the initial method call to activate the long-running operation" + name: "response" + type: "<?>" + - description: "the for the current polling operation" + name: "pollingContext" + type: "<>" + - description: "the of the response type from a polling call, or BinaryData if raw\n response body should be kept. This should match the generic parameter ." + name: "pollResponseType" + type: "<>" + syntax: "public abstract PollResponse onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + desc: "Parses the initial response into a , and stores information useful for polling in the . If the result is anything other than , the long-running operation will be terminated and none of the other methods will be invoked." + returns: + description: "the poll response containing the status and the response content" + type: "<>" +- uid: "com.azure.core.util.polling.SyncPollingStrategy.poll(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncPollingStrategy.poll(PollingContext pollingContext, TypeReference pollResponseType)" + name: "poll(PollingContext pollingContext, TypeReference pollResponseType)" + nameWithType: "SyncPollingStrategy.poll(PollingContext pollingContext, TypeReference pollResponseType)" + summary: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the ." + modifiers: + - "abstract" + parameters: + - description: "the for the current polling operation" + name: "pollingContext" + type: "<>" + - description: "the of the response type from a polling call, or BinaryData if raw\n response body should be kept. This should match the generic parameter ." + name: "pollResponseType" + type: "<>" + syntax: "public abstract PollResponse poll(PollingContext pollingContext, TypeReference pollResponseType)" + desc: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the . The result must have the specified, and the entire polling response content as a ." + returns: + description: "the poll response containing the status and the response content" + type: "<>" +type: "interface" +typeParameters: +- description: "the of the response type from a polling call, or BinaryData if raw response body\n should be kept" + name: "T" +- description: "the of the final result object to deserialize into, or BinaryData if raw response\n body should be kept" + name: "U" +desc: "Represents a known strategy for polling a long-running operation in Azure.\n\nThe methods in the polling strategy will be invoked from the . The order of the invocations is:\n\n1. )\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#canPoll(Response)\"> \\- exits if returns false\n2. ,com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#onInitialResponse(Response, PollingContext, TypeReference)\"> \\- immediately after )\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#canPoll(Response)\"> returns true\n3. ,com.azure.core.util.serializer.TypeReference)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#poll(PollingContext, TypeReference)\"> \\- invoked after each polling interval, if the last polling response indicates an \"In Progress\" status. Returns a with the latest status\n4. ,com.azure.core.util.serializer.TypeReference)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getResult(PollingContext, TypeReference)\"> \\- invoked when the last polling response indicates a \"Successfully Completed\" status. Returns the final result of the given type\n\nIf the user decides to cancel the or , the ,com.azure.core.util.polling.PollResponse)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#cancel(PollingContext, PollResponse)\"> method will be invoked. If the strategy doesn't support cancellation, an error will be returned.\n\nUsers are not expected to provide their own implementation of this interface. Built-in polling strategies in this library and other client libraries are often sufficient for handling polling in most long-running operations in Azure. When there are special scenarios, built-in polling strategies can be inherited and select methods can be overridden to accomplish the polling requirements, without writing an entire polling strategy from scratch." +metadata: {} +package: "com.azure.core.util.polling" +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.SyncStatusCheckPollingStrategy.yml b/docs-ref-autogen/com.azure.core.util.polling.SyncStatusCheckPollingStrategy.yml new file mode 100644 index 000000000000..0405ee415957 --- /dev/null +++ b/docs-ref-autogen/com.azure.core.util.polling.SyncStatusCheckPollingStrategy.yml @@ -0,0 +1,111 @@ +### YamlMime:JavaType +uid: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy" +fullName: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy" +name: "SyncStatusCheckPollingStrategy" +nameWithType: "SyncStatusCheckPollingStrategy" +summary: "Fallback polling strategy that doesn't poll but exits successfully if no other polling strategies are detected and status code is 2xx." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **SyncStatusCheckPollingStrategy**
implements <,>" +constructors: +- uid: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.SyncStatusCheckPollingStrategy()" + fullName: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.SyncStatusCheckPollingStrategy()" + name: "SyncStatusCheckPollingStrategy()" + nameWithType: "SyncStatusCheckPollingStrategy.SyncStatusCheckPollingStrategy()" + summary: "Creates a status check polling strategy with a JSON serializer." + syntax: "public SyncStatusCheckPollingStrategy()" + desc: "Creates a status check polling strategy with a JSON serializer." +- uid: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.SyncStatusCheckPollingStrategy(com.azure.core.util.serializer.ObjectSerializer)" + fullName: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.SyncStatusCheckPollingStrategy(ObjectSerializer serializer)" + name: "SyncStatusCheckPollingStrategy(ObjectSerializer serializer)" + nameWithType: "SyncStatusCheckPollingStrategy.SyncStatusCheckPollingStrategy(ObjectSerializer serializer)" + summary: "Creates a status check polling strategy with a custom object serializer." + parameters: + - description: "a custom serializer for serializing and deserializing polling responses" + name: "serializer" + type: "" + syntax: "public SyncStatusCheckPollingStrategy(ObjectSerializer serializer)" + desc: "Creates a status check polling strategy with a custom object serializer." +methods: +- uid: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.canPoll(com.azure.core.http.rest.Response)" + fullName: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.canPoll(Response initialResponse)" + name: "canPoll(Response initialResponse)" + nameWithType: "SyncStatusCheckPollingStrategy.canPoll(Response initialResponse)" + summary: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + parameters: + - name: "initialResponse" + type: "<?>" + syntax: "public boolean canPoll(Response initialResponse)" + desc: "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.getResult(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.getResult(PollingContext pollingContext, TypeReference resultType)" + name: "getResult(PollingContext pollingContext, TypeReference resultType)" + nameWithType: "SyncStatusCheckPollingStrategy.getResult(PollingContext pollingContext, TypeReference resultType)" + summary: "Parses the response from the final GET call into the result type of the long-running operation." + parameters: + - name: "pollingContext" + type: "<>" + - name: "resultType" + type: "<>" + syntax: "public U getResult(PollingContext pollingContext, TypeReference resultType)" + desc: "Parses the response from the final GET call into the result type of the long-running operation." + returns: + type: "" +- uid: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.onInitialResponse(com.azure.core.http.rest.Response,com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + name: "onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + nameWithType: "SyncStatusCheckPollingStrategy.onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + summary: "Parses the initial response into a , and stores information useful for polling in the ." + parameters: + - name: "response" + type: "<?>" + - name: "pollingContext" + type: "<>" + - name: "pollResponseType" + type: "<>" + syntax: "public PollResponse onInitialResponse(Response response, PollingContext pollingContext, TypeReference pollResponseType)" + desc: "Parses the initial response into a , and stores information useful for polling in the . If the result is anything other than , the long-running operation will be terminated and none of the other methods will be invoked." + returns: + type: "<>" +- uid: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.poll(com.azure.core.util.polling.PollingContext,com.azure.core.util.serializer.TypeReference)" + fullName: "com.azure.core.util.polling.SyncStatusCheckPollingStrategy.poll(PollingContext context, TypeReference pollResponseType)" + name: "poll(PollingContext context, TypeReference pollResponseType)" + nameWithType: "SyncStatusCheckPollingStrategy.poll(PollingContext context, TypeReference pollResponseType)" + summary: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the ." + parameters: + - name: "context" + type: "<>" + - name: "pollResponseType" + type: "<>" + syntax: "public PollResponse poll(PollingContext context, TypeReference pollResponseType)" + desc: "Parses the response from the polling URL into a , and stores information useful for further polling and final response in the . The result must have the specified, and the entire polling response content as a ." + returns: + type: "<>" +type: "class" +typeParameters: +- description: "the type of the response type from a polling call, or BinaryData if raw response body should be kept" + name: "T" +- description: "the type of the final result object to deserialize into, or BinaryData if raw response body should be\n kept" + name: "U" +desc: "Fallback polling strategy that doesn't poll but exits successfully if no other polling strategies are detected and status code is 2xx." +implements: +- "<,>" +metadata: {} +package: "com.azure.core.util.polling" +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.polling.yml b/docs-ref-autogen/com.azure.core.util.polling.yml index 92cd21f9adb4..0bad328ebdb3 100644 --- a/docs-ref-autogen/com.azure.core.util.polling.yml +++ b/docs-ref-autogen/com.azure.core.util.polling.yml @@ -14,10 +14,16 @@ classes: - "com.azure.core.util.polling.PollerFlux" - "com.azure.core.util.polling.PollingContext" - "com.azure.core.util.polling.StatusCheckPollingStrategy" +- "com.azure.core.util.polling.SyncChainedPollingStrategy" +- "com.azure.core.util.polling.SyncDefaultPollingStrategy" +- "com.azure.core.util.polling.SyncLocationPollingStrategy" +- "com.azure.core.util.polling.SyncOperationResourcePollingStrategy" +- "com.azure.core.util.polling.SyncStatusCheckPollingStrategy" interfaces: - "com.azure.core.util.polling.PollingStrategy" - "com.azure.core.util.polling.SyncPoller" +- "com.azure.core.util.polling.SyncPollingStrategy" desc: "Package containing API for long running operations." metadata: {} package: "com.azure.core.util.polling" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.CollectionFormat.yml b/docs-ref-autogen/com.azure.core.util.serializer.CollectionFormat.yml index e7f80b95e959..7cda4b82c343 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.CollectionFormat.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.CollectionFormat.yml @@ -95,4 +95,4 @@ methods: desc: "Swagger collection format to use for joining [List][] parameters in paths, queries, and headers. See [ https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md\\#fixed-fields-7][https_github.com_swagger-api_swagger-spec_blob_master_versions_2.0.md_fixed-fields-7].\n\n\n[List]: https://docs.oracle.com/javase/8/docs/api/java/util/List.html\n[https_github.com_swagger-api_swagger-spec_blob_master_versions_2.0.md_fixed-fields-7]: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#fixed-fields-7" metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.JacksonAdapter.yml b/docs-ref-autogen/com.azure.core.util.serializer.JacksonAdapter.yml index 4ce487ebef80..580fa7e18801 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.JacksonAdapter.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.JacksonAdapter.yml @@ -243,4 +243,4 @@ implements: - "" metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializer.yml b/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializer.yml index 977f0091c0d7..567ae139d586 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializer.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializer.yml @@ -155,4 +155,4 @@ implements: - "" metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializerProvider.yml b/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializerProvider.yml index 8295c9cf54bc..488896e8b88f 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializerProvider.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializerProvider.yml @@ -22,4 +22,4 @@ type: "interface" desc: "Interface to be implemented by an azure-core plugin that wishes to provide a implementation." metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializerProviders.yml b/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializerProviders.yml index f769f8381398..fc1ed7e92d0f 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializerProviders.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.JsonSerializerProviders.yml @@ -54,4 +54,4 @@ type: "class" desc: "This class is a proxy for using a loaded from the classpath." metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverter.yml b/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverter.yml index b68d1e8ac7f5..3413ffcb1002 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverter.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverter.yml @@ -26,4 +26,4 @@ type: "interface" desc: "Generic interface that attempts to retrieve the JSON serialized property name from ." metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverterProvider.yml b/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverterProvider.yml index 2596c85fd068..08ec3fbc922e 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverterProvider.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverterProvider.yml @@ -22,4 +22,4 @@ type: "interface" desc: "Interface to be implemented by an azure-core plugin that wishes to provide a implementation." metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverterProviders.yml b/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverterProviders.yml index feaf38132b56..8b7c97988cb3 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverterProviders.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.MemberNameConverterProviders.yml @@ -38,4 +38,4 @@ type: "class" desc: "This class is a proxy for using a loaded from the classpath." metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.ObjectSerializer.yml b/docs-ref-autogen/com.azure.core.util.serializer.ObjectSerializer.yml index bc4b41c6a45f..44f554e1926b 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.ObjectSerializer.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.ObjectSerializer.yml @@ -153,4 +153,4 @@ type: "interface" desc: "Generic interface covering serializing and deserialization objects." metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.SerializerAdapter.yml b/docs-ref-autogen/com.azure.core.util.serializer.SerializerAdapter.yml index 78e2f651394b..4aedde676c19 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.SerializerAdapter.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.SerializerAdapter.yml @@ -249,4 +249,4 @@ type: "interface" desc: "An interface defining the behaviors of a serializer." metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.SerializerEncoding.yml b/docs-ref-autogen/com.azure.core.util.serializer.SerializerEncoding.yml index 0ba0c62681b2..6c64a889eed2 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.SerializerEncoding.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.SerializerEncoding.yml @@ -83,4 +83,4 @@ methods: desc: "Supported serialization encoding formats." metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.TypeReference.yml b/docs-ref-autogen/com.azure.core.util.serializer.TypeReference.yml index c0874b68f04d..397f54b65aaf 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.TypeReference.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.TypeReference.yml @@ -73,4 +73,4 @@ typeParameters: desc: "This class represents a generic Java type, retaining information about generics.\n\n**Code sample**\n\n```java\n// Construct a TypeReference for a Java generic type.\n // This pattern should only be used for generic types, for classes use the createInstance factory method.\n TypeReference> typeReference = new TypeReference>() { };\n```\n\n```java\n// Construct a TypeReference for a Java class.\n // This pattern should only be used for non-generic classes when possible, use the constructor for generic\n // class when possible.\n TypeReference typeReference = TypeReference.createInstance(int.class);\n```" metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.serializer.yml b/docs-ref-autogen/com.azure.core.util.serializer.yml index ff764efb13c7..4ac63a0e20a7 100644 --- a/docs-ref-autogen/com.azure.core.util.serializer.yml +++ b/docs-ref-autogen/com.azure.core.util.serializer.yml @@ -21,4 +21,4 @@ interfaces: desc: "Package containing interfaces describing serialization and deserialization contract." metadata: {} package: "com.azure.core.util.serializer" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.tracing.ProcessKind.yml b/docs-ref-autogen/com.azure.core.util.tracing.ProcessKind.yml index 3c5dcdd283b9..037f1e189c49 100644 --- a/docs-ref-autogen/com.azure.core.util.tracing.ProcessKind.yml +++ b/docs-ref-autogen/com.azure.core.util.tracing.ProcessKind.yml @@ -73,4 +73,4 @@ methods: desc: "Contains constants common AMQP protocol process calls." metadata: {} package: "com.azure.core.util.tracing" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.tracing.SpanKind.yml b/docs-ref-autogen/com.azure.core.util.tracing.SpanKind.yml index a928d3b985cc..df4b7b30d0a9 100644 --- a/docs-ref-autogen/com.azure.core.util.tracing.SpanKind.yml +++ b/docs-ref-autogen/com.azure.core.util.tracing.SpanKind.yml @@ -85,4 +85,4 @@ methods: desc: "Represents the tracing span type." metadata: {} package: "com.azure.core.util.tracing" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.tracing.StartSpanOptions.yml b/docs-ref-autogen/com.azure.core.util.tracing.StartSpanOptions.yml index 6de421029498..e1cf3860fa82 100644 --- a/docs-ref-autogen/com.azure.core.util.tracing.StartSpanOptions.yml +++ b/docs-ref-autogen/com.azure.core.util.tracing.StartSpanOptions.yml @@ -75,4 +75,4 @@ 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.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.tracing.Tracer.yml b/docs-ref-autogen/com.azure.core.util.tracing.Tracer.yml index 1c9f0b82c3f8..c13de46a1668 100644 --- a/docs-ref-autogen/com.azure.core.util.tracing.Tracer.yml +++ b/docs-ref-autogen/com.azure.core.util.tracing.Tracer.yml @@ -418,4 +418,4 @@ type: "interface" desc: "Contract that all tracers must implement to be pluggable into the SDK." metadata: {} package: "com.azure.core.util.tracing" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.tracing.TracerProxy.yml b/docs-ref-autogen/com.azure.core.util.tracing.TracerProxy.yml index dba5bc674b8a..2a019315a065 100644 --- a/docs-ref-autogen/com.azure.core.util.tracing.TracerProxy.yml +++ b/docs-ref-autogen/com.azure.core.util.tracing.TracerProxy.yml @@ -136,4 +136,4 @@ type: "class" desc: "This class provides a means for all client libraries to augment the context information they have received from an end user with additional distributed tracing information, that may then be passed on to a backend for analysis." metadata: {} package: "com.azure.core.util.tracing" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.tracing.yml b/docs-ref-autogen/com.azure.core.util.tracing.yml index 3da0be288e4b..4562f44be02b 100644 --- a/docs-ref-autogen/com.azure.core.util.tracing.yml +++ b/docs-ref-autogen/com.azure.core.util.tracing.yml @@ -14,4 +14,4 @@ interfaces: desc: "Package containing API for tracing." metadata: {} package: "com.azure.core.util.tracing" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/com.azure.core.util.yml b/docs-ref-autogen/com.azure.core.util.yml index dfe0d9611e3c..bf0d26f1a86c 100644 --- a/docs-ref-autogen/com.azure.core.util.yml +++ b/docs-ref-autogen/com.azure.core.util.yml @@ -38,4 +38,4 @@ interfaces: desc: "Package containing core utility classes." metadata: {} package: "com.azure.core.util" -artifact: com.azure:azure-core:1.33.0 +artifact: com.azure:azure-core:1.34.0 diff --git a/docs-ref-autogen/toc.yml b/docs-ref-autogen/toc.yml index a2a3fa732be1..fecc3ca6c1e6 100644 --- a/docs-ref-autogen/toc.yml +++ b/docs-ref-autogen/toc.yml @@ -823,6 +823,8 @@ name: HttpClientProvider - uid: com.azure.core.http.HttpHeader name: HttpHeader + - uid: com.azure.core.http.HttpHeaderName + name: HttpHeaderName - uid: com.azure.core.http.HttpHeaders name: HttpHeaders - uid: com.azure.core.http.HttpMethod @@ -1032,8 +1034,20 @@ name: PollingStrategy - uid: com.azure.core.util.polling.StatusCheckPollingStrategy name: StatusCheckPollingStrategy + - uid: com.azure.core.util.polling.SyncChainedPollingStrategy + name: SyncChainedPollingStrategy + - uid: com.azure.core.util.polling.SyncDefaultPollingStrategy + name: SyncDefaultPollingStrategy + - uid: com.azure.core.util.polling.SyncLocationPollingStrategy + name: SyncLocationPollingStrategy + - uid: com.azure.core.util.polling.SyncOperationResourcePollingStrategy + name: SyncOperationResourcePollingStrategy - uid: com.azure.core.util.polling.SyncPoller name: SyncPoller + - uid: com.azure.core.util.polling.SyncPollingStrategy + name: SyncPollingStrategy + - uid: com.azure.core.util.polling.SyncStatusCheckPollingStrategy + name: SyncStatusCheckPollingStrategy - uid: com.azure.core.http.rest name: com.azure.core.http.rest items: diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationAsyncClient.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationAsyncClient.yml new file mode 100644 index 000000000000..b213d43b2f30 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationAsyncClient.yml @@ -0,0 +1,177 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.CallAutomationAsyncClient" +fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient" +name: "CallAutomationAsyncClient" +nameWithType: "CallAutomationAsyncClient" +summary: "Asynchronous client that supports calling server operations." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallAutomationAsyncClient**" +methods: +- uid: "com.azure.communication.callautomation.CallAutomationAsyncClient.answerCall(java.lang.String,java.lang.String)" + fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient.answerCall(String incomingCallContext, String callbackUrl)" + name: "answerCall(String incomingCallContext, String callbackUrl)" + nameWithType: "CallAutomationAsyncClient.answerCall(String incomingCallContext, String callbackUrl)" + summary: "Answer an incoming call" + parameters: + - description: "The incoming call context." + name: "incomingCallContext" + type: "String" + - description: "The call back url." + name: "callbackUrl" + type: "String" + syntax: "public Mono answerCall(String incomingCallContext, String callbackUrl)" + desc: "Answer an incoming call" + returns: + description: "Response for a successful CreateCallConnection request." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallAutomationAsyncClient.answerCallWithResponse(com.azure.communication.callautomation.models.AnswerCallOptions)" + fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient.answerCallWithResponse(AnswerCallOptions answerCallOptions)" + name: "answerCallWithResponse(AnswerCallOptions answerCallOptions)" + nameWithType: "CallAutomationAsyncClient.answerCallWithResponse(AnswerCallOptions answerCallOptions)" + summary: "Create a call connection request from a source identity to a target identity." + parameters: + - description: "The options of answering the call." + name: "answerCallOptions" + type: "" + syntax: "public Mono> answerCallWithResponse(AnswerCallOptions answerCallOptions)" + desc: "Create a call connection request from a source identity to a target identity." + returns: + description: "Response for a successful CreateCallConnection request." + type: "Mono<<>>" +- uid: "com.azure.communication.callautomation.CallAutomationAsyncClient.createCall(com.azure.communication.common.CommunicationIdentifier,java.util.List,java.lang.String)" + fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient.createCall(CommunicationIdentifier source, List targets, String callbackUrl)" + name: "createCall(CommunicationIdentifier source, List targets, String callbackUrl)" + nameWithType: "CallAutomationAsyncClient.createCall(CommunicationIdentifier source, List targets, String callbackUrl)" + summary: "Create a call connection request from a source identity to a target identity." + parameters: + - description: "The caller." + name: "source" + type: "" + - description: "The list of targets." + name: "targets" + type: "List<>" + - description: "The call back url for receiving events." + name: "callbackUrl" + type: "String" + syntax: "public Mono createCall(CommunicationIdentifier source, List targets, String callbackUrl)" + desc: "Create a call connection request from a source identity to a target identity." + returns: + description: "Response for a successful CreateCallConnection request." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallAutomationAsyncClient.createCallWithResponse(com.azure.communication.callautomation.models.CreateCallOptions)" + fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient.createCallWithResponse(CreateCallOptions createCallOptions)" + name: "createCallWithResponse(CreateCallOptions createCallOptions)" + nameWithType: "CallAutomationAsyncClient.createCallWithResponse(CreateCallOptions createCallOptions)" + summary: "Create a call connection request from a source identity to a target identity." + parameters: + - description: "Options for creating a new call." + name: "createCallOptions" + type: "" + syntax: "public Mono> createCallWithResponse(CreateCallOptions createCallOptions)" + desc: "Create a call connection request from a source identity to a target identity." + returns: + description: "Response for a successful CreateCallConnection request." + type: "Mono<<>>" +- uid: "com.azure.communication.callautomation.CallAutomationAsyncClient.getCallConnectionAsync(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient.getCallConnectionAsync(String callConnectionId)" + name: "getCallConnectionAsync(String callConnectionId)" + nameWithType: "CallAutomationAsyncClient.getCallConnectionAsync(String callConnectionId)" + summary: "Returns an object of CallConnectionAsync" + parameters: + - description: "the id of the call connection" + name: "callConnectionId" + type: "String" + syntax: "public CallConnectionAsync getCallConnectionAsync(String callConnectionId)" + desc: "Returns an object of CallConnectionAsync" + returns: + description: "a CallContentAsync." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationAsyncClient.getCallRecordingAsync()" + fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient.getCallRecordingAsync()" + name: "getCallRecordingAsync()" + nameWithType: "CallAutomationAsyncClient.getCallRecordingAsync()" + summary: "Returns an object of CallRecordingAsync" + syntax: "public CallRecordingAsync getCallRecordingAsync()" + desc: "Returns an object of CallRecordingAsync" + returns: + description: "a CallRecordingAsync." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationAsyncClient.redirectCall(java.lang.String,com.azure.communication.common.CommunicationIdentifier)" + fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient.redirectCall(String incomingCallContext, CommunicationIdentifier target)" + name: "redirectCall(String incomingCallContext, CommunicationIdentifier target)" + nameWithType: "CallAutomationAsyncClient.redirectCall(String incomingCallContext, CommunicationIdentifier target)" + summary: "Redirect a call" + parameters: + - description: "The incoming call context." + name: "incomingCallContext" + type: "String" + - description: "The target identity." + name: "target" + type: "" + syntax: "public Mono redirectCall(String incomingCallContext, CommunicationIdentifier target)" + desc: "Redirect a call" + returns: + description: "Response for a successful CreateCallConnection request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallAutomationAsyncClient.redirectCallWithResponse(com.azure.communication.callautomation.models.RedirectCallOptions)" + fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient.redirectCallWithResponse(RedirectCallOptions redirectCallOptions)" + name: "redirectCallWithResponse(RedirectCallOptions redirectCallOptions)" + nameWithType: "CallAutomationAsyncClient.redirectCallWithResponse(RedirectCallOptions redirectCallOptions)" + summary: "Redirect a call" + parameters: + - description: "Options for redirecting a call." + name: "redirectCallOptions" + type: "" + syntax: "public Mono> redirectCallWithResponse(RedirectCallOptions redirectCallOptions)" + desc: "Redirect a call" + returns: + description: "Response for a successful CreateCallConnection request." + type: "Mono<<Void>>" +- uid: "com.azure.communication.callautomation.CallAutomationAsyncClient.rejectCall(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient.rejectCall(String incomingCallContext)" + name: "rejectCall(String incomingCallContext)" + nameWithType: "CallAutomationAsyncClient.rejectCall(String incomingCallContext)" + summary: "Reject a call" + parameters: + - description: "The incoming call context." + name: "incomingCallContext" + type: "String" + syntax: "public Mono rejectCall(String incomingCallContext)" + desc: "Reject a call" + returns: + description: "Response for a successful CreateCallConnection request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallAutomationAsyncClient.rejectCallWithResponse(com.azure.communication.callautomation.models.RejectCallOptions)" + fullName: "com.azure.communication.callautomation.CallAutomationAsyncClient.rejectCallWithResponse(RejectCallOptions rejectCallOptions)" + name: "rejectCallWithResponse(RejectCallOptions rejectCallOptions)" + nameWithType: "CallAutomationAsyncClient.rejectCallWithResponse(RejectCallOptions rejectCallOptions)" + summary: "Reject a call" + parameters: + - description: "the options of rejecting the call" + name: "rejectCallOptions" + type: "" + syntax: "public Mono> rejectCallWithResponse(RejectCallOptions rejectCallOptions)" + desc: "Reject a call" + returns: + description: "Response for a successful CreateCallConnection request." + type: "Mono<<Void>>" +type: "class" +desc: "Asynchronous client that supports calling server operations.\n\n**Instantiating a asynchronous CallingServer client**\n\nView for additional ways to construct the client." +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationClient.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationClient.yml new file mode 100644 index 000000000000..8a8f50aa8c45 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationClient.yml @@ -0,0 +1,189 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.CallAutomationClient" +fullName: "com.azure.communication.callautomation.CallAutomationClient" +name: "CallAutomationClient" +nameWithType: "CallAutomationClient" +summary: "Synchronous client that supports calling server operations." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallAutomationClient**" +methods: +- uid: "com.azure.communication.callautomation.CallAutomationClient.answerCall(java.lang.String,java.lang.String)" + fullName: "com.azure.communication.callautomation.CallAutomationClient.answerCall(String incomingCallContext, String callbackUrl)" + name: "answerCall(String incomingCallContext, String callbackUrl)" + nameWithType: "CallAutomationClient.answerCall(String incomingCallContext, String callbackUrl)" + summary: "Answer an incoming call" + parameters: + - description: "The incoming call context." + name: "incomingCallContext" + type: "String" + - description: "The call back uri." + name: "callbackUrl" + type: "String" + syntax: "public AnswerCallResult answerCall(String incomingCallContext, String callbackUrl)" + desc: "Answer an incoming call" + returns: + description: "Response for a successful CreateCallConnection request." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClient.answerCallWithResponse(com.azure.communication.callautomation.models.AnswerCallOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallAutomationClient.answerCallWithResponse(AnswerCallOptions answerCallOptions, Context context)" + name: "answerCallWithResponse(AnswerCallOptions answerCallOptions, Context context)" + nameWithType: "CallAutomationClient.answerCallWithResponse(AnswerCallOptions answerCallOptions, Context context)" + summary: "Create a call connection request from a source identity to a target identity." + parameters: + - description: "The options of answering the call." + name: "answerCallOptions" + type: "" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public Response answerCallWithResponse(AnswerCallOptions answerCallOptions, Context context)" + desc: "Create a call connection request from a source identity to a target identity." + returns: + description: "Response for a successful CreateCallConnection request." + type: "<>" +- uid: "com.azure.communication.callautomation.CallAutomationClient.createCall(com.azure.communication.common.CommunicationIdentifier,java.util.List,java.lang.String)" + fullName: "com.azure.communication.callautomation.CallAutomationClient.createCall(CommunicationIdentifier source, List targets, String callbackUrl)" + name: "createCall(CommunicationIdentifier source, List targets, String callbackUrl)" + nameWithType: "CallAutomationClient.createCall(CommunicationIdentifier source, List targets, String callbackUrl)" + summary: "Create a call connection request from a source identity to a target identity." + parameters: + - description: "The caller." + name: "source" + type: "" + - description: "The list of targets." + name: "targets" + type: "List<>" + - description: "The call back url for receiving events." + name: "callbackUrl" + type: "String" + syntax: "public CreateCallResult createCall(CommunicationIdentifier source, List targets, String callbackUrl)" + desc: "Create a call connection request from a source identity to a target identity." + returns: + description: "A CallConnectionDelete object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClient.createCallWithResponse(com.azure.communication.callautomation.models.CreateCallOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallAutomationClient.createCallWithResponse(CreateCallOptions createCallOptions, Context context)" + name: "createCallWithResponse(CreateCallOptions createCallOptions, Context context)" + nameWithType: "CallAutomationClient.createCallWithResponse(CreateCallOptions createCallOptions, Context context)" + summary: "Create a call connection request from a source identity to a target identity." + parameters: + - description: "Options bag for creating a new call." + name: "createCallOptions" + type: "" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public Response createCallWithResponse(CreateCallOptions createCallOptions, Context context)" + desc: "Create a call connection request from a source identity to a target identity." + returns: + description: "Response for a successful CreateCallConnection request." + type: "<>" +- uid: "com.azure.communication.callautomation.CallAutomationClient.getCallConnection(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallAutomationClient.getCallConnection(String callConnectionId)" + name: "getCallConnection(String callConnectionId)" + nameWithType: "CallAutomationClient.getCallConnection(String callConnectionId)" + summary: "Returns an object of CallConnection" + parameters: + - description: "the id of the call connection" + name: "callConnectionId" + type: "String" + syntax: "public CallConnection getCallConnection(String callConnectionId)" + desc: "Returns an object of CallConnection" + returns: + description: "a CallConnection." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClient.getCallRecording()" + fullName: "com.azure.communication.callautomation.CallAutomationClient.getCallRecording()" + name: "getCallRecording()" + nameWithType: "CallAutomationClient.getCallRecording()" + summary: "Returns an object of CallRecording" + syntax: "public CallRecording getCallRecording()" + desc: "Returns an object of CallRecording" + returns: + description: "a CallRecording." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClient.redirectCall(java.lang.String,com.azure.communication.common.CommunicationIdentifier)" + fullName: "com.azure.communication.callautomation.CallAutomationClient.redirectCall(String incomingCallContext, CommunicationIdentifier target)" + name: "redirectCall(String incomingCallContext, CommunicationIdentifier target)" + nameWithType: "CallAutomationClient.redirectCall(String incomingCallContext, CommunicationIdentifier target)" + summary: "Redirect a call" + parameters: + - description: "The incoming call context." + name: "incomingCallContext" + type: "String" + - description: "The target identity." + name: "target" + type: "" + syntax: "public Void redirectCall(String incomingCallContext, CommunicationIdentifier target)" + desc: "Redirect a call" + returns: + description: "Response for a successful CreateCallConnection request." + type: "Void" +- uid: "com.azure.communication.callautomation.CallAutomationClient.redirectCallWithResponse(com.azure.communication.callautomation.models.RedirectCallOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallAutomationClient.redirectCallWithResponse(RedirectCallOptions redirectCallOptions, Context context)" + name: "redirectCallWithResponse(RedirectCallOptions redirectCallOptions, Context context)" + nameWithType: "CallAutomationClient.redirectCallWithResponse(RedirectCallOptions redirectCallOptions, Context context)" + summary: "Redirect a call" + parameters: + - description: "options of redirecting a call" + name: "redirectCallOptions" + type: "" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public Response redirectCallWithResponse(RedirectCallOptions redirectCallOptions, Context context)" + desc: "Redirect a call" + returns: + description: "Response for a successful CreateCallConnection request." + type: "<Void>" +- uid: "com.azure.communication.callautomation.CallAutomationClient.rejectCall(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallAutomationClient.rejectCall(String incomingCallContext)" + name: "rejectCall(String incomingCallContext)" + nameWithType: "CallAutomationClient.rejectCall(String incomingCallContext)" + summary: "Reject a call" + parameters: + - description: "The incoming call context." + name: "incomingCallContext" + type: "String" + syntax: "public Void rejectCall(String incomingCallContext)" + desc: "Reject a call" + returns: + description: "Response for a successful CreateCallConnection request." + type: "Void" +- uid: "com.azure.communication.callautomation.CallAutomationClient.rejectCallWithResponse(com.azure.communication.callautomation.models.RejectCallOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallAutomationClient.rejectCallWithResponse(RejectCallOptions rejectCallOptions, Context context)" + name: "rejectCallWithResponse(RejectCallOptions rejectCallOptions, Context context)" + nameWithType: "CallAutomationClient.rejectCallWithResponse(RejectCallOptions rejectCallOptions, Context context)" + summary: "Reject a call" + parameters: + - description: "The options of rejecting the call." + name: "rejectCallOptions" + type: "" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public Response rejectCallWithResponse(RejectCallOptions rejectCallOptions, Context context)" + desc: "Reject a call" + returns: + description: "Response for a successful CreateCallConnection request." + type: "<Void>" +type: "class" +desc: "Synchronous client that supports calling server operations.\n\n**Instantiating a synchronous Calling Server Client**\n\nView for additional ways to construct the client." +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationClientBuilder.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationClientBuilder.yml new file mode 100644 index 000000000000..bd7663bd41d7 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallAutomationClientBuilder.yml @@ -0,0 +1,246 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.CallAutomationClientBuilder" +fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder" +name: "CallAutomationClientBuilder" +nameWithType: "CallAutomationClientBuilder" +summary: "Client builder that creates CallAutomationAsyncClient and CallAutomationClient." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallAutomationClientBuilder**
implements <>, <>, <>, <>, <>, <>" +constructors: +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.CallAutomationClientBuilder()" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.CallAutomationClientBuilder()" + name: "CallAutomationClientBuilder()" + nameWithType: "CallAutomationClientBuilder.CallAutomationClientBuilder()" + summary: "Public default constructor" + syntax: "public CallAutomationClientBuilder()" + desc: "Public default constructor" +methods: +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)" + name: "addPolicy(HttpPipelinePolicy customPolicy)" + nameWithType: "CallAutomationClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)" + summary: "Adds a to apply on each request sent." + parameters: + - description: "A ." + name: "customPolicy" + type: "" + syntax: "public CallAutomationClientBuilder addPolicy(HttpPipelinePolicy customPolicy)" + desc: "Adds a to apply on each request sent.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications." + returns: + description: "Updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.buildAsyncClient()" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.buildAsyncClient()" + name: "buildAsyncClient()" + nameWithType: "CallAutomationClientBuilder.buildAsyncClient()" + summary: "Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy." + syntax: "public CallAutomationAsyncClient buildAsyncClient()" + desc: "Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them" + returns: + description: "The updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.buildClient()" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.buildClient()" + name: "buildClient()" + nameWithType: "CallAutomationClientBuilder.buildClient()" + summary: "Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy." + syntax: "public CallAutomationClient buildClient()" + desc: "Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them." + returns: + description: "Updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.clientOptions(com.azure.core.util.ClientOptions)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.clientOptions(ClientOptions clientOptions)" + name: "clientOptions(ClientOptions clientOptions)" + nameWithType: "CallAutomationClientBuilder.clientOptions(ClientOptions clientOptions)" + summary: "Allows the user to set a variety of client-related options, such as user-agent string, headers, etc." + parameters: + - description: "object to be applied." + name: "clientOptions" + type: "" + syntax: "public CallAutomationClientBuilder clientOptions(ClientOptions clientOptions)" + desc: "Allows the user to set a variety of client-related options, such as user-agent string, headers, etc." + returns: + description: "Updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.configuration(com.azure.core.util.Configuration)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.configuration(Configuration configuration)" + name: "configuration(Configuration configuration)" + nameWithType: "CallAutomationClientBuilder.configuration(Configuration configuration)" + summary: "Sets the configuration object used to retrieve environment configuration values during building of the client." + parameters: + - description: "Configuration store used to retrieve environment\n configurations." + name: "configuration" + type: "" + syntax: "public CallAutomationClientBuilder configuration(Configuration configuration)" + desc: "Sets the configuration object used to retrieve environment configuration values during building of the client." + returns: + description: "Updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.connectionString(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.connectionString(String connectionString)" + name: "connectionString(String connectionString)" + nameWithType: "CallAutomationClientBuilder.connectionString(String connectionString)" + summary: "Set connectionString to use." + parameters: + - description: "connection string to set." + name: "connectionString" + type: "String" + syntax: "public CallAutomationClientBuilder connectionString(String connectionString)" + desc: "Set connectionString to use." + returns: + description: "Updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.credential(AzureKeyCredential keyCredential)" + name: "credential(AzureKeyCredential keyCredential)" + nameWithType: "CallAutomationClientBuilder.credential(AzureKeyCredential keyCredential)" + summary: "Sets the used to authenticate HTTP requests." + parameters: + - description: "The used to authenticate HTTP\n requests." + name: "keyCredential" + type: "" + syntax: "public CallAutomationClientBuilder credential(AzureKeyCredential keyCredential)" + desc: "Sets the used to authenticate HTTP requests." + returns: + description: "Updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.credential(com.azure.core.credential.TokenCredential)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.credential(TokenCredential tokenCredential)" + name: "credential(TokenCredential tokenCredential)" + nameWithType: "CallAutomationClientBuilder.credential(TokenCredential tokenCredential)" + summary: "Sets the used to authorize requests sent to the service." + parameters: + - description: " used to authorize requests sent to the service." + name: "tokenCredential" + type: "" + syntax: "public CallAutomationClientBuilder credential(TokenCredential tokenCredential)" + desc: "Sets the used to authorize requests sent to the service. Refer to the Azure SDK for Java [identity and authentication][] documentation for more details on proper usage of the type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity" + returns: + description: "Updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.endpoint(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.endpoint(String endpoint)" + name: "endpoint(String endpoint)" + nameWithType: "CallAutomationClientBuilder.endpoint(String endpoint)" + summary: "Set endpoint of the service." + parameters: + - description: "url of the service." + name: "endpoint" + type: "String" + syntax: "public CallAutomationClientBuilder endpoint(String endpoint)" + desc: "Set endpoint of the service." + returns: + description: "CallAutomationClientBuilder object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.httpClient(com.azure.core.http.HttpClient)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.httpClient(HttpClient httpClient)" + name: "httpClient(HttpClient httpClient)" + nameWithType: "CallAutomationClientBuilder.httpClient(HttpClient httpClient)" + summary: "Sets the to use for sending and receiving requests to and from the service." + parameters: + - description: "The to use for requests." + name: "httpClient" + type: "" + syntax: "public CallAutomationClientBuilder httpClient(HttpClient httpClient)" + desc: "Sets the to use for sending and receiving requests to and from the service.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications." + returns: + description: "Updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.httpLogOptions(HttpLogOptions logOptions)" + name: "httpLogOptions(HttpLogOptions logOptions)" + nameWithType: "CallAutomationClientBuilder.httpLogOptions(HttpLogOptions logOptions)" + summary: "Sets the to use when sending and receiving requests to and from the service." + parameters: + - description: "The to use when sending and receiving requests to\n and from the service." + name: "logOptions" + type: "" + syntax: "public CallAutomationClientBuilder httpLogOptions(HttpLogOptions logOptions)" + desc: "Sets the to use when sending and receiving requests to and from the service. If a `logLevel` is not provided, default value of is set.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications." + returns: + description: "The updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.pipeline(HttpPipeline pipeline)" + name: "pipeline(HttpPipeline pipeline)" + nameWithType: "CallAutomationClientBuilder.pipeline(HttpPipeline pipeline)" + summary: "Sets the to use for the service client." + parameters: + - description: " to use for sending service requests and receiving responses,\n if a pipeline is not supplied, the\n credential and httpClient fields must be set." + name: "pipeline" + type: "" + syntax: "public CallAutomationClientBuilder pipeline(HttpPipeline pipeline)" + desc: "Sets the to use for the service client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications." + returns: + description: "CallAutomationClientBuilder object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.retryOptions(RetryOptions retryOptions)" + name: "retryOptions(RetryOptions retryOptions)" + nameWithType: "CallAutomationClientBuilder.retryOptions(RetryOptions retryOptions)" + summary: "Sets the for all the requests made through the client." + parameters: + - description: "The to use for all the requests made through the client." + name: "retryOptions" + type: "" + syntax: "public CallAutomationClientBuilder retryOptions(RetryOptions retryOptions)" + desc: "Sets the for all the requests made through the client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nSetting this is mutually exclusive with using ." + returns: + description: "Updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.retryPolicy(RetryPolicy retryPolicy)" + name: "retryPolicy(RetryPolicy retryPolicy)" + nameWithType: "CallAutomationClientBuilder.retryPolicy(RetryPolicy retryPolicy)" + summary: "Sets the retry policy to use (using the RetryPolicy type)." + parameters: + - description: "object to be applied" + name: "retryPolicy" + type: "" + syntax: "public CallAutomationClientBuilder retryPolicy(RetryPolicy retryPolicy)" + desc: "Sets the retry policy to use (using the RetryPolicy type).\n\nSetting this is mutually exclusive with using ." + returns: + description: "Updated object." + type: "" +- uid: "com.azure.communication.callautomation.CallAutomationClientBuilder.serviceVersion(com.azure.communication.callautomation.CallingServerServiceVersion)" + fullName: "com.azure.communication.callautomation.CallAutomationClientBuilder.serviceVersion(CallingServerServiceVersion version)" + name: "serviceVersion(CallingServerServiceVersion version)" + nameWithType: "CallAutomationClientBuilder.serviceVersion(CallingServerServiceVersion version)" + summary: "Sets the that is used when making API requests." + parameters: + - description: " of the service to be used when making requests." + name: "version" + type: "" + syntax: "public CallAutomationClientBuilder serviceVersion(CallingServerServiceVersion version)" + desc: "Sets the that is used when making API requests.\n\nIf a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version of the client library will have the result of potentially moving to a newer service version.\n\nTargeting a specific service version may also mean that the service will return an error for newer APIs." + returns: + description: "Updated CallAutomationClientBuilder object" + type: "" +type: "class" +desc: "Client builder that creates CallAutomationAsyncClient and CallAutomationClient.\n\n**Instantiating synchronous and asynchronous Calling Server Clients**" +implements: +- "<>" +- "<>" +- "<>" +- "<>" +- "<>" +- "<>" +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.CallConnection.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallConnection.yml new file mode 100644 index 000000000000..1fee811e5728 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallConnection.yml @@ -0,0 +1,242 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.CallConnection" +fullName: "com.azure.communication.callautomation.CallConnection" +name: "CallConnection" +nameWithType: "CallConnection" +summary: "CallConnection for mid-call actions" +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **CallConnection**" +methods: +- uid: "com.azure.communication.callautomation.CallConnection.addParticipants(java.util.List)" + fullName: "com.azure.communication.callautomation.CallConnection.addParticipants(List participants)" + name: "addParticipants(List participants)" + nameWithType: "CallConnection.addParticipants(List participants)" + summary: "Add a participant to the call." + parameters: + - description: "The list of participants to invite." + name: "participants" + type: "List<>" + syntax: "public AddParticipantsResult addParticipants(List participants)" + desc: "Add a participant to the call." + returns: + description: "Response for a successful add participant request." + type: "" +- uid: "com.azure.communication.callautomation.CallConnection.addParticipantsWithResponse(com.azure.communication.callautomation.models.AddParticipantsOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallConnection.addParticipantsWithResponse(AddParticipantsOptions addParticipantsOptions, Context context)" + name: "addParticipantsWithResponse(AddParticipantsOptions addParticipantsOptions, Context context)" + nameWithType: "CallConnection.addParticipantsWithResponse(AddParticipantsOptions addParticipantsOptions, Context context)" + summary: "Add a participant to the call." + parameters: + - description: "Options bag for addParticipants" + name: "addParticipantsOptions" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response addParticipantsWithResponse(AddParticipantsOptions addParticipantsOptions, Context context)" + desc: "Add a participant to the call." + returns: + description: "Response for a successful add participant request." + type: "<>" +- uid: "com.azure.communication.callautomation.CallConnection.getCallMedia()" + fullName: "com.azure.communication.callautomation.CallConnection.getCallMedia()" + name: "getCallMedia()" + nameWithType: "CallConnection.getCallMedia()" + summary: "Returns an object of CallContent" + syntax: "public CallMedia getCallMedia()" + desc: "Returns an object of CallContent" + returns: + description: "a CallContentAsync." + type: "" +- uid: "com.azure.communication.callautomation.CallConnection.getCallProperties()" + fullName: "com.azure.communication.callautomation.CallConnection.getCallProperties()" + name: "getCallProperties()" + nameWithType: "CallConnection.getCallProperties()" + summary: "Get call connection properties." + syntax: "public CallConnectionProperties getCallProperties()" + desc: "Get call connection properties." + returns: + description: "Response payload for a successful get call connection request." + type: "" +- uid: "com.azure.communication.callautomation.CallConnection.getCallPropertiesWithResponse(com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallConnection.getCallPropertiesWithResponse(Context context)" + name: "getCallPropertiesWithResponse(Context context)" + nameWithType: "CallConnection.getCallPropertiesWithResponse(Context context)" + summary: "Get call connection properties." + parameters: + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response getCallPropertiesWithResponse(Context context)" + desc: "Get call connection properties." + returns: + description: "Response payload for a successful get call connection request." + type: "<>" +- uid: "com.azure.communication.callautomation.CallConnection.getParticipant(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallConnection.getParticipant(String participantMri)" + name: "getParticipant(String participantMri)" + nameWithType: "CallConnection.getParticipant(String participantMri)" + summary: "Get a specific participant." + parameters: + - description: "The participant." + name: "participantMri" + type: "String" + syntax: "public CallParticipant getParticipant(String participantMri)" + desc: "Get a specific participant." + returns: + description: "Response payload for a successful get call connection request." + type: "" +- uid: "com.azure.communication.callautomation.CallConnection.getParticipantWithResponse(java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallConnection.getParticipantWithResponse(String participantMri, Context context)" + name: "getParticipantWithResponse(String participantMri, Context context)" + nameWithType: "CallConnection.getParticipantWithResponse(String participantMri, Context context)" + summary: "Get all participants." + parameters: + - description: "The participant." + name: "participantMri" + type: "String" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response getParticipantWithResponse(String participantMri, Context context)" + desc: "Get all participants." + returns: + description: "Response payload for a successful get call connection request." + type: "<>" +- uid: "com.azure.communication.callautomation.CallConnection.hangUp(boolean)" + fullName: "com.azure.communication.callautomation.CallConnection.hangUp(boolean isForEveryone)" + name: "hangUp(boolean isForEveryone)" + nameWithType: "CallConnection.hangUp(boolean isForEveryone)" + summary: "Hangup a call." + parameters: + - description: "determine if the call is handed up for all participants." + name: "isForEveryone" + type: "" + syntax: "public Void hangUp(boolean isForEveryone)" + desc: "Hangup a call." + returns: + description: "Response for a successful hangup request." + type: "Void" +- uid: "com.azure.communication.callautomation.CallConnection.hangUpWithResponse(com.azure.communication.callautomation.models.HangUpOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallConnection.hangUpWithResponse(HangUpOptions hangUpOptions, Context context)" + name: "hangUpWithResponse(HangUpOptions hangUpOptions, Context context)" + nameWithType: "CallConnection.hangUpWithResponse(HangUpOptions hangUpOptions, Context context)" + summary: "Hangup a call." + parameters: + - description: "options to hang up" + name: "hangUpOptions" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response hangUpWithResponse(HangUpOptions hangUpOptions, Context context)" + desc: "Hangup a call." + returns: + description: "Response for a successful hangup request." + type: "<Void>" +- uid: "com.azure.communication.callautomation.CallConnection.listParticipants()" + fullName: "com.azure.communication.callautomation.CallConnection.listParticipants()" + name: "listParticipants()" + nameWithType: "CallConnection.listParticipants()" + summary: "Get all participants." + syntax: "public ListParticipantsResult listParticipants()" + desc: "Get all participants." + returns: + description: "Response payload for a successful get call connection request." + type: "" +- uid: "com.azure.communication.callautomation.CallConnection.listParticipantsWithResponse(com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallConnection.listParticipantsWithResponse(Context context)" + name: "listParticipantsWithResponse(Context context)" + nameWithType: "CallConnection.listParticipantsWithResponse(Context context)" + summary: "Get all participants." + parameters: + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response listParticipantsWithResponse(Context context)" + desc: "Get all participants." + returns: + description: "Response payload for a successful get call connection request." + type: "<>" +- uid: "com.azure.communication.callautomation.CallConnection.removeParticipants(java.util.List)" + fullName: "com.azure.communication.callautomation.CallConnection.removeParticipants(List participantsToRemove)" + name: "removeParticipants(List participantsToRemove)" + nameWithType: "CallConnection.removeParticipants(List participantsToRemove)" + summary: "Remove a list of participants from the call." + parameters: + - description: "The identifier list of the participant to be removed." + name: "participantsToRemove" + type: "List<>" + syntax: "public RemoveParticipantsResult removeParticipants(List participantsToRemove)" + desc: "Remove a list of participants from the call." + returns: + description: "Response for a successful add participant request." + type: "" +- uid: "com.azure.communication.callautomation.CallConnection.removeParticipantsWithResponse(com.azure.communication.callautomation.models.RemoveParticipantsOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallConnection.removeParticipantsWithResponse(RemoveParticipantsOptions removeParticipantsOptions, Context context)" + name: "removeParticipantsWithResponse(RemoveParticipantsOptions removeParticipantsOptions, Context context)" + nameWithType: "CallConnection.removeParticipantsWithResponse(RemoveParticipantsOptions removeParticipantsOptions, Context context)" + summary: "Remove a list of participant from the call." + parameters: + - description: "The options for removing participants." + name: "removeParticipantsOptions" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response removeParticipantsWithResponse(RemoveParticipantsOptions removeParticipantsOptions, Context context)" + desc: "Remove a list of participant from the call." + returns: + description: "Response for a successful add participant request." + type: "<>" +- uid: "com.azure.communication.callautomation.CallConnection.transferToParticipantCall(com.azure.communication.common.CommunicationIdentifier)" + fullName: "com.azure.communication.callautomation.CallConnection.transferToParticipantCall(CommunicationIdentifier targetParticipant)" + name: "transferToParticipantCall(CommunicationIdentifier targetParticipant)" + nameWithType: "CallConnection.transferToParticipantCall(CommunicationIdentifier targetParticipant)" + summary: "Transfer the call to a participant." + parameters: + - description: "A representing the target participant of this transfer." + name: "targetParticipant" + type: "" + syntax: "public TransferCallResult transferToParticipantCall(CommunicationIdentifier targetParticipant)" + desc: "Transfer the call to a participant." + returns: + description: "Response payload for a successful call termination request." + type: "" +- uid: "com.azure.communication.callautomation.CallConnection.transferToParticipantCallWithResponse(com.azure.communication.callautomation.models.TransferToParticipantCallOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallConnection.transferToParticipantCallWithResponse(TransferToParticipantCallOptions transferToParticipantCallOptions, Context context)" + name: "transferToParticipantCallWithResponse(TransferToParticipantCallOptions transferToParticipantCallOptions, Context context)" + nameWithType: "CallConnection.transferToParticipantCallWithResponse(TransferToParticipantCallOptions transferToParticipantCallOptions, Context context)" + summary: "Transfer the call to a participant." + parameters: + - description: "Options bag for transferToParticipantCall" + name: "transferToParticipantCallOptions" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response transferToParticipantCallWithResponse(TransferToParticipantCallOptions transferToParticipantCallOptions, Context context)" + desc: "Transfer the call to a participant." + returns: + description: "Response for a successful call termination request." + type: "<>" +type: "class" +desc: "CallConnection for mid-call actions" +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.CallConnectionAsync.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallConnectionAsync.yml new file mode 100644 index 000000000000..8e9cebf02ef5 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallConnectionAsync.yml @@ -0,0 +1,219 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.CallConnectionAsync" +fullName: "com.azure.communication.callautomation.CallConnectionAsync" +name: "CallConnectionAsync" +nameWithType: "CallConnectionAsync" +summary: "CallConnectionAsync for mid-call actions" +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **CallConnectionAsync**" +methods: +- uid: "com.azure.communication.callautomation.CallConnectionAsync.addParticipants(java.util.List)" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.addParticipants(List participants)" + name: "addParticipants(List participants)" + nameWithType: "CallConnectionAsync.addParticipants(List participants)" + summary: "Add a participant to the call." + parameters: + - description: "The list of participants to invite." + name: "participants" + type: "List<>" + syntax: "public Mono addParticipants(List participants)" + desc: "Add a participant to the call." + returns: + description: "Response for a successful add participant request." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.addParticipantsWithResponse(com.azure.communication.callautomation.models.AddParticipantsOptions)" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.addParticipantsWithResponse(AddParticipantsOptions addParticipantsOptions)" + name: "addParticipantsWithResponse(AddParticipantsOptions addParticipantsOptions)" + nameWithType: "CallConnectionAsync.addParticipantsWithResponse(AddParticipantsOptions addParticipantsOptions)" + summary: "Add a participant to the call." + parameters: + - description: "Options bag for addParticipants" + name: "addParticipantsOptions" + type: "" + syntax: "public Mono> addParticipantsWithResponse(AddParticipantsOptions addParticipantsOptions)" + desc: "Add a participant to the call." + returns: + description: "Response for a successful add participant request." + type: "Mono<<>>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.getCallMediaAsync()" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.getCallMediaAsync()" + name: "getCallMediaAsync()" + nameWithType: "CallConnectionAsync.getCallMediaAsync()" + summary: "Returns an object of CallContentAsync" + syntax: "public CallMediaAsync getCallMediaAsync()" + desc: "Returns an object of CallContentAsync" + returns: + description: "a CallContentAsync." + type: "" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.getCallProperties()" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.getCallProperties()" + name: "getCallProperties()" + nameWithType: "CallConnectionAsync.getCallProperties()" + summary: "Get call connection properties." + syntax: "public Mono getCallProperties()" + desc: "Get call connection properties." + returns: + description: "Response payload for a successful get call connection request." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.getCallPropertiesWithResponse()" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.getCallPropertiesWithResponse()" + name: "getCallPropertiesWithResponse()" + nameWithType: "CallConnectionAsync.getCallPropertiesWithResponse()" + summary: "Get call connection properties." + syntax: "public Mono> getCallPropertiesWithResponse()" + desc: "Get call connection properties." + returns: + description: "Response payload for a successful get call connection request." + type: "Mono<<>>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.getParticipant(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.getParticipant(String participantMri)" + name: "getParticipant(String participantMri)" + nameWithType: "CallConnectionAsync.getParticipant(String participantMri)" + summary: "Get a specific participant." + parameters: + - description: "MRI of the participants to retrieve." + name: "participantMri" + type: "String" + syntax: "public Mono getParticipant(String participantMri)" + desc: "Get a specific participant." + returns: + description: "Response payload for a successful get call connection request." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.getParticipantWithResponse(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.getParticipantWithResponse(String participantMri)" + name: "getParticipantWithResponse(String participantMri)" + nameWithType: "CallConnectionAsync.getParticipantWithResponse(String participantMri)" + summary: "Get a specific participant." + parameters: + - description: "MRI of the participants to retrieve." + name: "participantMri" + type: "String" + syntax: "public Mono> getParticipantWithResponse(String participantMri)" + desc: "Get a specific participant." + returns: + description: "Response payload for a successful get call connection request." + type: "Mono<<>>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.hangUp(boolean)" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.hangUp(boolean isForEveryone)" + name: "hangUp(boolean isForEveryone)" + nameWithType: "CallConnectionAsync.hangUp(boolean isForEveryone)" + summary: "Hangup a call." + parameters: + - description: "determine if the call is handed up for all participants." + name: "isForEveryone" + type: "" + syntax: "public Mono hangUp(boolean isForEveryone)" + desc: "Hangup a call." + returns: + description: "Response for a successful hangup request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.hangUpWithResponse(com.azure.communication.callautomation.models.HangUpOptions)" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.hangUpWithResponse(HangUpOptions hangUpOptions)" + name: "hangUpWithResponse(HangUpOptions hangUpOptions)" + nameWithType: "CallConnectionAsync.hangUpWithResponse(HangUpOptions hangUpOptions)" + summary: "Hangup a call." + parameters: + - description: "options to hang up" + name: "hangUpOptions" + type: "" + syntax: "public Mono> hangUpWithResponse(HangUpOptions hangUpOptions)" + desc: "Hangup a call." + returns: + description: "Response for a successful hangup request." + type: "Mono<<Void>>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.listParticipants()" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.listParticipants()" + name: "listParticipants()" + nameWithType: "CallConnectionAsync.listParticipants()" + summary: "Get all participants." + syntax: "public Mono listParticipants()" + desc: "Get all participants." + returns: + description: "Response payload for a successful get call connection request." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.listParticipantsWithResponse()" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.listParticipantsWithResponse()" + name: "listParticipantsWithResponse()" + nameWithType: "CallConnectionAsync.listParticipantsWithResponse()" + summary: "Get all participants." + syntax: "public Mono> listParticipantsWithResponse()" + desc: "Get all participants." + returns: + description: "Response payload for a successful get call connection request." + type: "Mono<<>>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.removeParticipants(java.util.List)" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.removeParticipants(List participantsToRemove)" + name: "removeParticipants(List participantsToRemove)" + nameWithType: "CallConnectionAsync.removeParticipants(List participantsToRemove)" + summary: "Remove a list of participants from the call." + parameters: + - description: "The identifier list of the participant to be removed." + name: "participantsToRemove" + type: "List<>" + syntax: "public Mono removeParticipants(List participantsToRemove)" + desc: "Remove a list of participants from the call." + returns: + description: "Response for a successful add participant request." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.removeParticipantsWithResponse(com.azure.communication.callautomation.models.RemoveParticipantsOptions)" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.removeParticipantsWithResponse(RemoveParticipantsOptions removeParticipantsOptions)" + name: "removeParticipantsWithResponse(RemoveParticipantsOptions removeParticipantsOptions)" + nameWithType: "CallConnectionAsync.removeParticipantsWithResponse(RemoveParticipantsOptions removeParticipantsOptions)" + summary: "Remove a list of participants from the call." + parameters: + - description: "The options for removing participants." + name: "removeParticipantsOptions" + type: "" + syntax: "public Mono> removeParticipantsWithResponse(RemoveParticipantsOptions removeParticipantsOptions)" + desc: "Remove a list of participants from the call." + returns: + description: "Response for a successful add participant request." + type: "Mono<<>>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.transferToParticipantCall(com.azure.communication.common.CommunicationIdentifier)" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.transferToParticipantCall(CommunicationIdentifier targetParticipant)" + name: "transferToParticipantCall(CommunicationIdentifier targetParticipant)" + nameWithType: "CallConnectionAsync.transferToParticipantCall(CommunicationIdentifier targetParticipant)" + summary: "Transfer the call to a participant." + parameters: + - description: "A representing the target participant of this transfer." + name: "targetParticipant" + type: "" + syntax: "public Mono transferToParticipantCall(CommunicationIdentifier targetParticipant)" + desc: "Transfer the call to a participant." + returns: + description: "Response payload for a successful call termination request." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallConnectionAsync.transferToParticipantCallWithResponse(com.azure.communication.callautomation.models.TransferToParticipantCallOptions)" + fullName: "com.azure.communication.callautomation.CallConnectionAsync.transferToParticipantCallWithResponse(TransferToParticipantCallOptions transferToParticipantCallOptions)" + name: "transferToParticipantCallWithResponse(TransferToParticipantCallOptions transferToParticipantCallOptions)" + nameWithType: "CallConnectionAsync.transferToParticipantCallWithResponse(TransferToParticipantCallOptions transferToParticipantCallOptions)" + summary: "Transfer the call to a participant." + parameters: + - description: "Options bag for transferToParticipantCall" + name: "transferToParticipantCallOptions" + type: "" + syntax: "public Mono> transferToParticipantCallWithResponse(TransferToParticipantCallOptions transferToParticipantCallOptions)" + desc: "Transfer the call to a participant." + returns: + description: "Response for a successful call termination request." + type: "Mono<<>>" +type: "class" +desc: "CallConnectionAsync for mid-call actions" +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.CallMedia.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallMedia.yml new file mode 100644 index 000000000000..6e801286bc96 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallMedia.yml @@ -0,0 +1,146 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.CallMedia" +fullName: "com.azure.communication.callautomation.CallMedia" +name: "CallMedia" +nameWithType: "CallMedia" +summary: "CallContent." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **CallMedia**" +methods: +- uid: "com.azure.communication.callautomation.CallMedia.cancelAllMediaOperations()" + fullName: "com.azure.communication.callautomation.CallMedia.cancelAllMediaOperations()" + name: "cancelAllMediaOperations()" + nameWithType: "CallMedia.cancelAllMediaOperations()" + summary: "Cancels all the queued media operations." + syntax: "public void cancelAllMediaOperations()" + desc: "Cancels all the queued media operations." +- uid: "com.azure.communication.callautomation.CallMedia.cancelAllMediaOperationsWithResponse(com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallMedia.cancelAllMediaOperationsWithResponse(Context context)" + name: "cancelAllMediaOperationsWithResponse(Context context)" + nameWithType: "CallMedia.cancelAllMediaOperationsWithResponse(Context context)" + summary: "Cancels all the queued media operations" + parameters: + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response cancelAllMediaOperationsWithResponse(Context context)" + desc: "Cancels all the queued media operations" + returns: + description: "Response for successful playAll request." + type: "<Void>" +- uid: "com.azure.communication.callautomation.CallMedia.play(com.azure.communication.callautomation.models.PlaySource,java.util.List)" + fullName: "com.azure.communication.callautomation.CallMedia.play(PlaySource playSource, List playTo)" + name: "play(PlaySource playSource, List playTo)" + nameWithType: "CallMedia.play(PlaySource playSource, List playTo)" + summary: "Play" + parameters: + - description: "A representing the source to play." + name: "playSource" + type: "" + - description: "the targets to play to." + name: "playTo" + type: "List<>" + syntax: "public void play(PlaySource playSource, List playTo)" + desc: "Play" +- uid: "com.azure.communication.callautomation.CallMedia.playToAll(com.azure.communication.callautomation.models.PlaySource)" + fullName: "com.azure.communication.callautomation.CallMedia.playToAll(PlaySource playSource)" + name: "playToAll(PlaySource playSource)" + nameWithType: "CallMedia.playToAll(PlaySource playSource)" + summary: "Play to all participants" + parameters: + - description: "A representing the source to play." + name: "playSource" + type: "" + syntax: "public void playToAll(PlaySource playSource)" + desc: "Play to all participants" +- uid: "com.azure.communication.callautomation.CallMedia.playToAllWithResponse(com.azure.communication.callautomation.models.PlaySource,com.azure.communication.callautomation.models.PlayOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallMedia.playToAllWithResponse(PlaySource playSource, PlayOptions options, Context context)" + name: "playToAllWithResponse(PlaySource playSource, PlayOptions options, Context context)" + nameWithType: "CallMedia.playToAllWithResponse(PlaySource playSource, PlayOptions options, Context context)" + summary: "PlayAllWithResponse" + parameters: + - description: "A representing the source to play." + name: "playSource" + type: "" + - description: "play options." + name: "options" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response playToAllWithResponse(PlaySource playSource, PlayOptions options, Context context)" + desc: "PlayAllWithResponse" + returns: + description: "Response for successful playAll request." + type: "<Void>" +- uid: "com.azure.communication.callautomation.CallMedia.playWithResponse(com.azure.communication.callautomation.models.PlaySource,java.util.List,com.azure.communication.callautomation.models.PlayOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallMedia.playWithResponse(PlaySource playSource, List playTo, PlayOptions options, Context context)" + name: "playWithResponse(PlaySource playSource, List playTo, PlayOptions options, Context context)" + nameWithType: "CallMedia.playWithResponse(PlaySource playSource, List playTo, PlayOptions options, Context context)" + summary: "PlayWithResponse" + parameters: + - description: "A representing the source to play." + name: "playSource" + type: "" + - description: "the targets to play to." + name: "playTo" + type: "List<>" + - description: "play options." + name: "options" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response playWithResponse(PlaySource playSource, List playTo, PlayOptions options, Context context)" + desc: "PlayWithResponse" + returns: + description: "Response for successful play request." + type: "<Void>" +- uid: "com.azure.communication.callautomation.CallMedia.startRecognizing(com.azure.communication.callautomation.models.CallMediaRecognizeOptions)" + fullName: "com.azure.communication.callautomation.CallMedia.startRecognizing(CallMediaRecognizeOptions callMediaRecognizeOptions)" + name: "startRecognizing(CallMediaRecognizeOptions callMediaRecognizeOptions)" + nameWithType: "CallMedia.startRecognizing(CallMediaRecognizeOptions callMediaRecognizeOptions)" + summary: "Recognize tones." + parameters: + - description: "Optional elements for recognize." + name: "callMediaRecognizeOptions" + type: "" + syntax: "public void startRecognizing(CallMediaRecognizeOptions callMediaRecognizeOptions)" + desc: "Recognize tones." +- uid: "com.azure.communication.callautomation.CallMedia.startRecognizingWithResponse(com.azure.communication.callautomation.models.CallMediaRecognizeOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallMedia.startRecognizingWithResponse(CallMediaRecognizeOptions callMediaRecognizeOptions, Context context)" + name: "startRecognizingWithResponse(CallMediaRecognizeOptions callMediaRecognizeOptions, Context context)" + nameWithType: "CallMedia.startRecognizingWithResponse(CallMediaRecognizeOptions callMediaRecognizeOptions, Context context)" + summary: "Recognize tones." + parameters: + - description: "Optional elements for recognize." + name: "callMediaRecognizeOptions" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response startRecognizingWithResponse(CallMediaRecognizeOptions callMediaRecognizeOptions, Context context)" + desc: "Recognize tones." + returns: + description: "Response for a successful recognize request." + type: "<Void>" +type: "class" +desc: "CallContent." +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.CallMediaAsync.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallMediaAsync.yml new file mode 100644 index 000000000000..a1f0687f7fe5 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallMediaAsync.yml @@ -0,0 +1,145 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.CallMediaAsync" +fullName: "com.azure.communication.callautomation.CallMediaAsync" +name: "CallMediaAsync" +nameWithType: "CallMediaAsync" +summary: "CallContent." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **CallMediaAsync**" +methods: +- uid: "com.azure.communication.callautomation.CallMediaAsync.cancelAllMediaOperations()" + fullName: "com.azure.communication.callautomation.CallMediaAsync.cancelAllMediaOperations()" + name: "cancelAllMediaOperations()" + nameWithType: "CallMediaAsync.cancelAllMediaOperations()" + summary: "Cancels all the queued media operations." + syntax: "public Mono cancelAllMediaOperations()" + desc: "Cancels all the queued media operations." + returns: + description: "Void" + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallMediaAsync.cancelAllMediaOperationsWithResponse()" + fullName: "com.azure.communication.callautomation.CallMediaAsync.cancelAllMediaOperationsWithResponse()" + name: "cancelAllMediaOperationsWithResponse()" + nameWithType: "CallMediaAsync.cancelAllMediaOperationsWithResponse()" + summary: "Cancels all the queued media operations" + syntax: "public Mono> cancelAllMediaOperationsWithResponse()" + desc: "Cancels all the queued media operations" + returns: + description: "Response for successful playAll request." + type: "Mono<<Void>>" +- uid: "com.azure.communication.callautomation.CallMediaAsync.play(com.azure.communication.callautomation.models.PlaySource,java.util.List)" + fullName: "com.azure.communication.callautomation.CallMediaAsync.play(PlaySource playSource, List playTo)" + name: "play(PlaySource playSource, List playTo)" + nameWithType: "CallMediaAsync.play(PlaySource playSource, List playTo)" + summary: "Play" + parameters: + - description: "A representing the source to play." + name: "playSource" + type: "" + - description: "the targets to play to" + name: "playTo" + type: "List<>" + syntax: "public Mono play(PlaySource playSource, List playTo)" + desc: "Play" + returns: + description: "Void for successful play request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallMediaAsync.playToAll(com.azure.communication.callautomation.models.PlaySource)" + fullName: "com.azure.communication.callautomation.CallMediaAsync.playToAll(PlaySource playSource)" + name: "playToAll(PlaySource playSource)" + nameWithType: "CallMediaAsync.playToAll(PlaySource playSource)" + summary: "Play to all participants" + parameters: + - description: "A representing the source to play." + name: "playSource" + type: "" + syntax: "public Mono playToAll(PlaySource playSource)" + desc: "Play to all participants" + returns: + description: "Void for successful playAll request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallMediaAsync.playToAllWithResponse(com.azure.communication.callautomation.models.PlaySource,com.azure.communication.callautomation.models.PlayOptions)" + fullName: "com.azure.communication.callautomation.CallMediaAsync.playToAllWithResponse(PlaySource playSource, PlayOptions options)" + name: "playToAllWithResponse(PlaySource playSource, PlayOptions options)" + nameWithType: "CallMediaAsync.playToAllWithResponse(PlaySource playSource, PlayOptions options)" + summary: "Play to all participants" + parameters: + - description: "A representing the source to play." + name: "playSource" + type: "" + - description: "play options." + name: "options" + type: "" + syntax: "public Mono> playToAllWithResponse(PlaySource playSource, PlayOptions options)" + desc: "Play to all participants" + returns: + description: "Response for successful playAll request." + type: "Mono<<Void>>" +- uid: "com.azure.communication.callautomation.CallMediaAsync.playWithResponse(com.azure.communication.callautomation.models.PlaySource,java.util.List,com.azure.communication.callautomation.models.PlayOptions)" + fullName: "com.azure.communication.callautomation.CallMediaAsync.playWithResponse(PlaySource playSource, List playTo, PlayOptions options)" + name: "playWithResponse(PlaySource playSource, List playTo, PlayOptions options)" + nameWithType: "CallMediaAsync.playWithResponse(PlaySource playSource, List playTo, PlayOptions options)" + summary: "Play" + parameters: + - description: "A representing the source to play." + name: "playSource" + type: "" + - description: "the targets to play to" + name: "playTo" + type: "List<>" + - description: "play options." + name: "options" + type: "" + syntax: "public Mono> playWithResponse(PlaySource playSource, List playTo, PlayOptions options)" + desc: "Play" + returns: + description: "Response for successful play request." + type: "Mono<<Void>>" +- uid: "com.azure.communication.callautomation.CallMediaAsync.startRecognizing(com.azure.communication.callautomation.models.CallMediaRecognizeOptions)" + fullName: "com.azure.communication.callautomation.CallMediaAsync.startRecognizing(CallMediaRecognizeOptions recognizeOptions)" + name: "startRecognizing(CallMediaRecognizeOptions recognizeOptions)" + nameWithType: "CallMediaAsync.startRecognizing(CallMediaRecognizeOptions recognizeOptions)" + summary: "Recognize operation." + parameters: + - description: "Different attributes for recognize." + name: "recognizeOptions" + type: "" + syntax: "public Mono startRecognizing(CallMediaRecognizeOptions recognizeOptions)" + desc: "Recognize operation." + returns: + description: "Response for successful recognize request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallMediaAsync.startRecognizingWithResponse(com.azure.communication.callautomation.models.CallMediaRecognizeOptions)" + fullName: "com.azure.communication.callautomation.CallMediaAsync.startRecognizingWithResponse(CallMediaRecognizeOptions recognizeOptions)" + name: "startRecognizingWithResponse(CallMediaRecognizeOptions recognizeOptions)" + nameWithType: "CallMediaAsync.startRecognizingWithResponse(CallMediaRecognizeOptions recognizeOptions)" + summary: "Recognize operation" + parameters: + - description: "Different attributes for recognize." + name: "recognizeOptions" + type: "" + syntax: "public Mono> startRecognizingWithResponse(CallMediaRecognizeOptions recognizeOptions)" + desc: "Recognize operation" + returns: + description: "Response for successful recognize request." + type: "Mono<<Void>>" +type: "class" +desc: "CallContent." +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.CallRecording.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallRecording.yml new file mode 100644 index 000000000000..daec3298ad7e --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallRecording.yml @@ -0,0 +1,311 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.CallRecording" +fullName: "com.azure.communication.callautomation.CallRecording" +name: "CallRecording" +nameWithType: "CallRecording" +summary: "CallRecording." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **CallRecording**" +methods: +- uid: "com.azure.communication.callautomation.CallRecording.deleteRecording(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecording.deleteRecording(String deleteEndpoint)" + name: "deleteRecording(String deleteEndpoint)" + nameWithType: "CallRecording.deleteRecording(String deleteEndpoint)" + summary: "Delete the content located in the deleteEndpoint" + parameters: + - description: "- ACS URL where the content is located." + name: "deleteEndpoint" + type: "String" + syntax: "public void deleteRecording(String deleteEndpoint)" + desc: "Delete the content located in the deleteEndpoint" +- uid: "com.azure.communication.callautomation.CallRecording.deleteRecordingWithResponse(java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallRecording.deleteRecordingWithResponse(String deleteEndpoint, Context context)" + name: "deleteRecordingWithResponse(String deleteEndpoint, Context context)" + nameWithType: "CallRecording.deleteRecordingWithResponse(String deleteEndpoint, Context context)" + summary: "Delete the content located in the deleteEndpoint" + parameters: + - description: "- ACS URL where the content is located." + name: "deleteEndpoint" + type: "String" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response deleteRecordingWithResponse(String deleteEndpoint, Context context)" + desc: "Delete the content located in the deleteEndpoint" + returns: + description: "Response for successful delete request.." + type: "<Void>" +- uid: "com.azure.communication.callautomation.CallRecording.downloadContent(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecording.downloadContent(String sourceEndpoint)" + name: "downloadContent(String sourceEndpoint)" + nameWithType: "CallRecording.downloadContent(String sourceEndpoint)" + summary: "Downloads the entire content." + parameters: + - description: "- ACS URL where the content is located." + name: "sourceEndpoint" + type: "String" + syntax: "public BinaryData downloadContent(String sourceEndpoint)" + desc: "Downloads the entire content.\n\nThis method supports downloads up to 2GB of data. Use to download larger blobs." + returns: + description: "The content of the blob." + type: "" +- uid: "com.azure.communication.callautomation.CallRecording.downloadContentWithResponse(java.lang.String,com.azure.core.http.HttpRange,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallRecording.downloadContentWithResponse(String sourceEndpoint, HttpRange range, Context context)" + name: "downloadContentWithResponse(String sourceEndpoint, HttpRange range, Context context)" + nameWithType: "CallRecording.downloadContentWithResponse(String sourceEndpoint, HttpRange range, Context context)" + summary: "Downloads the entire content." + parameters: + - description: "ACS URL where the content is located." + name: "sourceEndpoint" + type: "String" + - description: "An optional value containing the range of bytes to download. If missing,\n the whole content will be downloaded." + name: "range" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response downloadContentWithResponse(String sourceEndpoint, HttpRange range, Context context)" + desc: "Downloads the entire content.\n\nThis method supports downloads up to 2GB of data. Use to download larger blobs." + returns: + description: "The content of the blob." + type: "<>" +- uid: "com.azure.communication.callautomation.CallRecording.downloadTo(java.lang.String,java.io.OutputStream)" + fullName: "com.azure.communication.callautomation.CallRecording.downloadTo(String sourceEndpoint, OutputStream destinationStream)" + name: "downloadTo(String sourceEndpoint, OutputStream destinationStream)" + nameWithType: "CallRecording.downloadTo(String sourceEndpoint, OutputStream destinationStream)" + summary: "Download the recording content, e.g." + parameters: + - description: "- ACS URL where the content is located." + name: "sourceEndpoint" + type: "String" + - description: "- A stream where to write the downloaded content." + name: "destinationStream" + type: "OutputStream" + syntax: "public void downloadTo(String sourceEndpoint, OutputStream destinationStream)" + desc: "Download the recording content, e.g. Recording's metadata, Recording video, etc., from `endpoint` and write it in the passed as parameter." +- uid: "com.azure.communication.callautomation.CallRecording.downloadTo(java.lang.String,java.nio.file.Path)" + fullName: "com.azure.communication.callautomation.CallRecording.downloadTo(String sourceEndpoint, Path destinationPath)" + name: "downloadTo(String sourceEndpoint, Path destinationPath)" + nameWithType: "CallRecording.downloadTo(String sourceEndpoint, Path destinationPath)" + summary: "Download the content located in `endpoint` into a file marked by `path`." + parameters: + - description: "- ACS URL where the content is located." + name: "sourceEndpoint" + type: "String" + - description: "- File location." + name: "destinationPath" + type: "Path" + syntax: "public void downloadTo(String sourceEndpoint, Path destinationPath)" + desc: "Download the content located in `endpoint` into a file marked by `path`. This download will be done using parallel workers." +- uid: "com.azure.communication.callautomation.CallRecording.downloadToWithResponse(java.lang.String,java.io.OutputStream,com.azure.core.http.HttpRange,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallRecording.downloadToWithResponse(String sourceEndpoint, OutputStream destinationStream, HttpRange httpRange, Context context)" + name: "downloadToWithResponse(String sourceEndpoint, OutputStream destinationStream, HttpRange httpRange, Context context)" + nameWithType: "CallRecording.downloadToWithResponse(String sourceEndpoint, OutputStream destinationStream, HttpRange httpRange, Context context)" + summary: "Download the recording content, e.g." + parameters: + - description: "- ACS URL where the content is located." + name: "sourceEndpoint" + type: "String" + - description: "- A stream where to write the downloaded content." + name: "destinationStream" + type: "OutputStream" + - description: "- An optional value containing the range of bytes to download. If missing,\n the whole content will be downloaded." + name: "httpRange" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response downloadToWithResponse(String sourceEndpoint, OutputStream destinationStream, HttpRange httpRange, Context context)" + desc: "Download the recording content, e.g. Recording's metadata, Recording video, etc., from `endpoint` and write it in the passed as parameter." + returns: + description: "Response containing the http response information from the download." + type: "<Void>" +- uid: "com.azure.communication.callautomation.CallRecording.downloadToWithResponse(java.lang.String,java.nio.file.Path,com.azure.communication.callautomation.models.DownloadToFileOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallRecording.downloadToWithResponse(String sourceEndpoint, Path destinationPath, DownloadToFileOptions options, Context context)" + name: "downloadToWithResponse(String sourceEndpoint, Path destinationPath, DownloadToFileOptions options, Context context)" + nameWithType: "CallRecording.downloadToWithResponse(String sourceEndpoint, Path destinationPath, DownloadToFileOptions options, Context context)" + summary: "Download the content located in `endpoint` into a file marked by `path`." + parameters: + - description: "- ACS URL where the content is located." + name: "sourceEndpoint" + type: "String" + - description: "- File location." + name: "destinationPath" + type: "Path" + - description: "- an optional object to modify how the\n download will work." + name: "options" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response downloadToWithResponse(String sourceEndpoint, Path destinationPath, DownloadToFileOptions options, Context context)" + desc: "Download the content located in `endpoint` into a file marked by `path`. This download will be done using parallel workers." + returns: + description: "Response containing the http response information from the download." + type: "<Void>" +- uid: "com.azure.communication.callautomation.CallRecording.getRecordingState(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecording.getRecordingState(String recordingId)" + name: "getRecordingState(String recordingId)" + nameWithType: "CallRecording.getRecordingState(String recordingId)" + summary: "Get the current recording state by recording id." + parameters: + - description: "The recording id to stop." + name: "recordingId" + type: "String" + syntax: "public RecordingStateResult getRecordingState(String recordingId)" + desc: "Get the current recording state by recording id." + returns: + description: "Response for a successful get recording state request." + type: "" +- uid: "com.azure.communication.callautomation.CallRecording.getRecordingStateWithResponse(java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallRecording.getRecordingStateWithResponse(String recordingId, Context context)" + name: "getRecordingStateWithResponse(String recordingId, Context context)" + nameWithType: "CallRecording.getRecordingStateWithResponse(String recordingId, Context context)" + summary: "Get the current recording state by recording id." + parameters: + - description: "The recording id to stop." + name: "recordingId" + type: "String" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response getRecordingStateWithResponse(String recordingId, Context context)" + desc: "Get the current recording state by recording id." + returns: + description: "Response for a successful get recording state request." + type: "<>" +- uid: "com.azure.communication.callautomation.CallRecording.pauseRecording(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecording.pauseRecording(String recordingId)" + name: "pauseRecording(String recordingId)" + nameWithType: "CallRecording.pauseRecording(String recordingId)" + summary: "Pause recording of the call." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + syntax: "public void pauseRecording(String recordingId)" + desc: "Pause recording of the call." +- uid: "com.azure.communication.callautomation.CallRecording.pauseRecordingWithResponse(java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallRecording.pauseRecordingWithResponse(String recordingId, Context context)" + name: "pauseRecordingWithResponse(String recordingId, Context context)" + nameWithType: "CallRecording.pauseRecordingWithResponse(String recordingId, Context context)" + summary: "Pause recording of the call." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response pauseRecordingWithResponse(String recordingId, Context context)" + desc: "Pause recording of the call." + returns: + description: "Response for a successful pause recording request." + type: "<Void>" +- uid: "com.azure.communication.callautomation.CallRecording.resumeRecording(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecording.resumeRecording(String recordingId)" + name: "resumeRecording(String recordingId)" + nameWithType: "CallRecording.resumeRecording(String recordingId)" + summary: "Resume recording of the call." + parameters: + - description: "The recording id to stop." + name: "recordingId" + type: "String" + syntax: "public void resumeRecording(String recordingId)" + desc: "Resume recording of the call." +- uid: "com.azure.communication.callautomation.CallRecording.resumeRecordingWithResponse(java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallRecording.resumeRecordingWithResponse(String recordingId, Context context)" + name: "resumeRecordingWithResponse(String recordingId, Context context)" + nameWithType: "CallRecording.resumeRecordingWithResponse(String recordingId, Context context)" + summary: "Resume recording of the call." + parameters: + - description: "The recording id to stop." + name: "recordingId" + type: "String" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response resumeRecordingWithResponse(String recordingId, Context context)" + desc: "Resume recording of the call." + returns: + description: "Response for a successful resume recording request." + type: "<Void>" +- uid: "com.azure.communication.callautomation.CallRecording.startRecording(com.azure.communication.callautomation.models.StartRecordingOptions)" + fullName: "com.azure.communication.callautomation.CallRecording.startRecording(StartRecordingOptions options)" + name: "startRecording(StartRecordingOptions options)" + nameWithType: "CallRecording.startRecording(StartRecordingOptions options)" + summary: "Start recording of the call." + parameters: + - description: "A object containing different options for recording." + name: "options" + type: "" + syntax: "public RecordingStateResult startRecording(StartRecordingOptions options)" + desc: "Start recording of the call." + returns: + description: "Result for a successful start recording request." + type: "" +- uid: "com.azure.communication.callautomation.CallRecording.startRecordingWithResponse(com.azure.communication.callautomation.models.StartRecordingOptions,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallRecording.startRecordingWithResponse(StartRecordingOptions options, Context context)" + name: "startRecordingWithResponse(StartRecordingOptions options, Context context)" + nameWithType: "CallRecording.startRecordingWithResponse(StartRecordingOptions options, Context context)" + summary: "Start recording of the call." + parameters: + - description: "A object containing different options for recording." + name: "options" + type: "" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response startRecordingWithResponse(StartRecordingOptions options, Context context)" + desc: "Start recording of the call." + returns: + description: "Result for a successful start recording request." + type: "<>" +- uid: "com.azure.communication.callautomation.CallRecording.stopRecording(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecording.stopRecording(String recordingId)" + name: "stopRecording(String recordingId)" + nameWithType: "CallRecording.stopRecording(String recordingId)" + summary: "Stop recording of the call." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + syntax: "public void stopRecording(String recordingId)" + desc: "Stop recording of the call." +- uid: "com.azure.communication.callautomation.CallRecording.stopRecordingWithResponse(java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.communication.callautomation.CallRecording.stopRecordingWithResponse(String recordingId, Context context)" + name: "stopRecordingWithResponse(String recordingId, Context context)" + nameWithType: "CallRecording.stopRecordingWithResponse(String recordingId, Context context)" + summary: "Stop recording of the call." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + - description: "A representing the request context." + name: "context" + type: "" + syntax: "public Response stopRecordingWithResponse(String recordingId, Context context)" + desc: "Stop recording of the call." + returns: + description: "Response for a successful stop recording request." + type: "<Void>" +type: "class" +desc: "CallRecording." +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.CallRecordingAsync.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallRecordingAsync.yml new file mode 100644 index 000000000000..e0368386dbb1 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallRecordingAsync.yml @@ -0,0 +1,296 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.CallRecordingAsync" +fullName: "com.azure.communication.callautomation.CallRecordingAsync" +name: "CallRecordingAsync" +nameWithType: "CallRecordingAsync" +summary: "CallRecordingAsync." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **CallRecordingAsync**" +methods: +- uid: "com.azure.communication.callautomation.CallRecordingAsync.deleteRecording(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.deleteRecording(String deleteEndpoint)" + name: "deleteRecording(String deleteEndpoint)" + nameWithType: "CallRecordingAsync.deleteRecording(String deleteEndpoint)" + summary: "Delete the content located at the deleteEndpoint" + parameters: + - description: "- ACS URL where the content is located." + name: "deleteEndpoint" + type: "String" + syntax: "public Mono deleteRecording(String deleteEndpoint)" + desc: "Delete the content located at the deleteEndpoint" + returns: + description: "Response for successful delete request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.deleteRecordingWithResponse(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.deleteRecordingWithResponse(String deleteEndpoint)" + name: "deleteRecordingWithResponse(String deleteEndpoint)" + nameWithType: "CallRecordingAsync.deleteRecordingWithResponse(String deleteEndpoint)" + summary: "Delete the content located at the deleteEndpoint Recording deletion will be done using parallel workers." + parameters: + - description: "- ACS URL where the content is located." + name: "deleteEndpoint" + type: "String" + syntax: "public Mono> deleteRecordingWithResponse(String deleteEndpoint)" + desc: "Delete the content located at the deleteEndpoint Recording deletion will be done using parallel workers." + returns: + description: "Response for successful delete request." + type: "Mono<<Void>>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.downloadContent(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.downloadContent(String sourceEndpoint)" + name: "downloadContent(String sourceEndpoint)" + nameWithType: "CallRecordingAsync.downloadContent(String sourceEndpoint)" + summary: "Reads the entire content." + parameters: + - description: "- URL where the content is located." + name: "sourceEndpoint" + type: "String" + syntax: "public Mono downloadContent(String sourceEndpoint)" + desc: "Reads the entire content.\n\n**Code Samples**\n\nThis method supports downloads up to 2GB of data. Use ()\\} to download larger blobs." + returns: + description: "A reactive response containing the content data." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.downloadContentWithResponse(java.lang.String,com.azure.core.http.HttpRange)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.downloadContentWithResponse(String sourceEndpoint, HttpRange range)" + name: "downloadContentWithResponse(String sourceEndpoint, HttpRange range)" + nameWithType: "CallRecordingAsync.downloadContentWithResponse(String sourceEndpoint, HttpRange range)" + summary: "Reads a range of bytes from a content." + parameters: + - description: "- URL where the content is located." + name: "sourceEndpoint" + type: "String" + - description: "- An optional value containing the range of bytes to download. If missing,\n the whole content will be downloaded." + name: "range" + type: "" + syntax: "public Mono> downloadContentWithResponse(String sourceEndpoint, HttpRange range)" + desc: "Reads a range of bytes from a content.\n\nThis method supports downloads up to 2GB of data. Use to download larger blobs." + returns: + description: "A reactive response containing the blob data." + type: "Mono<<>>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.downloadStream(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.downloadStream(String sourceEndpoint)" + name: "downloadStream(String sourceEndpoint)" + nameWithType: "CallRecordingAsync.downloadStream(String sourceEndpoint)" + summary: "Download the recording content, e.g." + parameters: + - description: "- URL where the content is located." + name: "sourceEndpoint" + type: "String" + syntax: "public Flux downloadStream(String sourceEndpoint)" + desc: "Download the recording content, e.g. Recording's metadata, Recording video, from the ACS endpoint passed as parameter." + returns: + description: "A object containing the byte stream of the content requested." + type: "Flux<ByteBuffer>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.downloadStreamWithResponse(java.lang.String,com.azure.core.http.HttpRange)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.downloadStreamWithResponse(String sourceEndpoint, HttpRange range)" + name: "downloadStreamWithResponse(String sourceEndpoint, HttpRange range)" + nameWithType: "CallRecordingAsync.downloadStreamWithResponse(String sourceEndpoint, HttpRange range)" + summary: "Download the recording content, (e.g." + parameters: + - description: "- URL where the content is located." + name: "sourceEndpoint" + type: "String" + - description: "- An optional value containing the range of bytes to download. If missing,\n the whole content will be downloaded." + name: "range" + type: "" + syntax: "public Mono>> downloadStreamWithResponse(String sourceEndpoint, HttpRange range)" + desc: "Download the recording content, (e.g. Recording's metadata, Recording video, etc.) from the `endpoint`." + returns: + description: "A object containing a with the byte stream of the content requested." + type: "Mono<<Flux<ByteBuffer>>>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.downloadTo(java.lang.String,java.nio.file.Path)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.downloadTo(String sourceEndpoint, Path destinationPath)" + name: "downloadTo(String sourceEndpoint, Path destinationPath)" + nameWithType: "CallRecordingAsync.downloadTo(String sourceEndpoint, Path destinationPath)" + summary: "Download the content located in `endpoint` into a file marked by `path`." + parameters: + - description: "- ACS URL where the content is located." + name: "sourceEndpoint" + type: "String" + - description: "- File location." + name: "destinationPath" + type: "Path" + syntax: "public Mono downloadTo(String sourceEndpoint, Path destinationPath)" + desc: "Download the content located in `endpoint` into a file marked by `path`. This download will be done using parallel workers." + returns: + description: "Response for a successful downloadTo request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.downloadToWithResponse(java.lang.String,java.nio.file.Path,com.azure.communication.callautomation.models.DownloadToFileOptions)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.downloadToWithResponse(String sourceEndpoint, Path destinationPath, DownloadToFileOptions options)" + name: "downloadToWithResponse(String sourceEndpoint, Path destinationPath, DownloadToFileOptions options)" + nameWithType: "CallRecordingAsync.downloadToWithResponse(String sourceEndpoint, Path destinationPath, DownloadToFileOptions options)" + summary: "Download the content located in `endpoint` into a file marked by `path`." + parameters: + - description: "- ACS URL where the content is located." + name: "sourceEndpoint" + type: "String" + - description: "- File location." + name: "destinationPath" + type: "Path" + - description: "- an optional object to modify how the\n download will work." + name: "options" + type: "" + syntax: "public Mono> downloadToWithResponse(String sourceEndpoint, Path destinationPath, DownloadToFileOptions options)" + desc: "Download the content located in `endpoint` into a file marked by `path`. This download will be done using parallel workers." + returns: + description: "Response containing the http response information from the download." + type: "Mono<<Void>>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.getRecordingState(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.getRecordingState(String recordingId)" + name: "getRecordingState(String recordingId)" + nameWithType: "CallRecordingAsync.getRecordingState(String recordingId)" + summary: "Get current recording state by recording id." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + syntax: "public Mono getRecordingState(String recordingId)" + desc: "Get current recording state by recording id." + returns: + description: "Response for a successful get recording state request." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.getRecordingStateWithResponse(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.getRecordingStateWithResponse(String recordingId)" + name: "getRecordingStateWithResponse(String recordingId)" + nameWithType: "CallRecordingAsync.getRecordingStateWithResponse(String recordingId)" + summary: "Get current recording state by recording id." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + syntax: "public Mono> getRecordingStateWithResponse(String recordingId)" + desc: "Get current recording state by recording id." + returns: + description: "Response for a successful get recording state request." + type: "Mono<<>>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.pauseRecording(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.pauseRecording(String recordingId)" + name: "pauseRecording(String recordingId)" + nameWithType: "CallRecordingAsync.pauseRecording(String recordingId)" + summary: "Pause recording of the call." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + syntax: "public Mono pauseRecording(String recordingId)" + desc: "Pause recording of the call." + returns: + description: "Response for a successful pause recording request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.pauseRecordingWithResponse(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.pauseRecordingWithResponse(String recordingId)" + name: "pauseRecordingWithResponse(String recordingId)" + nameWithType: "CallRecordingAsync.pauseRecordingWithResponse(String recordingId)" + summary: "Pause recording of the call." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + syntax: "public Mono> pauseRecordingWithResponse(String recordingId)" + desc: "Pause recording of the call." + returns: + description: "Response for a successful pause recording request." + type: "Mono<<Void>>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.resumeRecording(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.resumeRecording(String recordingId)" + name: "resumeRecording(String recordingId)" + nameWithType: "CallRecordingAsync.resumeRecording(String recordingId)" + summary: "Resume recording of the call." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + syntax: "public Mono resumeRecording(String recordingId)" + desc: "Resume recording of the call." + returns: + description: "response for a successful resume recording request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.resumeRecordingWithResponse(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.resumeRecordingWithResponse(String recordingId)" + name: "resumeRecordingWithResponse(String recordingId)" + nameWithType: "CallRecordingAsync.resumeRecordingWithResponse(String recordingId)" + summary: "Resume recording of the call." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + syntax: "public Mono> resumeRecordingWithResponse(String recordingId)" + desc: "Resume recording of the call." + returns: + description: "response for a successful resume recording request." + type: "Mono<<Void>>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.startRecording(com.azure.communication.callautomation.models.StartRecordingOptions)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.startRecording(StartRecordingOptions options)" + name: "startRecording(StartRecordingOptions options)" + nameWithType: "CallRecordingAsync.startRecording(StartRecordingOptions options)" + summary: "Start recording of the call." + parameters: + - description: "A object containing different options for recording." + name: "options" + type: "" + syntax: "public Mono startRecording(StartRecordingOptions options)" + desc: "Start recording of the call." + returns: + description: "Response for a successful start recording request." + type: "Mono<>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.startRecordingWithResponse(com.azure.communication.callautomation.models.StartRecordingOptions)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.startRecordingWithResponse(StartRecordingOptions options)" + name: "startRecordingWithResponse(StartRecordingOptions options)" + nameWithType: "CallRecordingAsync.startRecordingWithResponse(StartRecordingOptions options)" + summary: "Start recording of the call." + parameters: + - description: "A object containing different options for recording." + name: "options" + type: "" + syntax: "public Mono> startRecordingWithResponse(StartRecordingOptions options)" + desc: "Start recording of the call." + returns: + description: "Response for a successful start recording request." + type: "Mono<<>>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.stopRecording(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.stopRecording(String recordingId)" + name: "stopRecording(String recordingId)" + nameWithType: "CallRecordingAsync.stopRecording(String recordingId)" + summary: "Stop recording of the call." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + syntax: "public Mono stopRecording(String recordingId)" + desc: "Stop recording of the call." + returns: + description: "Response for a successful stop recording request." + type: "Mono<Void>" +- uid: "com.azure.communication.callautomation.CallRecordingAsync.stopRecordingWithResponse(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallRecordingAsync.stopRecordingWithResponse(String recordingId)" + name: "stopRecordingWithResponse(String recordingId)" + nameWithType: "CallRecordingAsync.stopRecordingWithResponse(String recordingId)" + summary: "Stop recording of the call." + parameters: + - description: "Recording id to stop." + name: "recordingId" + type: "String" + syntax: "public Mono> stopRecordingWithResponse(String recordingId)" + desc: "Stop recording of the call." + returns: + description: "Response for a successful stop recording request." + type: "Mono<<Void>>" +type: "class" +desc: "CallRecordingAsync." +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.CallingServerServiceVersion.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallingServerServiceVersion.yml new file mode 100644 index 000000000000..f0ca90b5f102 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.CallingServerServiceVersion.yml @@ -0,0 +1,91 @@ +### YamlMime:JavaEnum +uid: "com.azure.communication.callautomation.CallingServerServiceVersion" +fullName: "com.azure.communication.callautomation.CallingServerServiceVersion" +name: "CallingServerServiceVersion" +nameWithType: "CallingServerServiceVersion" +summary: "Versions of CallingServer service supported by this client library." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "java.lang.Enum" + methodsRef: + - "valueOf-java.lang.Class-java.lang.String-\">valueOf" + - "clone" + - "compareTo" + - "equals" + - "finalize" + - "getDeclaringClass" + - "hashCode" + - "name" + - "ordinal" + - "toString" +- classRef: "java.lang.Object" + methodsRef: + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public enum **CallingServerServiceVersion**
extends Enum<>
implements " +fields: +- uid: "com.azure.communication.callautomation.CallingServerServiceVersion.V2021_11_15_PREVIEW" + fullName: "com.azure.communication.callautomation.CallingServerServiceVersion.V2021_11_15_PREVIEW" + name: "V2021_11_15_PREVIEW" + nameWithType: "CallingServerServiceVersion.V2021_11_15_PREVIEW" + summary: "Service version `2021-11-15-preview`." + desc: "Service version `2021-11-15-preview`." +- uid: "com.azure.communication.callautomation.CallingServerServiceVersion.V2022_04_07_PREVIEW" + fullName: "com.azure.communication.callautomation.CallingServerServiceVersion.V2022_04_07_PREVIEW" + name: "V2022_04_07_PREVIEW" + nameWithType: "CallingServerServiceVersion.V2022_04_07_PREVIEW" + summary: "Service version `2022-04-07-preview`." + desc: "Service version `2022-04-07-preview`." +methods: +- uid: "com.azure.communication.callautomation.CallingServerServiceVersion.getLatest()" + fullName: "com.azure.communication.callautomation.CallingServerServiceVersion.getLatest()" + name: "getLatest()" + nameWithType: "CallingServerServiceVersion.getLatest()" + summary: "Gets the latest service version supported by this client library" + modifiers: + - "static" + syntax: "public static CallingServerServiceVersion getLatest()" + desc: "Gets the latest service version supported by this client library" + returns: + description: "The latest object." + type: "" +- uid: "com.azure.communication.callautomation.CallingServerServiceVersion.getVersion()" + fullName: "com.azure.communication.callautomation.CallingServerServiceVersion.getVersion()" + name: "getVersion()" + nameWithType: "CallingServerServiceVersion.getVersion()" + syntax: "public String getVersion()" + returns: + type: "String" +- uid: "com.azure.communication.callautomation.CallingServerServiceVersion.valueOf(java.lang.String)" + fullName: "com.azure.communication.callautomation.CallingServerServiceVersion.valueOf(String name)" + name: "valueOf(String name)" + nameWithType: "CallingServerServiceVersion.valueOf(String name)" + modifiers: + - "static" + parameters: + - name: "name" + type: "String" + syntax: "public static CallingServerServiceVersion valueOf(String name)" + returns: + type: "" +- uid: "com.azure.communication.callautomation.CallingServerServiceVersion.values()" + fullName: "com.azure.communication.callautomation.CallingServerServiceVersion.values()" + name: "values()" + nameWithType: "CallingServerServiceVersion.values()" + modifiers: + - "static" + syntax: "public static CallingServerServiceVersion[] values()" + returns: + type: "[]" +desc: "Versions of CallingServer service supported by this client library." +implements: +- "" +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.EventHandler.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.EventHandler.yml new file mode 100644 index 000000000000..3e58f738687c --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.EventHandler.yml @@ -0,0 +1,67 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.EventHandler" +fullName: "com.azure.communication.callautomation.EventHandler" +name: "EventHandler" +nameWithType: "EventHandler" +summary: "Event handler for taking care of event related tasks." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **EventHandler**" +constructors: +- uid: "com.azure.communication.callautomation.EventHandler.EventHandler()" + fullName: "com.azure.communication.callautomation.EventHandler.EventHandler()" + name: "EventHandler()" + nameWithType: "EventHandler.EventHandler()" + syntax: "public EventHandler()" +methods: +- uid: "com.azure.communication.callautomation.EventHandler.parseEvent(java.lang.String)" + fullName: "com.azure.communication.callautomation.EventHandler.parseEvent(String requestBody)" + name: "parseEvent(String requestBody)" + nameWithType: "EventHandler.parseEvent(String requestBody)" + summary: "Returns the first(or the only) event of request's body." + modifiers: + - "static" + parameters: + - description: "Body of the event request." + name: "requestBody" + type: "String" + syntax: "public static CallAutomationEventBase parseEvent(String requestBody)" + desc: "Returns the first(or the only) event of request's body." + returns: + description: "the first(or the only) event if request is not empty, otherwise null is returned." + type: "" +- uid: "com.azure.communication.callautomation.EventHandler.parseEventList(java.lang.String)" + fullName: "com.azure.communication.callautomation.EventHandler.parseEventList(String requestBody)" + name: "parseEventList(String requestBody)" + nameWithType: "EventHandler.parseEventList(String requestBody)" + summary: "Returns a list of events from request's body." + modifiers: + - "static" + parameters: + - description: "Body of the event request." + name: "requestBody" + type: "String" + syntax: "public static List parseEventList(String requestBody)" + desc: "Returns a list of events from request's body." + returns: + description: "a list of CallAutomationEventBase" + type: "List<>" +type: "class" +desc: "Event handler for taking care of event related tasks." +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AddParticipantsOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AddParticipantsOptions.yml new file mode 100644 index 000000000000..f1d5a659000b --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AddParticipantsOptions.yml @@ -0,0 +1,147 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.AddParticipantsOptions" +fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions" +name: "AddParticipantsOptions" +nameWithType: "AddParticipantsOptions" +summary: "The options for adding participants." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **AddParticipantsOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.AddParticipantsOptions.AddParticipantsOptions(java.util.List)" + fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions.AddParticipantsOptions(List participants)" + name: "AddParticipantsOptions(List participants)" + nameWithType: "AddParticipantsOptions.AddParticipantsOptions(List participants)" + summary: "Constructor" + parameters: + - description: "The list of participants to invite." + name: "participants" + type: "List<>" + syntax: "public AddParticipantsOptions(List participants)" + desc: "Constructor" +methods: +- uid: "com.azure.communication.callautomation.models.AddParticipantsOptions.getInvitationTimeout()" + fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions.getInvitationTimeout()" + name: "getInvitationTimeout()" + nameWithType: "AddParticipantsOptions.getInvitationTimeout()" + summary: "Get the invitationTimeoutInSeconds." + syntax: "public Duration getInvitationTimeout()" + desc: "Get the invitationTimeoutInSeconds." + returns: + description: "the Invitation Timeout In Seconds" + type: "Duration" +- uid: "com.azure.communication.callautomation.models.AddParticipantsOptions.getOperationContext()" + fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions.getOperationContext()" + name: "getOperationContext()" + nameWithType: "AddParticipantsOptions.getOperationContext()" + summary: "Get the operationContext." + syntax: "public String getOperationContext()" + desc: "Get the operationContext." + returns: + description: "the operationContext" + type: "String" +- uid: "com.azure.communication.callautomation.models.AddParticipantsOptions.getParticipants()" + fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions.getParticipants()" + name: "getParticipants()" + nameWithType: "AddParticipantsOptions.getParticipants()" + summary: "Get the participants." + syntax: "public List getParticipants()" + desc: "Get the participants." + returns: + description: "the list of participants to be added" + type: "List<>" +- uid: "com.azure.communication.callautomation.models.AddParticipantsOptions.getRepeatabilityHeaders()" + fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions.getRepeatabilityHeaders()" + name: "getRepeatabilityHeaders()" + nameWithType: "AddParticipantsOptions.getRepeatabilityHeaders()" + summary: "Get the Repeatability headers configuration." + syntax: "public RepeatabilityHeaders getRepeatabilityHeaders()" + desc: "Get the Repeatability headers configuration." + returns: + description: "the repeatabilityHeaders" + type: "" +- uid: "com.azure.communication.callautomation.models.AddParticipantsOptions.getSourceCallerId()" + fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions.getSourceCallerId()" + name: "getSourceCallerId()" + nameWithType: "AddParticipantsOptions.getSourceCallerId()" + summary: "Get the sourceCallerId." + syntax: "public PhoneNumberIdentifier getSourceCallerId()" + desc: "Get the sourceCallerId." + returns: + description: "the sourceCallerId phone identifier." + type: "" +- uid: "com.azure.communication.callautomation.models.AddParticipantsOptions.setInvitationTimeout(java.time.Duration)" + fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions.setInvitationTimeout(Duration invitationTimeout)" + name: "setInvitationTimeout(Duration invitationTimeout)" + nameWithType: "AddParticipantsOptions.setInvitationTimeout(Duration invitationTimeout)" + summary: "Set the invitationTimeoutInSeconds." + parameters: + - description: "Set the timeout to wait for the invited participant to pickup.\n The maximum value of this is 180 seconds." + name: "invitationTimeout" + type: "Duration" + syntax: "public AddParticipantsOptions setInvitationTimeout(Duration invitationTimeout)" + desc: "Set the invitationTimeoutInSeconds." + returns: + description: "the AddParticipantsOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.AddParticipantsOptions.setOperationContext(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions.setOperationContext(String operationContext)" + name: "setOperationContext(String operationContext)" + nameWithType: "AddParticipantsOptions.setOperationContext(String operationContext)" + summary: "Set the operationContext." + parameters: + - description: "the operationContext to set" + name: "operationContext" + type: "String" + syntax: "public AddParticipantsOptions setOperationContext(String operationContext)" + desc: "Set the operationContext." + returns: + description: "the AddParticipantsOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.AddParticipantsOptions.setRepeatabilityHeaders(com.azure.communication.callautomation.models.RepeatabilityHeaders)" + fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + name: "setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + nameWithType: "AddParticipantsOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + summary: "Set the repeatability headers" + parameters: + - description: "The repeatability headers configuration." + name: "repeatabilityHeaders" + type: "" + syntax: "public AddParticipantsOptions setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + desc: "Set the repeatability headers" + returns: + description: "the AddParticipantsOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.AddParticipantsOptions.setSourceCallerId(com.azure.communication.common.PhoneNumberIdentifier)" + fullName: "com.azure.communication.callautomation.models.AddParticipantsOptions.setSourceCallerId(PhoneNumberIdentifier sourceCallerId)" + name: "setSourceCallerId(PhoneNumberIdentifier sourceCallerId)" + nameWithType: "AddParticipantsOptions.setSourceCallerId(PhoneNumberIdentifier sourceCallerId)" + summary: "Set the sourceCallerId." + parameters: + - description: "Set the source caller Id that's shown to the PSTN participant being invited.\n Required only when inviting a PSTN participant." + name: "sourceCallerId" + type: "" + syntax: "public AddParticipantsOptions setSourceCallerId(PhoneNumberIdentifier sourceCallerId)" + desc: "Set the sourceCallerId." + returns: + description: "the AddParticipantsOptions object itself." + type: "" +type: "class" +desc: "The options for adding participants." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AddParticipantsResult.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AddParticipantsResult.yml new file mode 100644 index 000000000000..008674e88410 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AddParticipantsResult.yml @@ -0,0 +1,57 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.AddParticipantsResult" +fullName: "com.azure.communication.callautomation.models.AddParticipantsResult" +name: "AddParticipantsResult" +nameWithType: "AddParticipantsResult" +summary: "The AddParticipantsResult model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **AddParticipantsResult**" +constructors: +- uid: "com.azure.communication.callautomation.models.AddParticipantsResult.AddParticipantsResult()" + fullName: "com.azure.communication.callautomation.models.AddParticipantsResult.AddParticipantsResult()" + name: "AddParticipantsResult()" + nameWithType: "AddParticipantsResult.AddParticipantsResult()" + summary: "Public constructor." + syntax: "public AddParticipantsResult()" + desc: "Public constructor." +methods: +- uid: "com.azure.communication.callautomation.models.AddParticipantsResult.getOperationContext()" + fullName: "com.azure.communication.callautomation.models.AddParticipantsResult.getOperationContext()" + name: "getOperationContext()" + nameWithType: "AddParticipantsResult.getOperationContext()" + summary: "Get the operationContext property: The operation context provided by client." + syntax: "public String getOperationContext()" + desc: "Get the operationContext property: The operation context provided by client." + returns: + description: "the operationContext value." + type: "String" +- uid: "com.azure.communication.callautomation.models.AddParticipantsResult.getParticipants()" + fullName: "com.azure.communication.callautomation.models.AddParticipantsResult.getParticipants()" + name: "getParticipants()" + nameWithType: "AddParticipantsResult.getParticipants()" + summary: "Get the participants property: The participants property." + syntax: "public List getParticipants()" + desc: "Get the participants property: The participants property." + returns: + description: "the participants value." + type: "List<>" +type: "class" +desc: "The AddParticipantsResult model." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AnswerCallOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AnswerCallOptions.yml new file mode 100644 index 000000000000..355921793efd --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AnswerCallOptions.yml @@ -0,0 +1,88 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.AnswerCallOptions" +fullName: "com.azure.communication.callautomation.models.AnswerCallOptions" +name: "AnswerCallOptions" +nameWithType: "AnswerCallOptions" +summary: "The options for creating a call." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **AnswerCallOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.AnswerCallOptions.AnswerCallOptions(java.lang.String,java.lang.String)" + fullName: "com.azure.communication.callautomation.models.AnswerCallOptions.AnswerCallOptions(String incomingCallContext, String callbackUrl)" + name: "AnswerCallOptions(String incomingCallContext, String callbackUrl)" + nameWithType: "AnswerCallOptions.AnswerCallOptions(String incomingCallContext, String callbackUrl)" + summary: "Constructor" + parameters: + - description: "The incoming call context." + name: "incomingCallContext" + type: "String" + - description: "The call back URI." + name: "callbackUrl" + type: "String" + syntax: "public AnswerCallOptions(String incomingCallContext, String callbackUrl)" + desc: "Constructor" +methods: +- uid: "com.azure.communication.callautomation.models.AnswerCallOptions.getCallbackUrl()" + fullName: "com.azure.communication.callautomation.models.AnswerCallOptions.getCallbackUrl()" + name: "getCallbackUrl()" + nameWithType: "AnswerCallOptions.getCallbackUrl()" + summary: "Get the call back uri." + syntax: "public String getCallbackUrl()" + desc: "Get the call back uri." + returns: + description: "the call back uri." + type: "String" +- uid: "com.azure.communication.callautomation.models.AnswerCallOptions.getIncomingCallContext()" + fullName: "com.azure.communication.callautomation.models.AnswerCallOptions.getIncomingCallContext()" + name: "getIncomingCallContext()" + nameWithType: "AnswerCallOptions.getIncomingCallContext()" + summary: "Get the incomingCallContext." + syntax: "public String getIncomingCallContext()" + desc: "Get the incomingCallContext." + returns: + description: "the incomingCallContext." + type: "String" +- uid: "com.azure.communication.callautomation.models.AnswerCallOptions.getRepeatabilityHeaders()" + fullName: "com.azure.communication.callautomation.models.AnswerCallOptions.getRepeatabilityHeaders()" + name: "getRepeatabilityHeaders()" + nameWithType: "AnswerCallOptions.getRepeatabilityHeaders()" + summary: "Get the Repeatability headers configuration." + syntax: "public RepeatabilityHeaders getRepeatabilityHeaders()" + desc: "Get the Repeatability headers configuration." + returns: + description: "the repeatabilityHeaders" + type: "" +- uid: "com.azure.communication.callautomation.models.AnswerCallOptions.setRepeatabilityHeaders(com.azure.communication.callautomation.models.RepeatabilityHeaders)" + fullName: "com.azure.communication.callautomation.models.AnswerCallOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + name: "setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + nameWithType: "AnswerCallOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + summary: "Set the repeatability headers" + parameters: + - description: "The repeatability headers configuration." + name: "repeatabilityHeaders" + type: "" + syntax: "public AnswerCallOptions setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + desc: "Set the repeatability headers" + returns: + description: "the AnswerCallOptions object itself." + type: "" +type: "class" +desc: "The options for creating a call." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AnswerCallResult.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AnswerCallResult.yml new file mode 100644 index 000000000000..929a1fca2195 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.AnswerCallResult.yml @@ -0,0 +1,52 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.AnswerCallResult" +fullName: "com.azure.communication.callautomation.models.AnswerCallResult" +name: "AnswerCallResult" +nameWithType: "AnswerCallResult" +summary: "The result of answering a call" +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **AnswerCallResult**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.AnswerCallResult.AnswerCallResult(com.azure.communication.callautomation.models.CallConnectionProperties,com.azure.communication.callautomation.CallConnection,com.azure.communication.callautomation.CallConnectionAsync)" + fullName: "com.azure.communication.callautomation.models.AnswerCallResult.AnswerCallResult(CallConnectionProperties callConnectionProperties, CallConnection callConnection, CallConnectionAsync callConnectionAsync)" + name: "AnswerCallResult(CallConnectionProperties callConnectionProperties, CallConnection callConnection, CallConnectionAsync callConnectionAsync)" + nameWithType: "AnswerCallResult.AnswerCallResult(CallConnectionProperties callConnectionProperties, CallConnection callConnection, CallConnectionAsync callConnectionAsync)" + summary: "Constructor" + parameters: + - description: "The callConnectionProperties" + name: "callConnectionProperties" + type: "" + - description: "The callConnection" + name: "callConnection" + type: "" + - description: "The callConnectionAsync" + name: "callConnectionAsync" + type: "" + syntax: "public AnswerCallResult(CallConnectionProperties callConnectionProperties, CallConnection callConnection, CallConnectionAsync callConnectionAsync)" + desc: "Constructor" +type: "class" +desc: "The result of answering a call" +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallConnectionProperties.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallConnectionProperties.yml new file mode 100644 index 000000000000..13e20cfcc51c --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallConnectionProperties.yml @@ -0,0 +1,97 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallConnectionProperties" +fullName: "com.azure.communication.callautomation.models.CallConnectionProperties" +name: "CallConnectionProperties" +nameWithType: "CallConnectionProperties" +summary: "Asynchronous client that supports call connection operations." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallConnectionProperties**" +constructors: +- uid: "com.azure.communication.callautomation.models.CallConnectionProperties.CallConnectionProperties()" + fullName: "com.azure.communication.callautomation.models.CallConnectionProperties.CallConnectionProperties()" + name: "CallConnectionProperties()" + nameWithType: "CallConnectionProperties.CallConnectionProperties()" + summary: "Public constructor." + syntax: "public CallConnectionProperties()" + desc: "Public constructor." +methods: +- uid: "com.azure.communication.callautomation.models.CallConnectionProperties.getCallConnectionId()" + fullName: "com.azure.communication.callautomation.models.CallConnectionProperties.getCallConnectionId()" + name: "getCallConnectionId()" + nameWithType: "CallConnectionProperties.getCallConnectionId()" + summary: "Get the callConnectionId property, which is the call connection id." + syntax: "public String getCallConnectionId()" + desc: "Get the callConnectionId property, which is the call connection id." + returns: + description: "callConnectionId value." + type: "String" +- uid: "com.azure.communication.callautomation.models.CallConnectionProperties.getCallConnectionState()" + fullName: "com.azure.communication.callautomation.models.CallConnectionProperties.getCallConnectionState()" + name: "getCallConnectionState()" + nameWithType: "CallConnectionProperties.getCallConnectionState()" + summary: "Get the callConnectionState property." + syntax: "public CallConnectionState getCallConnectionState()" + desc: "Get the callConnectionState property." + returns: + description: "callConnectionState value." + type: "" +- uid: "com.azure.communication.callautomation.models.CallConnectionProperties.getCallbackUri()" + fullName: "com.azure.communication.callautomation.models.CallConnectionProperties.getCallbackUri()" + name: "getCallbackUri()" + nameWithType: "CallConnectionProperties.getCallbackUri()" + summary: "Get the callbackUri property." + syntax: "public URI getCallbackUri()" + desc: "Get the callbackUri property." + returns: + description: "callbackUri value." + type: "URI" +- uid: "com.azure.communication.callautomation.models.CallConnectionProperties.getServerCallId()" + fullName: "com.azure.communication.callautomation.models.CallConnectionProperties.getServerCallId()" + name: "getServerCallId()" + nameWithType: "CallConnectionProperties.getServerCallId()" + summary: "Get the server call Id." + syntax: "public String getServerCallId()" + desc: "Get the server call Id." + returns: + description: "serverCallId value." + type: "String" +- uid: "com.azure.communication.callautomation.models.CallConnectionProperties.getSource()" + fullName: "com.azure.communication.callautomation.models.CallConnectionProperties.getSource()" + name: "getSource()" + nameWithType: "CallConnectionProperties.getSource()" + summary: "Get the source property." + syntax: "public CallSource getSource()" + desc: "Get the source property." + returns: + description: "source value." + type: "" +- uid: "com.azure.communication.callautomation.models.CallConnectionProperties.getTargets()" + fullName: "com.azure.communication.callautomation.models.CallConnectionProperties.getTargets()" + name: "getTargets()" + nameWithType: "CallConnectionProperties.getTargets()" + summary: "Get the targets property." + syntax: "public List getTargets()" + desc: "Get the targets property." + returns: + description: "list of targets" + type: "List<>" +type: "class" +desc: "Asynchronous client that supports call connection operations." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallConnectionState.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallConnectionState.yml new file mode 100644 index 000000000000..137fac5354b6 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallConnectionState.yml @@ -0,0 +1,135 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallConnectionState" +fullName: "com.azure.communication.callautomation.models.CallConnectionState" +name: "CallConnectionState" +nameWithType: "CallConnectionState" +summary: "Defines values for CallConnectionState." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallConnectionState**
extends <>" +fields: +- uid: "com.azure.communication.callautomation.models.CallConnectionState.CONNECTED" + fullName: "com.azure.communication.callautomation.models.CallConnectionState.CONNECTED" + name: "CONNECTED" + nameWithType: "CallConnectionState.CONNECTED" + summary: "Static value connected for CallConnectionState." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallConnectionState CONNECTED" + desc: "Static value connected for CallConnectionState." +- uid: "com.azure.communication.callautomation.models.CallConnectionState.CONNECTING" + fullName: "com.azure.communication.callautomation.models.CallConnectionState.CONNECTING" + name: "CONNECTING" + nameWithType: "CallConnectionState.CONNECTING" + summary: "Static value connecting for CallConnectionState." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallConnectionState CONNECTING" + desc: "Static value connecting for CallConnectionState." +- uid: "com.azure.communication.callautomation.models.CallConnectionState.DISCONNECTED" + fullName: "com.azure.communication.callautomation.models.CallConnectionState.DISCONNECTED" + name: "DISCONNECTED" + nameWithType: "CallConnectionState.DISCONNECTED" + summary: "Static value disconnected for CallConnectionState." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallConnectionState DISCONNECTED" + desc: "Static value disconnected for CallConnectionState." +- uid: "com.azure.communication.callautomation.models.CallConnectionState.DISCONNECTING" + fullName: "com.azure.communication.callautomation.models.CallConnectionState.DISCONNECTING" + name: "DISCONNECTING" + nameWithType: "CallConnectionState.DISCONNECTING" + summary: "Static value disconnecting for CallConnectionState." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallConnectionState DISCONNECTING" + desc: "Static value disconnecting for CallConnectionState." +- uid: "com.azure.communication.callautomation.models.CallConnectionState.TRANSFERRING" + fullName: "com.azure.communication.callautomation.models.CallConnectionState.TRANSFERRING" + name: "TRANSFERRING" + nameWithType: "CallConnectionState.TRANSFERRING" + summary: "Static value transferring for CallConnectionState." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallConnectionState TRANSFERRING" + desc: "Static value transferring for CallConnectionState." +- uid: "com.azure.communication.callautomation.models.CallConnectionState.TRANSFER_ACCEPTED" + fullName: "com.azure.communication.callautomation.models.CallConnectionState.TRANSFER_ACCEPTED" + name: "TRANSFER_ACCEPTED" + nameWithType: "CallConnectionState.TRANSFER_ACCEPTED" + summary: "Static value transferAccepted for CallConnectionState." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallConnectionState TRANSFER_ACCEPTED" + desc: "Static value transferAccepted for CallConnectionState." +methods: +- uid: "com.azure.communication.callautomation.models.CallConnectionState.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.CallConnectionState.fromString(String name)" + name: "fromString(String name)" + nameWithType: "CallConnectionState.fromString(String name)" + summary: "Creates or finds a CallConnectionState from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static CallConnectionState fromString(String name)" + desc: "Creates or finds a CallConnectionState from its string representation." + returns: + description: "the corresponding CallConnectionState." + type: "" +- uid: "com.azure.communication.callautomation.models.CallConnectionState.values()" + fullName: "com.azure.communication.callautomation.models.CallConnectionState.values()" + name: "values()" + nameWithType: "CallConnectionState.values()" + summary: "Return values" + modifiers: + - "static" + syntax: "public static Collection values()" + desc: "Return values" + returns: + description: "known CallConnectionState values." + type: "Collection<>" +type: "class" +desc: "Defines values for CallConnectionState." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallLocator.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallLocator.yml new file mode 100644 index 000000000000..c09dbf016cce --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallLocator.yml @@ -0,0 +1,39 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallLocator" +fullName: "com.azure.communication.callautomation.models.CallLocator" +name: "CallLocator" +nameWithType: "CallLocator" +summary: "The locator used for joining or taking action on a call." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public abstract class **CallLocator**" +methods: +- uid: "com.azure.communication.callautomation.models.CallLocator.getKind()" + fullName: "com.azure.communication.callautomation.models.CallLocator.getKind()" + name: "getKind()" + nameWithType: "CallLocator.getKind()" + summary: "Get the kind property: The call locator kind." + syntax: "public CallLocatorKind getKind()" + desc: "Get the kind property: The call locator kind." + returns: + description: "the kind value." + type: "" +type: "class" +desc: "The locator used for joining or taking action on a call." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallLocatorKind.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallLocatorKind.yml new file mode 100644 index 000000000000..b7ea6bee350b --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallLocatorKind.yml @@ -0,0 +1,91 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallLocatorKind" +fullName: "com.azure.communication.callautomation.models.CallLocatorKind" +name: "CallLocatorKind" +nameWithType: "CallLocatorKind" +summary: "Defines values for CallLocatorKind." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallLocatorKind**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.CallLocatorKind.CallLocatorKind()" + fullName: "com.azure.communication.callautomation.models.CallLocatorKind.CallLocatorKind()" + name: "CallLocatorKind()" + nameWithType: "CallLocatorKind.CallLocatorKind()" + syntax: "public CallLocatorKind()" +fields: +- uid: "com.azure.communication.callautomation.models.CallLocatorKind.GROUP_CALL_LOCATOR" + fullName: "com.azure.communication.callautomation.models.CallLocatorKind.GROUP_CALL_LOCATOR" + name: "GROUP_CALL_LOCATOR" + nameWithType: "CallLocatorKind.GROUP_CALL_LOCATOR" + summary: "Static value groupCallLocator for CallLocatorKind." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallLocatorKind GROUP_CALL_LOCATOR" + desc: "Static value groupCallLocator for CallLocatorKind." +- uid: "com.azure.communication.callautomation.models.CallLocatorKind.SERVER_CALL_LOCATOR" + fullName: "com.azure.communication.callautomation.models.CallLocatorKind.SERVER_CALL_LOCATOR" + name: "SERVER_CALL_LOCATOR" + nameWithType: "CallLocatorKind.SERVER_CALL_LOCATOR" + summary: "Static value serverCallLocator for CallLocatorKind." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallLocatorKind SERVER_CALL_LOCATOR" + desc: "Static value serverCallLocator for CallLocatorKind." +methods: +- uid: "com.azure.communication.callautomation.models.CallLocatorKind.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.CallLocatorKind.fromString(String name)" + name: "fromString(String name)" + nameWithType: "CallLocatorKind.fromString(String name)" + summary: "Creates or finds a CallLocatorKind from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static CallLocatorKind fromString(String name)" + desc: "Creates or finds a CallLocatorKind from its string representation." + returns: + description: "the corresponding CallLocatorKind." + type: "" +- uid: "com.azure.communication.callautomation.models.CallLocatorKind.values()" + fullName: "com.azure.communication.callautomation.models.CallLocatorKind.values()" + name: "values()" + nameWithType: "CallLocatorKind.values()" + modifiers: + - "static" + syntax: "public static Collection values()" + returns: + description: "known CallLocatorKind values." + type: "Collection<>" +type: "class" +desc: "Defines values for CallLocatorKind." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognitionType.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognitionType.yml new file mode 100644 index 000000000000..5ec7602a96d4 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognitionType.yml @@ -0,0 +1,79 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallMediaRecognitionType" +fullName: "com.azure.communication.callautomation.models.CallMediaRecognitionType" +name: "CallMediaRecognitionType" +nameWithType: "CallMediaRecognitionType" +summary: "Defines values for RecognitionType." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallMediaRecognitionType**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.CallMediaRecognitionType.CallMediaRecognitionType()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognitionType.CallMediaRecognitionType()" + name: "CallMediaRecognitionType()" + nameWithType: "CallMediaRecognitionType.CallMediaRecognitionType()" + syntax: "public CallMediaRecognitionType()" +fields: +- uid: "com.azure.communication.callautomation.models.CallMediaRecognitionType.DTMF" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognitionType.DTMF" + name: "DTMF" + nameWithType: "CallMediaRecognitionType.DTMF" + summary: "Static value dtmf for RecognitionType." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallMediaRecognitionType DTMF" + desc: "Static value dtmf for RecognitionType." +methods: +- uid: "com.azure.communication.callautomation.models.CallMediaRecognitionType.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognitionType.fromString(String name)" + name: "fromString(String name)" + nameWithType: "CallMediaRecognitionType.fromString(String name)" + summary: "Creates or finds a RecognitionType from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static CallMediaRecognitionType fromString(String name)" + desc: "Creates or finds a RecognitionType from its string representation." + returns: + description: "the corresponding RecognitionType." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognitionType.values()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognitionType.values()" + name: "values()" + nameWithType: "CallMediaRecognitionType.values()" + modifiers: + - "static" + syntax: "public static Collection values()" + returns: + description: "known RecognitionType values." + type: "Collection<>" +type: "class" +desc: "Defines values for RecognitionType." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.yml new file mode 100644 index 000000000000..3a031fe6a841 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.yml @@ -0,0 +1,120 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions" +fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions" +name: "CallMediaRecognizeDtmfOptions" +nameWithType: "CallMediaRecognizeDtmfOptions" +summary: "The Recognize configurations specific for Dtmf." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" + - "" + - "" + - "" + - "" + - "" + - "" + - "" + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **CallMediaRecognizeDtmfOptions**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.CallMediaRecognizeDtmfOptions(com.azure.communication.common.CommunicationIdentifier,int)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.CallMediaRecognizeDtmfOptions(CommunicationIdentifier targetParticipant, int maxTonesToCollect)" + name: "CallMediaRecognizeDtmfOptions(CommunicationIdentifier targetParticipant, int maxTonesToCollect)" + nameWithType: "CallMediaRecognizeDtmfOptions.CallMediaRecognizeDtmfOptions(CommunicationIdentifier targetParticipant, int maxTonesToCollect)" + summary: "Initializes a CallMediaRecognizeDtmfOptions object." + parameters: + - description: "Target participant of DTFM tone recognition." + name: "targetParticipant" + type: "" + - description: "Maximum number of DTMF tones to be collected." + name: "maxTonesToCollect" + type: "" + syntax: "public CallMediaRecognizeDtmfOptions(CommunicationIdentifier targetParticipant, int maxTonesToCollect)" + desc: "Initializes a CallMediaRecognizeDtmfOptions object." +methods: +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.getInterToneTimeout()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.getInterToneTimeout()" + name: "getInterToneTimeout()" + nameWithType: "CallMediaRecognizeDtmfOptions.getInterToneTimeout()" + summary: "Get the interToneTimeout property: Time to wait between DTMF inputs to stop recognizing." + syntax: "public Duration getInterToneTimeout()" + desc: "Get the interToneTimeout property: Time to wait between DTMF inputs to stop recognizing. If left unspecified, the default value is set to 2 seconds." + returns: + description: "the interToneTimeout value." + type: "Duration" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.getMaxTonesToCollect()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.getMaxTonesToCollect()" + name: "getMaxTonesToCollect()" + nameWithType: "CallMediaRecognizeDtmfOptions.getMaxTonesToCollect()" + summary: "Get the maxTonesToCollect property: Maximum number of DTMFs to be collected." + syntax: "public Integer getMaxTonesToCollect()" + desc: "Get the maxTonesToCollect property: Maximum number of DTMFs to be collected." + returns: + description: "the maxTonesToCollect value." + type: "Integer" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.getStopTones()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.getStopTones()" + name: "getStopTones()" + nameWithType: "CallMediaRecognizeDtmfOptions.getStopTones()" + summary: "Get the stopTones property: List of tones that will stop recognizing." + syntax: "public List getStopTones()" + desc: "Get the stopTones property: List of tones that will stop recognizing." + returns: + description: "the stopTones value." + type: "List<>" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.setInterToneTimeout(java.time.Duration)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.setInterToneTimeout(Duration interToneTimeout)" + name: "setInterToneTimeout(Duration interToneTimeout)" + nameWithType: "CallMediaRecognizeDtmfOptions.setInterToneTimeout(Duration interToneTimeout)" + summary: "Set the interToneTimeout property: Time to wait between DTMF inputs to stop recognizing." + parameters: + - description: "the interToneTimeout value to set." + name: "interToneTimeout" + type: "Duration" + syntax: "public CallMediaRecognizeDtmfOptions setInterToneTimeout(Duration interToneTimeout)" + desc: "Set the interToneTimeout property: Time to wait between DTMF inputs to stop recognizing." + returns: + description: "the DtmfConfigurationsInternal object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.setStopTones(java.util.List)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions.setStopTones(List stopDtmfTones)" + name: "setStopTones(List stopDtmfTones)" + nameWithType: "CallMediaRecognizeDtmfOptions.setStopTones(List stopDtmfTones)" + summary: "Set the stopTones property: List of tones that will stop recognizing." + parameters: + - description: "the stopTones value to set." + name: "stopDtmfTones" + type: "List<>" + syntax: "public CallMediaRecognizeDtmfOptions setStopTones(List stopDtmfTones)" + desc: "Set the stopTones property: List of tones that will stop recognizing." + returns: + description: "the DtmfConfigurationsInternal object itself." + type: "" +type: "class" +desc: "The Recognize configurations specific for Dtmf." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognizeOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognizeOptions.yml new file mode 100644 index 000000000000..d0216e534c8b --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallMediaRecognizeOptions.yml @@ -0,0 +1,222 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions" +fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions" +name: "CallMediaRecognizeOptions" +nameWithType: "CallMediaRecognizeOptions" +summary: "Options to configure the Recognize operation" +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public abstract class **CallMediaRecognizeOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.CallMediaRecognizeOptions(com.azure.communication.callautomation.models.RecognizeInputType,com.azure.communication.common.CommunicationIdentifier)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.CallMediaRecognizeOptions(RecognizeInputType recognizeInputType, CommunicationIdentifier targetParticipant)" + name: "CallMediaRecognizeOptions(RecognizeInputType recognizeInputType, CommunicationIdentifier targetParticipant)" + nameWithType: "CallMediaRecognizeOptions.CallMediaRecognizeOptions(RecognizeInputType recognizeInputType, CommunicationIdentifier targetParticipant)" + summary: "Initializes a CallMediaRecognizeOptions object." + parameters: + - description: "What input the operation should recognize." + name: "recognizeInputType" + type: "" + - description: "Target participant of DTFM tone recognition." + name: "targetParticipant" + type: "" + syntax: "public CallMediaRecognizeOptions(RecognizeInputType recognizeInputType, CommunicationIdentifier targetParticipant)" + desc: "Initializes a CallMediaRecognizeOptions object." +methods: +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.getInitialSilenceTimeout()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.getInitialSilenceTimeout()" + name: "getInitialSilenceTimeout()" + nameWithType: "CallMediaRecognizeOptions.getInitialSilenceTimeout()" + summary: "Get the initialSilenceTimeout property: Time to wait for first input after prompt (if any)." + syntax: "public Duration getInitialSilenceTimeout()" + desc: "Get the initialSilenceTimeout property: Time to wait for first input after prompt (if any)." + returns: + description: "the initialSilenceTimeout value." + type: "Duration" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.getOperationContext()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.getOperationContext()" + name: "getOperationContext()" + nameWithType: "CallMediaRecognizeOptions.getOperationContext()" + summary: "Get the operationContext property: The value to identify context of the operation." + syntax: "public String getOperationContext()" + desc: "Get the operationContext property: The value to identify context of the operation." + returns: + description: "the operationContext value." + type: "String" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.getPlayPrompt()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.getPlayPrompt()" + name: "getPlayPrompt()" + nameWithType: "CallMediaRecognizeOptions.getPlayPrompt()" + summary: "Get the playPrompt property: The source of the audio to be played for recognition." + syntax: "public PlaySource getPlayPrompt()" + desc: "Get the playPrompt property: The source of the audio to be played for recognition." + returns: + description: "the playPrompt value." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.getRecognizeInputType()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.getRecognizeInputType()" + name: "getRecognizeInputType()" + nameWithType: "CallMediaRecognizeOptions.getRecognizeInputType()" + summary: "Get the recognizeInputType property: Determines the type of the recognition." + syntax: "public RecognizeInputType getRecognizeInputType()" + desc: "Get the recognizeInputType property: Determines the type of the recognition." + returns: + description: "the recognizeInputType value." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.getTargetParticipant()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.getTargetParticipant()" + name: "getTargetParticipant()" + nameWithType: "CallMediaRecognizeOptions.getTargetParticipant()" + summary: "Get the targetParticipant property: Target participant of DTFM tone recognition." + syntax: "public CommunicationIdentifier getTargetParticipant()" + desc: "Get the targetParticipant property: Target participant of DTFM tone recognition." + returns: + description: "the targetParticipant value." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.isInterruptCallMediaOperation()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.isInterruptCallMediaOperation()" + name: "isInterruptCallMediaOperation()" + nameWithType: "CallMediaRecognizeOptions.isInterruptCallMediaOperation()" + summary: "Get the interruptCallMediaOperation property: If set recognize can barge into other existing queued-up/currently-processing requests." + syntax: "public Boolean isInterruptCallMediaOperation()" + desc: "Get the interruptCallMediaOperation property: If set recognize can barge into other existing queued-up/currently-processing requests." + returns: + description: "the interruptCallMediaOperation value." + type: "Boolean" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.isInterruptPrompt()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.isInterruptPrompt()" + name: "isInterruptPrompt()" + nameWithType: "CallMediaRecognizeOptions.isInterruptPrompt()" + summary: "Get the interruptPrompt property: Determines if we interrupt the prompt and start recognizing." + syntax: "public Boolean isInterruptPrompt()" + desc: "Get the interruptPrompt property: Determines if we interrupt the prompt and start recognizing." + returns: + description: "the interruptPrompt value." + type: "Boolean" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.isStopCurrentOperations()" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.isStopCurrentOperations()" + name: "isStopCurrentOperations()" + nameWithType: "CallMediaRecognizeOptions.isStopCurrentOperations()" + summary: "Get the stopCurrentOperations property: If set recognize can barge into other existing queued-up/currently-processing requests." + syntax: "public Boolean isStopCurrentOperations()" + desc: "Get the stopCurrentOperations property: If set recognize can barge into other existing queued-up/currently-processing requests." + returns: + description: "the stopCurrentOperations value." + type: "Boolean" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setInitialSilenceTimeout(java.time.Duration)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setInitialSilenceTimeout(Duration initialSilenceTimeout)" + name: "setInitialSilenceTimeout(Duration initialSilenceTimeout)" + nameWithType: "CallMediaRecognizeOptions.setInitialSilenceTimeout(Duration initialSilenceTimeout)" + summary: "Set the initialSilenceTimeout property: Time to wait for first input after prompt (if any)." + parameters: + - description: "the initialSilenceTimeout value to set." + name: "initialSilenceTimeout" + type: "Duration" + syntax: "public CallMediaRecognizeOptions setInitialSilenceTimeout(Duration initialSilenceTimeout)" + desc: "Set the initialSilenceTimeout property: Time to wait for first input after prompt (if any)." + returns: + description: "the RecognizeConfigurations object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setInterruptCallMediaOperation(java.lang.Boolean)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setInterruptCallMediaOperation(Boolean interruptCallMediaOperation)" + name: "setInterruptCallMediaOperation(Boolean interruptCallMediaOperation)" + nameWithType: "CallMediaRecognizeOptions.setInterruptCallMediaOperation(Boolean interruptCallMediaOperation)" + summary: "Set the interruptCallMediaOperation property: If set recognize can barge into other existing queued-up/currently-processing requests." + parameters: + - description: "the interruptCallMediaOperation value to set." + name: "interruptCallMediaOperation" + type: "Boolean" + syntax: "public CallMediaRecognizeOptions setInterruptCallMediaOperation(Boolean interruptCallMediaOperation)" + desc: "Set the interruptCallMediaOperation property: If set recognize can barge into other existing queued-up/currently-processing requests." + returns: + description: "the RecognizeRequest object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setInterruptPrompt(java.lang.Boolean)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setInterruptPrompt(Boolean interruptPrompt)" + name: "setInterruptPrompt(Boolean interruptPrompt)" + nameWithType: "CallMediaRecognizeOptions.setInterruptPrompt(Boolean interruptPrompt)" + summary: "Set the interruptPrompt property: Determines if we interrupt the prompt and start recognizing." + parameters: + - description: "the interruptPrompt value to set." + name: "interruptPrompt" + type: "Boolean" + syntax: "public CallMediaRecognizeOptions setInterruptPrompt(Boolean interruptPrompt)" + desc: "Set the interruptPrompt property: Determines if we interrupt the prompt and start recognizing." + returns: + description: "the RecognizeConfigurations object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setOperationContext(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setOperationContext(String operationContext)" + name: "setOperationContext(String operationContext)" + nameWithType: "CallMediaRecognizeOptions.setOperationContext(String operationContext)" + summary: "Set the operationContext property: The value to identify context of the operation." + parameters: + - description: "the operationContext value to set." + name: "operationContext" + type: "String" + syntax: "public CallMediaRecognizeOptions setOperationContext(String operationContext)" + desc: "Set the operationContext property: The value to identify context of the operation." + returns: + description: "the RecognizeRequest object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setPlayPrompt(com.azure.communication.callautomation.models.PlaySource)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setPlayPrompt(PlaySource playPrompt)" + name: "setPlayPrompt(PlaySource playPrompt)" + nameWithType: "CallMediaRecognizeOptions.setPlayPrompt(PlaySource playPrompt)" + summary: "Set the playPrompt property: The source of the audio to be played for recognition." + parameters: + - description: "the playPrompt value to set." + name: "playPrompt" + type: "" + syntax: "public CallMediaRecognizeOptions setPlayPrompt(PlaySource playPrompt)" + desc: "Set the playPrompt property: The source of the audio to be played for recognition." + returns: + description: "the RecognizeRequest object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setRecognizeInputType(com.azure.communication.callautomation.models.RecognizeInputType)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setRecognizeInputType(RecognizeInputType recognizeInputType)" + name: "setRecognizeInputType(RecognizeInputType recognizeInputType)" + nameWithType: "CallMediaRecognizeOptions.setRecognizeInputType(RecognizeInputType recognizeInputType)" + summary: "Set the recognizeInputType property: Determines the type of the recognition." + parameters: + - description: "the recognizeInputType value to set." + name: "recognizeInputType" + type: "" + syntax: "public CallMediaRecognizeOptions setRecognizeInputType(RecognizeInputType recognizeInputType)" + desc: "Set the recognizeInputType property: Determines the type of the recognition." + returns: + description: "the RecognizeRequest object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setStopCurrentOperations(java.lang.Boolean)" + fullName: "com.azure.communication.callautomation.models.CallMediaRecognizeOptions.setStopCurrentOperations(Boolean stopCurrentOperations)" + name: "setStopCurrentOperations(Boolean stopCurrentOperations)" + nameWithType: "CallMediaRecognizeOptions.setStopCurrentOperations(Boolean stopCurrentOperations)" + summary: "Set the stopCurrentOperations property: If set recognize can barge into other existing queued-up/currently-processing requests." + parameters: + - description: "the stopCurrentOperations value to set." + name: "stopCurrentOperations" + type: "Boolean" + syntax: "public CallMediaRecognizeOptions setStopCurrentOperations(Boolean stopCurrentOperations)" + desc: "Set the stopCurrentOperations property: If set recognize can barge into other existing queued-up/currently-processing requests." + returns: + description: "the RecognizeRequest object itself." + type: "" +type: "class" +desc: "Options to configure the Recognize operation" +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallParticipant.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallParticipant.yml new file mode 100644 index 000000000000..c5180b435da6 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallParticipant.yml @@ -0,0 +1,64 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallParticipant" +fullName: "com.azure.communication.callautomation.models.CallParticipant" +name: "CallParticipant" +nameWithType: "CallParticipant" +summary: "The CallParticipant model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallParticipant**" +constructors: +- uid: "com.azure.communication.callautomation.models.CallParticipant.CallParticipant(com.azure.communication.common.CommunicationIdentifier,java.lang.Boolean)" + fullName: "com.azure.communication.callautomation.models.CallParticipant.CallParticipant(CommunicationIdentifier identifier, Boolean isMuted)" + name: "CallParticipant(CommunicationIdentifier identifier, Boolean isMuted)" + nameWithType: "CallParticipant.CallParticipant(CommunicationIdentifier identifier, Boolean isMuted)" + summary: "Constructor of the class" + parameters: + - description: "The communication identifier" + name: "identifier" + type: "" + - description: "The value of isMuted" + name: "isMuted" + type: "Boolean" + syntax: "public CallParticipant(CommunicationIdentifier identifier, Boolean isMuted)" + desc: "Constructor of the class" +methods: +- uid: "com.azure.communication.callautomation.models.CallParticipant.getIdentifier()" + fullName: "com.azure.communication.callautomation.models.CallParticipant.getIdentifier()" + name: "getIdentifier()" + nameWithType: "CallParticipant.getIdentifier()" + summary: "Get the identifier property: Communication identifier of the participant." + syntax: "public CommunicationIdentifier getIdentifier()" + desc: "Get the identifier property: Communication identifier of the participant." + returns: + description: "the identifier value." + type: "" +- uid: "com.azure.communication.callautomation.models.CallParticipant.isMuted()" + fullName: "com.azure.communication.callautomation.models.CallParticipant.isMuted()" + name: "isMuted()" + nameWithType: "CallParticipant.isMuted()" + summary: "Get the isMuted property: Is participant muted." + syntax: "public Boolean isMuted()" + desc: "Get the isMuted property: Is participant muted." + returns: + description: "the isMuted value." + type: "Boolean" +type: "class" +desc: "The CallParticipant model." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallRejectReason.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallRejectReason.yml new file mode 100644 index 000000000000..5f666a21e778 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallRejectReason.yml @@ -0,0 +1,103 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallRejectReason" +fullName: "com.azure.communication.callautomation.models.CallRejectReason" +name: "CallRejectReason" +nameWithType: "CallRejectReason" +summary: "Defines values for CallRejectReason." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallRejectReason**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.CallRejectReason.CallRejectReason()" + fullName: "com.azure.communication.callautomation.models.CallRejectReason.CallRejectReason()" + name: "CallRejectReason()" + nameWithType: "CallRejectReason.CallRejectReason()" + syntax: "public CallRejectReason()" +fields: +- uid: "com.azure.communication.callautomation.models.CallRejectReason.BUSY" + fullName: "com.azure.communication.callautomation.models.CallRejectReason.BUSY" + name: "BUSY" + nameWithType: "CallRejectReason.BUSY" + summary: "Static value busy for CallRejectReason." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallRejectReason BUSY" + desc: "Static value busy for CallRejectReason." +- uid: "com.azure.communication.callautomation.models.CallRejectReason.FORBIDDEN" + fullName: "com.azure.communication.callautomation.models.CallRejectReason.FORBIDDEN" + name: "FORBIDDEN" + nameWithType: "CallRejectReason.FORBIDDEN" + summary: "Static value forbidden for CallRejectReason." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallRejectReason FORBIDDEN" + desc: "Static value forbidden for CallRejectReason." +- uid: "com.azure.communication.callautomation.models.CallRejectReason.NONE" + fullName: "com.azure.communication.callautomation.models.CallRejectReason.NONE" + name: "NONE" + nameWithType: "CallRejectReason.NONE" + summary: "Static value none for CallRejectReason." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallRejectReason NONE" + desc: "Static value none for CallRejectReason." +methods: +- uid: "com.azure.communication.callautomation.models.CallRejectReason.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.CallRejectReason.fromString(String name)" + name: "fromString(String name)" + nameWithType: "CallRejectReason.fromString(String name)" + summary: "Creates or finds a CallRejectReason from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static CallRejectReason fromString(String name)" + desc: "Creates or finds a CallRejectReason from its string representation." + returns: + description: "the corresponding CallRejectReason." + type: "" +- uid: "com.azure.communication.callautomation.models.CallRejectReason.values()" + fullName: "com.azure.communication.callautomation.models.CallRejectReason.values()" + name: "values()" + nameWithType: "CallRejectReason.values()" + modifiers: + - "static" + syntax: "public static Collection values()" + returns: + description: "known CallRejectReason values." + type: "Collection<>" +type: "class" +desc: "Defines values for CallRejectReason." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallResult.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallResult.yml new file mode 100644 index 000000000000..dc3c51152d9a --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallResult.yml @@ -0,0 +1,59 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallResult" +fullName: "com.azure.communication.callautomation.models.CallResult" +name: "CallResult" +nameWithType: "CallResult" +summary: "The abstract class used as parent of \\[action\\]CallResult" +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public abstract class **CallResult**" +methods: +- uid: "com.azure.communication.callautomation.models.CallResult.getCallConnection()" + fullName: "com.azure.communication.callautomation.models.CallResult.getCallConnection()" + name: "getCallConnection()" + nameWithType: "CallResult.getCallConnection()" + summary: "Get the callConnection." + syntax: "public CallConnection getCallConnection()" + desc: "Get the callConnection." + returns: + description: "the callConnection." + type: "" +- uid: "com.azure.communication.callautomation.models.CallResult.getCallConnectionAsync()" + fullName: "com.azure.communication.callautomation.models.CallResult.getCallConnectionAsync()" + name: "getCallConnectionAsync()" + nameWithType: "CallResult.getCallConnectionAsync()" + summary: "Get the callConnectionAsync." + syntax: "public CallConnectionAsync getCallConnectionAsync()" + desc: "Get the callConnectionAsync." + returns: + description: "the callConnectionAsync." + type: "" +- uid: "com.azure.communication.callautomation.models.CallResult.getCallConnectionProperties()" + fullName: "com.azure.communication.callautomation.models.CallResult.getCallConnectionProperties()" + name: "getCallConnectionProperties()" + nameWithType: "CallResult.getCallConnectionProperties()" + summary: "Get the callConnectionProperties." + syntax: "public CallConnectionProperties getCallConnectionProperties()" + desc: "Get the callConnectionProperties." + returns: + description: "the callConnectionProperties." + type: "" +type: "class" +desc: "The abstract class used as parent of \\[action\\]CallResult" +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallSource.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallSource.yml new file mode 100644 index 000000000000..39194e315e38 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallSource.yml @@ -0,0 +1,75 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallSource" +fullName: "com.azure.communication.callautomation.models.CallSource" +name: "CallSource" +nameWithType: "CallSource" +summary: "The CallSource model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallSource**" +constructors: +- uid: "com.azure.communication.callautomation.models.CallSource.CallSource(com.azure.communication.common.CommunicationIdentifier)" + fullName: "com.azure.communication.callautomation.models.CallSource.CallSource(CommunicationIdentifier identifier)" + name: "CallSource(CommunicationIdentifier identifier)" + nameWithType: "CallSource.CallSource(CommunicationIdentifier identifier)" + summary: "Constructor of the class" + parameters: + - description: "the identifier value to set. Required." + name: "identifier" + type: "" + syntax: "public CallSource(CommunicationIdentifier identifier)" + desc: "Constructor of the class" +methods: +- uid: "com.azure.communication.callautomation.models.CallSource.getCallerId()" + fullName: "com.azure.communication.callautomation.models.CallSource.getCallerId()" + name: "getCallerId()" + nameWithType: "CallSource.getCallerId()" + summary: "Get the callerId property: The alternate identity of the source of the call if dialing out to a pstn number." + syntax: "public PhoneNumberIdentifier getCallerId()" + desc: "Get the callerId property: The alternate identity of the source of the call if dialing out to a pstn number." + returns: + description: "the callerId value." + type: "" +- uid: "com.azure.communication.callautomation.models.CallSource.getIdentifier()" + fullName: "com.azure.communication.callautomation.models.CallSource.getIdentifier()" + name: "getIdentifier()" + nameWithType: "CallSource.getIdentifier()" + summary: "Get the identifier property: The identifier property." + syntax: "public CommunicationIdentifier getIdentifier()" + desc: "Get the identifier property: The identifier property." + returns: + description: "the identifier value." + type: "" +- uid: "com.azure.communication.callautomation.models.CallSource.setCallerId(com.azure.communication.common.PhoneNumberIdentifier)" + fullName: "com.azure.communication.callautomation.models.CallSource.setCallerId(PhoneNumberIdentifier callerId)" + name: "setCallerId(PhoneNumberIdentifier callerId)" + nameWithType: "CallSource.setCallerId(PhoneNumberIdentifier callerId)" + summary: "Set the callerId property: The alternate identity of the source of the call if dialing out to a pstn number." + parameters: + - description: "the callerId value to set." + name: "callerId" + type: "" + syntax: "public CallSource setCallerId(PhoneNumberIdentifier callerId)" + desc: "Set the callerId property: The alternate identity of the source of the call if dialing out to a pstn number." + returns: + description: "the CallSource object itself." + type: "" +type: "class" +desc: "The CallSource model." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingOperationStatus.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingOperationStatus.yml new file mode 100644 index 000000000000..413b8ae4e07c --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingOperationStatus.yml @@ -0,0 +1,111 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallingOperationStatus" +fullName: "com.azure.communication.callautomation.models.CallingOperationStatus" +name: "CallingOperationStatus" +nameWithType: "CallingOperationStatus" +summary: "Defines values for CallingOperationStatus." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallingOperationStatus**
extends <>" +fields: +- uid: "com.azure.communication.callautomation.models.CallingOperationStatus.COMPLETED" + fullName: "com.azure.communication.callautomation.models.CallingOperationStatus.COMPLETED" + name: "COMPLETED" + nameWithType: "CallingOperationStatus.COMPLETED" + summary: "Static value completed for CallingOperationStatus." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallingOperationStatus COMPLETED" + desc: "Static value completed for CallingOperationStatus." +- uid: "com.azure.communication.callautomation.models.CallingOperationStatus.FAILED" + fullName: "com.azure.communication.callautomation.models.CallingOperationStatus.FAILED" + name: "FAILED" + nameWithType: "CallingOperationStatus.FAILED" + summary: "Static value failed for CallingOperationStatus." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallingOperationStatus FAILED" + desc: "Static value failed for CallingOperationStatus." +- uid: "com.azure.communication.callautomation.models.CallingOperationStatus.NOT_STARTED" + fullName: "com.azure.communication.callautomation.models.CallingOperationStatus.NOT_STARTED" + name: "NOT_STARTED" + nameWithType: "CallingOperationStatus.NOT_STARTED" + summary: "Static value notStarted for CallingOperationStatus." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallingOperationStatus NOT_STARTED" + desc: "Static value notStarted for CallingOperationStatus." +- uid: "com.azure.communication.callautomation.models.CallingOperationStatus.RUNNING" + fullName: "com.azure.communication.callautomation.models.CallingOperationStatus.RUNNING" + name: "RUNNING" + nameWithType: "CallingOperationStatus.RUNNING" + summary: "Static value running for CallingOperationStatus." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final CallingOperationStatus RUNNING" + desc: "Static value running for CallingOperationStatus." +methods: +- uid: "com.azure.communication.callautomation.models.CallingOperationStatus.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.CallingOperationStatus.fromString(String name)" + name: "fromString(String name)" + nameWithType: "CallingOperationStatus.fromString(String name)" + summary: "Creates or finds a CallingOperationStatus from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static CallingOperationStatus fromString(String name)" + desc: "Creates or finds a CallingOperationStatus from its string representation." + returns: + description: "the corresponding CallingOperationStatus." + type: "" +- uid: "com.azure.communication.callautomation.models.CallingOperationStatus.values()" + fullName: "com.azure.communication.callautomation.models.CallingOperationStatus.values()" + name: "values()" + nameWithType: "CallingOperationStatus.values()" + summary: "Return the values." + modifiers: + - "static" + syntax: "public static Collection values()" + desc: "Return the values." + returns: + description: "known CallingOperationStatus values." + type: "Collection<>" +type: "class" +desc: "Defines values for CallingOperationStatus." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingServerError.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingServerError.yml new file mode 100644 index 000000000000..12f23e394274 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingServerError.yml @@ -0,0 +1,79 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallingServerError" +fullName: "com.azure.communication.callautomation.models.CallingServerError" +name: "CallingServerError" +nameWithType: "CallingServerError" +summary: "The Calling Server error." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallingServerError**" +methods: +- uid: "com.azure.communication.callautomation.models.CallingServerError.getCode()" + fullName: "com.azure.communication.callautomation.models.CallingServerError.getCode()" + name: "getCode()" + nameWithType: "CallingServerError.getCode()" + summary: "Get the code property: The error code." + syntax: "public String getCode()" + desc: "Get the code property: The error code." + returns: + description: "the code value." + type: "String" +- uid: "com.azure.communication.callautomation.models.CallingServerError.getDetails()" + fullName: "com.azure.communication.callautomation.models.CallingServerError.getDetails()" + name: "getDetails()" + nameWithType: "CallingServerError.getDetails()" + summary: "Get the details property: Further details about specific errors that led to this error." + syntax: "public List getDetails()" + desc: "Get the details property: Further details about specific errors that led to this error." + returns: + description: "the details value." + type: "List<>" +- uid: "com.azure.communication.callautomation.models.CallingServerError.getInnerError()" + fullName: "com.azure.communication.callautomation.models.CallingServerError.getInnerError()" + name: "getInnerError()" + nameWithType: "CallingServerError.getInnerError()" + summary: "Get the innerError property: The inner error if any." + syntax: "public CallingServerError getInnerError()" + desc: "Get the innerError property: The inner error if any." + returns: + description: "the innerError value." + type: "" +- uid: "com.azure.communication.callautomation.models.CallingServerError.getMessage()" + fullName: "com.azure.communication.callautomation.models.CallingServerError.getMessage()" + name: "getMessage()" + nameWithType: "CallingServerError.getMessage()" + summary: "Get the message property: The error message." + syntax: "public String getMessage()" + desc: "Get the message property: The error message." + returns: + description: "the message value." + type: "String" +- uid: "com.azure.communication.callautomation.models.CallingServerError.getTarget()" + fullName: "com.azure.communication.callautomation.models.CallingServerError.getTarget()" + name: "getTarget()" + nameWithType: "CallingServerError.getTarget()" + summary: "Get the target property: The error target." + syntax: "public String getTarget()" + desc: "Get the target property: The error target." + returns: + description: "the target value." + type: "String" +type: "class" +desc: "The Calling Server error." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingServerErrorException.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingServerErrorException.yml new file mode 100644 index 000000000000..1c423a4fad6e --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CallingServerErrorException.yml @@ -0,0 +1,68 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CallingServerErrorException" +fullName: "com.azure.communication.callautomation.models.CallingServerErrorException" +name: "CallingServerErrorException" +nameWithType: "CallingServerErrorException" +summary: "Exception thrown for an invalid response with information." +inheritances: +- "" +- "" +- "" +- "" +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +- classRef: "java.lang.Throwable" + methodsRef: + - "addSuppressed" + - "fillInStackTrace" + - "getCause" + - "getLocalizedMessage" + - "getMessage" + - "getStackTrace" + - "getSuppressed" + - "initCause" + - "printStackTrace" + - "printStackTrace" + - "printStackTrace" + - "setStackTrace" + - "toString" +syntax: "public final class **CallingServerErrorException**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.CallingServerErrorException.CallingServerErrorException()" + fullName: "com.azure.communication.callautomation.models.CallingServerErrorException.CallingServerErrorException()" + name: "CallingServerErrorException()" + nameWithType: "CallingServerErrorException.CallingServerErrorException()" + summary: "Public constructor" + syntax: "public CallingServerErrorException()" + desc: "Public constructor" +methods: +- uid: "com.azure.communication.callautomation.models.CallingServerErrorException.getValue()" + fullName: "com.azure.communication.callautomation.models.CallingServerErrorException.getValue()" + name: "getValue()" + nameWithType: "CallingServerErrorException.getValue()" + overridden: "com.azure.core.exception.HttpResponseException.getValue()" + syntax: "public CallingServerError getValue()" + returns: + type: "" +type: "class" +desc: "Exception thrown for an invalid response with information." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CollectTonesResult.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CollectTonesResult.yml new file mode 100644 index 000000000000..b204aa18e179 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CollectTonesResult.yml @@ -0,0 +1,59 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CollectTonesResult" +fullName: "com.azure.communication.callautomation.models.CollectTonesResult" +name: "CollectTonesResult" +nameWithType: "CollectTonesResult" +summary: "The CollectTonesResult model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CollectTonesResult**" +constructors: +- uid: "com.azure.communication.callautomation.models.CollectTonesResult.CollectTonesResult()" + fullName: "com.azure.communication.callautomation.models.CollectTonesResult.CollectTonesResult()" + name: "CollectTonesResult()" + nameWithType: "CollectTonesResult.CollectTonesResult()" + syntax: "public CollectTonesResult()" +methods: +- uid: "com.azure.communication.callautomation.models.CollectTonesResult.getTones()" + fullName: "com.azure.communication.callautomation.models.CollectTonesResult.getTones()" + name: "getTones()" + nameWithType: "CollectTonesResult.getTones()" + summary: "Get the tones property: The tones property." + syntax: "public List getTones()" + desc: "Get the tones property: The tones property." + returns: + description: "the tones value." + type: "List<>" +- uid: "com.azure.communication.callautomation.models.CollectTonesResult.setTones(java.util.List)" + fullName: "com.azure.communication.callautomation.models.CollectTonesResult.setTones(List dtmfTones)" + name: "setTones(List dtmfTones)" + nameWithType: "CollectTonesResult.setTones(List dtmfTones)" + summary: "Set the tones property: The tones property." + parameters: + - description: "the tones value to set." + name: "dtmfTones" + type: "List<>" + syntax: "public CollectTonesResult setTones(List dtmfTones)" + desc: "Set the tones property: The tones property." + returns: + description: "the CollectTonesResult object itself." + type: "" +type: "class" +desc: "The CollectTonesResult model." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CreateCallOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CreateCallOptions.yml new file mode 100644 index 000000000000..d6258c846a28 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CreateCallOptions.yml @@ -0,0 +1,149 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CreateCallOptions" +fullName: "com.azure.communication.callautomation.models.CreateCallOptions" +name: "CreateCallOptions" +nameWithType: "CreateCallOptions" +summary: "The options for creating a call." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **CreateCallOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.CreateCallOptions.CreateCallOptions(com.azure.communication.common.CommunicationIdentifier,java.util.List,java.lang.String)" + fullName: "com.azure.communication.callautomation.models.CreateCallOptions.CreateCallOptions(CommunicationIdentifier source, List targets, String callbackUrl)" + name: "CreateCallOptions(CommunicationIdentifier source, List targets, String callbackUrl)" + nameWithType: "CreateCallOptions.CreateCallOptions(CommunicationIdentifier source, List targets, String callbackUrl)" + summary: "Constructor" + parameters: + - description: "The source property." + name: "source" + type: "" + - description: "The targets of the call." + name: "targets" + type: "List<>" + - description: "The call back URI." + name: "callbackUrl" + type: "String" + syntax: "public CreateCallOptions(CommunicationIdentifier source, List targets, String callbackUrl)" + desc: "Constructor" +methods: +- uid: "com.azure.communication.callautomation.models.CreateCallOptions.getCallbackUrl()" + fullName: "com.azure.communication.callautomation.models.CreateCallOptions.getCallbackUrl()" + name: "getCallbackUrl()" + nameWithType: "CreateCallOptions.getCallbackUrl()" + summary: "Get the call back uri." + syntax: "public String getCallbackUrl()" + desc: "Get the call back uri." + returns: + description: "the call back uri." + type: "String" +- uid: "com.azure.communication.callautomation.models.CreateCallOptions.getOperationContext()" + fullName: "com.azure.communication.callautomation.models.CreateCallOptions.getOperationContext()" + name: "getOperationContext()" + nameWithType: "CreateCallOptions.getOperationContext()" + summary: "Get the operationContext: A customer set value used to track the answering of a call." + syntax: "public String getOperationContext()" + desc: "Get the operationContext: A customer set value used to track the answering of a call." + returns: + description: "the operationContext value." + type: "String" +- uid: "com.azure.communication.callautomation.models.CreateCallOptions.getRepeatabilityHeaders()" + fullName: "com.azure.communication.callautomation.models.CreateCallOptions.getRepeatabilityHeaders()" + name: "getRepeatabilityHeaders()" + nameWithType: "CreateCallOptions.getRepeatabilityHeaders()" + summary: "Get the Repeatability headers configuration." + syntax: "public RepeatabilityHeaders getRepeatabilityHeaders()" + desc: "Get the Repeatability headers configuration." + returns: + description: "the repeatabilityHeaders" + type: "" +- uid: "com.azure.communication.callautomation.models.CreateCallOptions.getSource()" + fullName: "com.azure.communication.callautomation.models.CreateCallOptions.getSource()" + name: "getSource()" + nameWithType: "CreateCallOptions.getSource()" + summary: "Get the source." + syntax: "public CommunicationIdentifier getSource()" + desc: "Get the source." + returns: + description: "the source value." + type: "" +- uid: "com.azure.communication.callautomation.models.CreateCallOptions.getSourceCallerId()" + fullName: "com.azure.communication.callautomation.models.CreateCallOptions.getSourceCallerId()" + name: "getSourceCallerId()" + nameWithType: "CreateCallOptions.getSourceCallerId()" + summary: "Get the source caller Id that's shown to the PSTN participant being invited." + syntax: "public String getSourceCallerId()" + desc: "Get the source caller Id that's shown to the PSTN participant being invited." + returns: + description: "the sourceCallerId value." + type: "String" +- uid: "com.azure.communication.callautomation.models.CreateCallOptions.getTargets()" + fullName: "com.azure.communication.callautomation.models.CreateCallOptions.getTargets()" + name: "getTargets()" + nameWithType: "CreateCallOptions.getTargets()" + summary: "Get the targets." + syntax: "public List getTargets()" + desc: "Get the targets." + returns: + description: "the targets list." + type: "List<>" +- uid: "com.azure.communication.callautomation.models.CreateCallOptions.setOperationContext(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.CreateCallOptions.setOperationContext(String operationContext)" + name: "setOperationContext(String operationContext)" + nameWithType: "CreateCallOptions.setOperationContext(String operationContext)" + summary: "Set the operationContext: A customer set value used to track the answering of a call." + parameters: + - description: "A customer set value used to track the answering of a call." + name: "operationContext" + type: "String" + syntax: "public CreateCallOptions setOperationContext(String operationContext)" + desc: "Set the operationContext: A customer set value used to track the answering of a call." + returns: + description: "the CreateCallOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.CreateCallOptions.setRepeatabilityHeaders(com.azure.communication.callautomation.models.RepeatabilityHeaders)" + fullName: "com.azure.communication.callautomation.models.CreateCallOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + name: "setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + nameWithType: "CreateCallOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + summary: "Set the repeatability headers" + parameters: + - description: "The repeatability headers configuration." + name: "repeatabilityHeaders" + type: "" + syntax: "public CreateCallOptions setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + desc: "Set the repeatability headers" + returns: + description: "the CreateCallOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.CreateCallOptions.setSourceCallerId(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.CreateCallOptions.setSourceCallerId(String sourceCallerId)" + name: "setSourceCallerId(String sourceCallerId)" + nameWithType: "CreateCallOptions.setSourceCallerId(String sourceCallerId)" + summary: "Set the sourceCallerId." + parameters: + - description: "The source caller Id that's shown to the PSTN participant being invited.\n Required only when inviting a PSTN participant." + name: "sourceCallerId" + type: "String" + syntax: "public CreateCallOptions setSourceCallerId(String sourceCallerId)" + desc: "Set the sourceCallerId." + returns: + description: "the CreateCallOptions object itself." + type: "" +type: "class" +desc: "The options for creating a call." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CreateCallResult.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CreateCallResult.yml new file mode 100644 index 000000000000..8ed595e2f773 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.CreateCallResult.yml @@ -0,0 +1,52 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.CreateCallResult" +fullName: "com.azure.communication.callautomation.models.CreateCallResult" +name: "CreateCallResult" +nameWithType: "CreateCallResult" +summary: "The result of answering a call" +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **CreateCallResult**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.CreateCallResult.CreateCallResult(com.azure.communication.callautomation.models.CallConnectionProperties,com.azure.communication.callautomation.CallConnection,com.azure.communication.callautomation.CallConnectionAsync)" + fullName: "com.azure.communication.callautomation.models.CreateCallResult.CreateCallResult(CallConnectionProperties callConnectionProperties, CallConnection callConnection, CallConnectionAsync callConnectionAsync)" + name: "CreateCallResult(CallConnectionProperties callConnectionProperties, CallConnection callConnection, CallConnectionAsync callConnectionAsync)" + nameWithType: "CreateCallResult.CreateCallResult(CallConnectionProperties callConnectionProperties, CallConnection callConnection, CallConnectionAsync callConnectionAsync)" + summary: "Constructor" + parameters: + - description: "The callConnectionProperties" + name: "callConnectionProperties" + type: "" + - description: "The callConnection" + name: "callConnection" + type: "" + - description: "The callConnectionAsync" + name: "callConnectionAsync" + type: "" + syntax: "public CreateCallResult(CallConnectionProperties callConnectionProperties, CallConnection callConnection, CallConnectionAsync callConnectionAsync)" + desc: "Constructor" +type: "class" +desc: "The result of answering a call" +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.DownloadToFileOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.DownloadToFileOptions.yml new file mode 100644 index 000000000000..0d7c20cfcb6f --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.DownloadToFileOptions.yml @@ -0,0 +1,83 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.DownloadToFileOptions" +fullName: "com.azure.communication.callautomation.models.DownloadToFileOptions" +name: "DownloadToFileOptions" +nameWithType: "DownloadToFileOptions" +summary: "The options for the downloadTo operations." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **DownloadToFileOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.DownloadToFileOptions.DownloadToFileOptions()" + fullName: "com.azure.communication.callautomation.models.DownloadToFileOptions.DownloadToFileOptions()" + name: "DownloadToFileOptions()" + nameWithType: "DownloadToFileOptions.DownloadToFileOptions()" + syntax: "public DownloadToFileOptions()" +methods: +- uid: "com.azure.communication.callautomation.models.DownloadToFileOptions.getParallelDownloadOptions()" + fullName: "com.azure.communication.callautomation.models.DownloadToFileOptions.getParallelDownloadOptions()" + name: "getParallelDownloadOptions()" + nameWithType: "DownloadToFileOptions.getParallelDownloadOptions()" + summary: "Get the ParallelDownloadOptions" + syntax: "public ParallelDownloadOptions getParallelDownloadOptions()" + desc: "Get the ParallelDownloadOptions" + returns: + description: "ParallelDownloadOptions" + type: "" +- uid: "com.azure.communication.callautomation.models.DownloadToFileOptions.isOverwrite()" + fullName: "com.azure.communication.callautomation.models.DownloadToFileOptions.isOverwrite()" + name: "isOverwrite()" + nameWithType: "DownloadToFileOptions.isOverwrite()" + summary: "Overwrite value." + syntax: "public boolean isOverwrite()" + desc: "Overwrite value." + returns: + description: "the overwrite value." + type: "" +- uid: "com.azure.communication.callautomation.models.DownloadToFileOptions.setOverwrite(boolean)" + fullName: "com.azure.communication.callautomation.models.DownloadToFileOptions.setOverwrite(boolean overwrite)" + name: "setOverwrite(boolean overwrite)" + nameWithType: "DownloadToFileOptions.setOverwrite(boolean overwrite)" + summary: "Set the overwrite value." + parameters: + - description: "the overwrite value." + name: "overwrite" + type: "" + syntax: "public DownloadToFileOptions setOverwrite(boolean overwrite)" + desc: "Set the overwrite value." + returns: + description: "the DownloadToOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.DownloadToFileOptions.setParallelDownloadOptions(com.azure.communication.callautomation.models.ParallelDownloadOptions)" + fullName: "com.azure.communication.callautomation.models.DownloadToFileOptions.setParallelDownloadOptions(ParallelDownloadOptions parallelDownloadOptions)" + name: "setParallelDownloadOptions(ParallelDownloadOptions parallelDownloadOptions)" + nameWithType: "DownloadToFileOptions.setParallelDownloadOptions(ParallelDownloadOptions parallelDownloadOptions)" + summary: "Set the parallel download options." + parameters: + - description: "parallel download options." + name: "parallelDownloadOptions" + type: "" + syntax: "public DownloadToFileOptions setParallelDownloadOptions(ParallelDownloadOptions parallelDownloadOptions)" + desc: "Set the parallel download options." + returns: + description: "the DownloadToOptions object itself." + type: "" +type: "class" +desc: "The options for the downloadTo operations." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.DtmfTone.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.DtmfTone.yml new file mode 100644 index 000000000000..eeaae8a6ffd2 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.DtmfTone.yml @@ -0,0 +1,259 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.DtmfTone" +fullName: "com.azure.communication.callautomation.models.DtmfTone" +name: "DtmfTone" +nameWithType: "DtmfTone" +summary: "Defines values for Tone." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **DtmfTone**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.DtmfTone.DtmfTone()" + fullName: "com.azure.communication.callautomation.models.DtmfTone.DtmfTone()" + name: "DtmfTone()" + nameWithType: "DtmfTone.DtmfTone()" + syntax: "public DtmfTone()" +fields: +- uid: "com.azure.communication.callautomation.models.DtmfTone.A" + fullName: "com.azure.communication.callautomation.models.DtmfTone.A" + name: "A" + nameWithType: "DtmfTone.A" + summary: "Static value a for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone A" + desc: "Static value a for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.ASTERISK" + fullName: "com.azure.communication.callautomation.models.DtmfTone.ASTERISK" + name: "ASTERISK" + nameWithType: "DtmfTone.ASTERISK" + summary: "Static value asterisk for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone ASTERISK" + desc: "Static value asterisk for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.B" + fullName: "com.azure.communication.callautomation.models.DtmfTone.B" + name: "B" + nameWithType: "DtmfTone.B" + summary: "Static value b for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone B" + desc: "Static value b for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.C" + fullName: "com.azure.communication.callautomation.models.DtmfTone.C" + name: "C" + nameWithType: "DtmfTone.C" + summary: "Static value c for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone C" + desc: "Static value c for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.D" + fullName: "com.azure.communication.callautomation.models.DtmfTone.D" + name: "D" + nameWithType: "DtmfTone.D" + summary: "Static value d for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone D" + desc: "Static value d for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.EIGHT" + fullName: "com.azure.communication.callautomation.models.DtmfTone.EIGHT" + name: "EIGHT" + nameWithType: "DtmfTone.EIGHT" + summary: "Static value eight for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone EIGHT" + desc: "Static value eight for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.FIVE" + fullName: "com.azure.communication.callautomation.models.DtmfTone.FIVE" + name: "FIVE" + nameWithType: "DtmfTone.FIVE" + summary: "Static value five for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone FIVE" + desc: "Static value five for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.FOUR" + fullName: "com.azure.communication.callautomation.models.DtmfTone.FOUR" + name: "FOUR" + nameWithType: "DtmfTone.FOUR" + summary: "Static value four for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone FOUR" + desc: "Static value four for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.NINE" + fullName: "com.azure.communication.callautomation.models.DtmfTone.NINE" + name: "NINE" + nameWithType: "DtmfTone.NINE" + summary: "Static value nine for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone NINE" + desc: "Static value nine for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.ONE" + fullName: "com.azure.communication.callautomation.models.DtmfTone.ONE" + name: "ONE" + nameWithType: "DtmfTone.ONE" + summary: "Static value one for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone ONE" + desc: "Static value one for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.POUND" + fullName: "com.azure.communication.callautomation.models.DtmfTone.POUND" + name: "POUND" + nameWithType: "DtmfTone.POUND" + summary: "Static value pound for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone POUND" + desc: "Static value pound for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.SEVEN" + fullName: "com.azure.communication.callautomation.models.DtmfTone.SEVEN" + name: "SEVEN" + nameWithType: "DtmfTone.SEVEN" + summary: "Static value seven for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone SEVEN" + desc: "Static value seven for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.SIX" + fullName: "com.azure.communication.callautomation.models.DtmfTone.SIX" + name: "SIX" + nameWithType: "DtmfTone.SIX" + summary: "Static value six for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone SIX" + desc: "Static value six for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.THREE" + fullName: "com.azure.communication.callautomation.models.DtmfTone.THREE" + name: "THREE" + nameWithType: "DtmfTone.THREE" + summary: "Static value three for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone THREE" + desc: "Static value three for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.TWO" + fullName: "com.azure.communication.callautomation.models.DtmfTone.TWO" + name: "TWO" + nameWithType: "DtmfTone.TWO" + summary: "Static value two for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone TWO" + desc: "Static value two for Tone." +- uid: "com.azure.communication.callautomation.models.DtmfTone.ZERO" + fullName: "com.azure.communication.callautomation.models.DtmfTone.ZERO" + name: "ZERO" + nameWithType: "DtmfTone.ZERO" + summary: "Static value zero for Tone." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DtmfTone ZERO" + desc: "Static value zero for Tone." +methods: +- uid: "com.azure.communication.callautomation.models.DtmfTone.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.DtmfTone.fromString(String name)" + name: "fromString(String name)" + nameWithType: "DtmfTone.fromString(String name)" + summary: "Creates or finds a Tone from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static DtmfTone fromString(String name)" + desc: "Creates or finds a Tone from its string representation." + returns: + description: "the corresponding Tone." + type: "" +- uid: "com.azure.communication.callautomation.models.DtmfTone.values()" + fullName: "com.azure.communication.callautomation.models.DtmfTone.values()" + name: "values()" + nameWithType: "DtmfTone.values()" + modifiers: + - "static" + syntax: "public static Collection values()" + returns: + description: "known Tone values." + type: "Collection<>" +type: "class" +desc: "Defines values for Tone." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.FileSource.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.FileSource.yml new file mode 100644 index 000000000000..4019caadf6c7 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.FileSource.yml @@ -0,0 +1,64 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.FileSource" +fullName: "com.azure.communication.callautomation.models.FileSource" +name: "FileSource" +nameWithType: "FileSource" +summary: "The FileSource model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **FileSource**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.FileSource.FileSource()" + fullName: "com.azure.communication.callautomation.models.FileSource.FileSource()" + name: "FileSource()" + nameWithType: "FileSource.FileSource()" + syntax: "public FileSource()" +methods: +- uid: "com.azure.communication.callautomation.models.FileSource.getUri()" + fullName: "com.azure.communication.callautomation.models.FileSource.getUri()" + name: "getUri()" + nameWithType: "FileSource.getUri()" + summary: "Get the uri property: Uri for the audio file to be played." + syntax: "public String getUri()" + desc: "Get the uri property: Uri for the audio file to be played." + returns: + description: "the uri value." + type: "String" +- uid: "com.azure.communication.callautomation.models.FileSource.setUri(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.FileSource.setUri(String uri)" + name: "setUri(String uri)" + nameWithType: "FileSource.setUri(String uri)" + summary: "Set the uri property: Uri for the audio file to be played." + parameters: + - description: "the uri value to set." + name: "uri" + type: "String" + syntax: "public FileSource setUri(String uri)" + desc: "Set the uri property: Uri for the audio file to be played." + returns: + description: "the FileSourceInternal object itself." + type: "" +type: "class" +desc: "The FileSource model." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.GroupCallLocator.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.GroupCallLocator.yml new file mode 100644 index 000000000000..9144f29a65c1 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.GroupCallLocator.yml @@ -0,0 +1,55 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.GroupCallLocator" +fullName: "com.azure.communication.callautomation.models.GroupCallLocator" +name: "GroupCallLocator" +nameWithType: "GroupCallLocator" +summary: "The locator used for joining or taking action on a call." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **GroupCallLocator**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.GroupCallLocator.GroupCallLocator(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.GroupCallLocator.GroupCallLocator(String groupCallId)" + name: "GroupCallLocator(String groupCallId)" + nameWithType: "GroupCallLocator.GroupCallLocator(String groupCallId)" + summary: "Group call locator" + parameters: + - description: "Specify the group call id." + name: "groupCallId" + type: "String" + syntax: "public GroupCallLocator(String groupCallId)" + desc: "Group call locator" +methods: +- uid: "com.azure.communication.callautomation.models.GroupCallLocator.getGroupCallId()" + fullName: "com.azure.communication.callautomation.models.GroupCallLocator.getGroupCallId()" + name: "getGroupCallId()" + nameWithType: "GroupCallLocator.getGroupCallId()" + summary: "Get the groupCallId property: The group call id." + syntax: "public String getGroupCallId()" + desc: "Get the groupCallId property: The group call id." + returns: + description: "the groupCallId value." + type: "String" +type: "class" +desc: "The locator used for joining or taking action on a call." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.HangUpOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.HangUpOptions.yml new file mode 100644 index 000000000000..19139ff3b528 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.HangUpOptions.yml @@ -0,0 +1,75 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.HangUpOptions" +fullName: "com.azure.communication.callautomation.models.HangUpOptions" +name: "HangUpOptions" +nameWithType: "HangUpOptions" +summary: "The options for creating a call." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **HangUpOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.HangUpOptions.HangUpOptions(boolean)" + fullName: "com.azure.communication.callautomation.models.HangUpOptions.HangUpOptions(boolean isForEveryone)" + name: "HangUpOptions(boolean isForEveryone)" + nameWithType: "HangUpOptions.HangUpOptions(boolean isForEveryone)" + summary: "Constructor" + parameters: + - description: "Boolean to determine if the call should be terminated for all participants." + name: "isForEveryone" + type: "" + syntax: "public HangUpOptions(boolean isForEveryone)" + desc: "Constructor" +methods: +- uid: "com.azure.communication.callautomation.models.HangUpOptions.getIsForEveryone()" + fullName: "com.azure.communication.callautomation.models.HangUpOptions.getIsForEveryone()" + name: "getIsForEveryone()" + nameWithType: "HangUpOptions.getIsForEveryone()" + summary: "Get the boolean to determine if the call should be terminated for all participants." + syntax: "public boolean getIsForEveryone()" + desc: "Get the boolean to determine if the call should be terminated for all participants." + returns: + description: "the isForEveryone." + type: "" +- uid: "com.azure.communication.callautomation.models.HangUpOptions.getRepeatabilityHeaders()" + fullName: "com.azure.communication.callautomation.models.HangUpOptions.getRepeatabilityHeaders()" + name: "getRepeatabilityHeaders()" + nameWithType: "HangUpOptions.getRepeatabilityHeaders()" + summary: "Get the Repeatability headers configuration." + syntax: "public RepeatabilityHeaders getRepeatabilityHeaders()" + desc: "Get the Repeatability headers configuration." + returns: + description: "the repeatabilityHeaders" + type: "" +- uid: "com.azure.communication.callautomation.models.HangUpOptions.setRepeatabilityHeaders(com.azure.communication.callautomation.models.RepeatabilityHeaders)" + fullName: "com.azure.communication.callautomation.models.HangUpOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + name: "setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + nameWithType: "HangUpOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + summary: "Set the repeatability headers" + parameters: + - description: "The repeatability headers configuration." + name: "repeatabilityHeaders" + type: "" + syntax: "public HangUpOptions setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + desc: "Set the repeatability headers" + returns: + description: "the HangUpOptions object itself." + type: "" +type: "class" +desc: "The options for creating a call." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.ListParticipantsResult.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.ListParticipantsResult.yml new file mode 100644 index 000000000000..12e84b18d45a --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.ListParticipantsResult.yml @@ -0,0 +1,47 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.ListParticipantsResult" +fullName: "com.azure.communication.callautomation.models.ListParticipantsResult" +name: "ListParticipantsResult" +nameWithType: "ListParticipantsResult" +summary: "The ListParticipantsResult model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **ListParticipantsResult**" +constructors: +- uid: "com.azure.communication.callautomation.models.ListParticipantsResult.ListParticipantsResult()" + fullName: "com.azure.communication.callautomation.models.ListParticipantsResult.ListParticipantsResult()" + name: "ListParticipantsResult()" + nameWithType: "ListParticipantsResult.ListParticipantsResult()" + summary: "Public constructor." + syntax: "public ListParticipantsResult()" + desc: "Public constructor." +methods: +- uid: "com.azure.communication.callautomation.models.ListParticipantsResult.getValues()" + fullName: "com.azure.communication.callautomation.models.ListParticipantsResult.getValues()" + name: "getValues()" + nameWithType: "ListParticipantsResult.getValues()" + summary: "Get the values property: The list of participants in the call." + syntax: "public List getValues()" + desc: "Get the values property: The list of participants in the call." + returns: + description: "The list of participants in the call." + type: "List<>" +type: "class" +desc: "The ListParticipantsResult model." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.ParallelDownloadOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.ParallelDownloadOptions.yml new file mode 100644 index 000000000000..605e66d7fe46 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.ParallelDownloadOptions.yml @@ -0,0 +1,107 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.ParallelDownloadOptions" +fullName: "com.azure.communication.callautomation.models.ParallelDownloadOptions" +name: "ParallelDownloadOptions" +nameWithType: "ParallelDownloadOptions" +summary: "This class contains configuration used to parallelize data transfer operations." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **ParallelDownloadOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.ParallelDownloadOptions.ParallelDownloadOptions()" + fullName: "com.azure.communication.callautomation.models.ParallelDownloadOptions.ParallelDownloadOptions()" + name: "ParallelDownloadOptions()" + nameWithType: "ParallelDownloadOptions.ParallelDownloadOptions()" + summary: "Creates a new with default parameters applied." + syntax: "public ParallelDownloadOptions()" + desc: "Creates a new with default parameters applied." +methods: +- uid: "com.azure.communication.callautomation.models.ParallelDownloadOptions.getBlockSize()" + fullName: "com.azure.communication.callautomation.models.ParallelDownloadOptions.getBlockSize()" + name: "getBlockSize()" + nameWithType: "ParallelDownloadOptions.getBlockSize()" + summary: "Gets the block size (chunk size) to transfer at a time." + syntax: "public Long getBlockSize()" + desc: "Gets the block size (chunk size) to transfer at a time." + returns: + description: "The block size." + type: "Long" +- uid: "com.azure.communication.callautomation.models.ParallelDownloadOptions.getMaxConcurrency()" + fullName: "com.azure.communication.callautomation.models.ParallelDownloadOptions.getMaxConcurrency()" + name: "getMaxConcurrency()" + nameWithType: "ParallelDownloadOptions.getMaxConcurrency()" + summary: "Gets the maximum number of parallel requests that will be issued at any given time." + syntax: "public int getMaxConcurrency()" + desc: "Gets the maximum number of parallel requests that will be issued at any given time." + returns: + description: "The max concurrency value." + type: "" +- uid: "com.azure.communication.callautomation.models.ParallelDownloadOptions.getProgressListener()" + fullName: "com.azure.communication.callautomation.models.ParallelDownloadOptions.getProgressListener()" + name: "getProgressListener()" + nameWithType: "ParallelDownloadOptions.getProgressListener()" + summary: "Gets the Progress listener for parallel reporting" + syntax: "public ProgressListener getProgressListener()" + desc: "Gets the Progress listener for parallel reporting" + returns: + description: "The progress listener" + type: "" +- uid: "com.azure.communication.callautomation.models.ParallelDownloadOptions.setBlockSize(long)" + fullName: "com.azure.communication.callautomation.models.ParallelDownloadOptions.setBlockSize(long blockSize)" + name: "setBlockSize(long blockSize)" + nameWithType: "ParallelDownloadOptions.setBlockSize(long blockSize)" + summary: "Sets the block size." + parameters: + - description: "The block size." + name: "blockSize" + type: "" + syntax: "public ParallelDownloadOptions setBlockSize(long blockSize)" + desc: "Sets the block size. The block size is the size of each data chunk returned from the service. For both applications, If block size is large, download will make fewer network calls, but each individual call will receive more data and will therefore take longer." + returns: + description: "The ParallelDownloadOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.ParallelDownloadOptions.setMaxConcurrency(int)" + fullName: "com.azure.communication.callautomation.models.ParallelDownloadOptions.setMaxConcurrency(int maxConcurrency)" + name: "setMaxConcurrency(int maxConcurrency)" + nameWithType: "ParallelDownloadOptions.setMaxConcurrency(int maxConcurrency)" + parameters: + - description: "The maximum number of parallel requests that will be issued at any given time as a part of\n a single parallel transfer. This value applies per api. For example, if two calls to downloadTo are made at\n the same time, and each specifies a maxConcurrency of 5, there may be up to 10 outstanding, concurrent requests,\n up to 5 for each of the upload operations.\n The amount of memory consumed by methods which buffer may be up to blockSize * maxConcurrency." + name: "maxConcurrency" + type: "" + syntax: "public ParallelDownloadOptions setMaxConcurrency(int maxConcurrency)" + returns: + description: "The ParallelDownloadOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.ParallelDownloadOptions.setProgressReceiver(com.azure.core.util.ProgressListener)" + fullName: "com.azure.communication.callautomation.models.ParallelDownloadOptions.setProgressReceiver(ProgressListener progressListener)" + name: "setProgressReceiver(ProgressListener progressListener)" + nameWithType: "ParallelDownloadOptions.setProgressReceiver(ProgressListener progressListener)" + summary: "Sets the ." + parameters: + - description: "The ." + name: "progressListener" + type: "" + syntax: "public ParallelDownloadOptions setProgressReceiver(ProgressListener progressListener)" + desc: "Sets the ." + returns: + description: "The ParallelDownloadOptions object itself." + type: "" +type: "class" +desc: "This class contains configuration used to parallelize data transfer operations. Note that not all values are used by every method which accepts this type. Please refer to the javadoc on specific methods for these cases." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlayOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlayOptions.yml new file mode 100644 index 000000000000..f375a46a2f12 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlayOptions.yml @@ -0,0 +1,83 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.PlayOptions" +fullName: "com.azure.communication.callautomation.models.PlayOptions" +name: "PlayOptions" +nameWithType: "PlayOptions" +summary: "The PlayOptionsInternal model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **PlayOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.PlayOptions.PlayOptions()" + fullName: "com.azure.communication.callautomation.models.PlayOptions.PlayOptions()" + name: "PlayOptions()" + nameWithType: "PlayOptions.PlayOptions()" + syntax: "public PlayOptions()" +methods: +- uid: "com.azure.communication.callautomation.models.PlayOptions.getOperationContext()" + fullName: "com.azure.communication.callautomation.models.PlayOptions.getOperationContext()" + name: "getOperationContext()" + nameWithType: "PlayOptions.getOperationContext()" + summary: "Get the operationContext property." + syntax: "public String getOperationContext()" + desc: "Get the operationContext property." + returns: + description: "the operationContext value." + type: "String" +- uid: "com.azure.communication.callautomation.models.PlayOptions.isLoop()" + fullName: "com.azure.communication.callautomation.models.PlayOptions.isLoop()" + name: "isLoop()" + nameWithType: "PlayOptions.isLoop()" + summary: "Get the loop property: The option to play the provided audio source in loop when set to true." + syntax: "public boolean isLoop()" + desc: "Get the loop property: The option to play the provided audio source in loop when set to true." + returns: + description: "the loop value." + type: "" +- uid: "com.azure.communication.callautomation.models.PlayOptions.setLoop(boolean)" + fullName: "com.azure.communication.callautomation.models.PlayOptions.setLoop(boolean loop)" + name: "setLoop(boolean loop)" + nameWithType: "PlayOptions.setLoop(boolean loop)" + summary: "Set the loop property: The option to play the provided audio source in loop when set to true." + parameters: + - description: "the loop value to set." + name: "loop" + type: "" + syntax: "public PlayOptions setLoop(boolean loop)" + desc: "Set the loop property: The option to play the provided audio source in loop when set to true." + returns: + description: "the PlayOptionsInternal object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.PlayOptions.setOperationContext(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.PlayOptions.setOperationContext(String operationContext)" + name: "setOperationContext(String operationContext)" + nameWithType: "PlayOptions.setOperationContext(String operationContext)" + summary: "Set the operationContext property." + parameters: + - description: "the operationContext value to set." + name: "operationContext" + type: "String" + syntax: "public PlayOptions setOperationContext(String operationContext)" + desc: "Set the operationContext property." + returns: + description: "the PlayOptionsInternal object itself." + type: "" +type: "class" +desc: "The PlayOptionsInternal model." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlaySource.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlaySource.yml new file mode 100644 index 000000000000..8e35403bc3cd --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlaySource.yml @@ -0,0 +1,59 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.PlaySource" +fullName: "com.azure.communication.callautomation.models.PlaySource" +name: "PlaySource" +nameWithType: "PlaySource" +summary: "The PlaySource model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public abstract class **PlaySource**" +constructors: +- uid: "com.azure.communication.callautomation.models.PlaySource.PlaySource()" + fullName: "com.azure.communication.callautomation.models.PlaySource.PlaySource()" + name: "PlaySource()" + nameWithType: "PlaySource.PlaySource()" + syntax: "public PlaySource()" +methods: +- uid: "com.azure.communication.callautomation.models.PlaySource.getPlaySourceId()" + fullName: "com.azure.communication.callautomation.models.PlaySource.getPlaySourceId()" + name: "getPlaySourceId()" + nameWithType: "PlaySource.getPlaySourceId()" + summary: "Get the playSourceId property: Defines the identifier to be used for caching related media." + syntax: "public String getPlaySourceId()" + desc: "Get the playSourceId property: Defines the identifier to be used for caching related media." + returns: + description: "the playSourceId value." + type: "String" +- uid: "com.azure.communication.callautomation.models.PlaySource.setPlaySourceId(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.PlaySource.setPlaySourceId(String playSourceId)" + name: "setPlaySourceId(String playSourceId)" + nameWithType: "PlaySource.setPlaySourceId(String playSourceId)" + summary: "Set the playSourceId property: Defines the identifier to be used for caching related media." + parameters: + - description: "the playSourceId value to set." + name: "playSourceId" + type: "String" + syntax: "public PlaySource setPlaySourceId(String playSourceId)" + desc: "Set the playSourceId property: Defines the identifier to be used for caching related media." + returns: + description: "the PlaySourceInternal object itself." + type: "" +type: "class" +desc: "The PlaySource model." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlaySourceType.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlaySourceType.yml new file mode 100644 index 000000000000..f3f8b2fc85c3 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.PlaySourceType.yml @@ -0,0 +1,79 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.PlaySourceType" +fullName: "com.azure.communication.callautomation.models.PlaySourceType" +name: "PlaySourceType" +nameWithType: "PlaySourceType" +summary: "Defines values for PlaySourceType." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **PlaySourceType**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.PlaySourceType.PlaySourceType()" + fullName: "com.azure.communication.callautomation.models.PlaySourceType.PlaySourceType()" + name: "PlaySourceType()" + nameWithType: "PlaySourceType.PlaySourceType()" + syntax: "public PlaySourceType()" +fields: +- uid: "com.azure.communication.callautomation.models.PlaySourceType.FILE" + fullName: "com.azure.communication.callautomation.models.PlaySourceType.FILE" + name: "FILE" + nameWithType: "PlaySourceType.FILE" + summary: "Static value file for PlaySourceType." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final PlaySourceType FILE" + desc: "Static value file for PlaySourceType." +methods: +- uid: "com.azure.communication.callautomation.models.PlaySourceType.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.PlaySourceType.fromString(String name)" + name: "fromString(String name)" + nameWithType: "PlaySourceType.fromString(String name)" + summary: "Creates or finds a PlaySourceType from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static PlaySourceType fromString(String name)" + desc: "Creates or finds a PlaySourceType from its string representation." + returns: + description: "the corresponding PlaySourceType." + type: "" +- uid: "com.azure.communication.callautomation.models.PlaySourceType.values()" + fullName: "com.azure.communication.callautomation.models.PlaySourceType.values()" + name: "values()" + nameWithType: "PlaySourceType.values()" + modifiers: + - "static" + syntax: "public static Collection values()" + returns: + description: "known PlaySourceType values." + type: "Collection<>" +type: "class" +desc: "Defines values for PlaySourceType." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecognizeInputType.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecognizeInputType.yml new file mode 100644 index 000000000000..a817a3844ba4 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecognizeInputType.yml @@ -0,0 +1,79 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RecognizeInputType" +fullName: "com.azure.communication.callautomation.models.RecognizeInputType" +name: "RecognizeInputType" +nameWithType: "RecognizeInputType" +summary: "Defines values for RecognizeInputTypeInternal." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecognizeInputType**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.RecognizeInputType.RecognizeInputType()" + fullName: "com.azure.communication.callautomation.models.RecognizeInputType.RecognizeInputType()" + name: "RecognizeInputType()" + nameWithType: "RecognizeInputType.RecognizeInputType()" + syntax: "public RecognizeInputType()" +fields: +- uid: "com.azure.communication.callautomation.models.RecognizeInputType.DTMF" + fullName: "com.azure.communication.callautomation.models.RecognizeInputType.DTMF" + name: "DTMF" + nameWithType: "RecognizeInputType.DTMF" + summary: "Static value dtmf for RecognizeInputTypeInternal." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final RecognizeInputType DTMF" + desc: "Static value dtmf for RecognizeInputTypeInternal." +methods: +- uid: "com.azure.communication.callautomation.models.RecognizeInputType.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.RecognizeInputType.fromString(String name)" + name: "fromString(String name)" + nameWithType: "RecognizeInputType.fromString(String name)" + summary: "Creates or finds a RecognizeInputTypeInternal from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static RecognizeInputType fromString(String name)" + desc: "Creates or finds a RecognizeInputTypeInternal from its string representation." + returns: + description: "the corresponding RecognizeInputTypeInternal." + type: "" +- uid: "com.azure.communication.callautomation.models.RecognizeInputType.values()" + fullName: "com.azure.communication.callautomation.models.RecognizeInputType.values()" + name: "values()" + nameWithType: "RecognizeInputType.values()" + modifiers: + - "static" + syntax: "public static Collection values()" + returns: + description: "known RecognizeInputTypeInternal values." + type: "Collection<>" +type: "class" +desc: "Defines values for RecognizeInputTypeInternal." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingChannel.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingChannel.yml new file mode 100644 index 000000000000..415815effb77 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingChannel.yml @@ -0,0 +1,91 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RecordingChannel" +fullName: "com.azure.communication.callautomation.models.RecordingChannel" +name: "RecordingChannel" +nameWithType: "RecordingChannel" +summary: "Defines values for RecordingChannel." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecordingChannel**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.RecordingChannel.RecordingChannel()" + fullName: "com.azure.communication.callautomation.models.RecordingChannel.RecordingChannel()" + name: "RecordingChannel()" + nameWithType: "RecordingChannel.RecordingChannel()" + syntax: "public RecordingChannel()" +fields: +- uid: "com.azure.communication.callautomation.models.RecordingChannel.MIXED" + fullName: "com.azure.communication.callautomation.models.RecordingChannel.MIXED" + name: "MIXED" + nameWithType: "RecordingChannel.MIXED" + summary: "Static value mixed for RecordingChannel." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final RecordingChannel MIXED" + desc: "Static value mixed for RecordingChannel." +- uid: "com.azure.communication.callautomation.models.RecordingChannel.UNMIXED" + fullName: "com.azure.communication.callautomation.models.RecordingChannel.UNMIXED" + name: "UNMIXED" + nameWithType: "RecordingChannel.UNMIXED" + summary: "Static value unmixed for RecordingChannel." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final RecordingChannel UNMIXED" + desc: "Static value unmixed for RecordingChannel." +methods: +- uid: "com.azure.communication.callautomation.models.RecordingChannel.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.RecordingChannel.fromString(String name)" + name: "fromString(String name)" + nameWithType: "RecordingChannel.fromString(String name)" + summary: "Creates or finds a RecordingChannel from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static RecordingChannel fromString(String name)" + desc: "Creates or finds a RecordingChannel from its string representation." + returns: + description: "the corresponding RecordingChannel." + type: "" +- uid: "com.azure.communication.callautomation.models.RecordingChannel.values()" + fullName: "com.azure.communication.callautomation.models.RecordingChannel.values()" + name: "values()" + nameWithType: "RecordingChannel.values()" + modifiers: + - "static" + syntax: "public static Collection values()" + returns: + description: "known RecordingChannel values." + type: "Collection<>" +type: "class" +desc: "Defines values for RecordingChannel." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingContent.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingContent.yml new file mode 100644 index 000000000000..9155081e6bd1 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingContent.yml @@ -0,0 +1,91 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RecordingContent" +fullName: "com.azure.communication.callautomation.models.RecordingContent" +name: "RecordingContent" +nameWithType: "RecordingContent" +summary: "Defines values for RecordingContent." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecordingContent**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.RecordingContent.RecordingContent()" + fullName: "com.azure.communication.callautomation.models.RecordingContent.RecordingContent()" + name: "RecordingContent()" + nameWithType: "RecordingContent.RecordingContent()" + syntax: "public RecordingContent()" +fields: +- uid: "com.azure.communication.callautomation.models.RecordingContent.AUDIO" + fullName: "com.azure.communication.callautomation.models.RecordingContent.AUDIO" + name: "AUDIO" + nameWithType: "RecordingContent.AUDIO" + summary: "Static value audio for RecordingContent." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final RecordingContent AUDIO" + desc: "Static value audio for RecordingContent." +- uid: "com.azure.communication.callautomation.models.RecordingContent.AUDIO_VIDEO" + fullName: "com.azure.communication.callautomation.models.RecordingContent.AUDIO_VIDEO" + name: "AUDIO_VIDEO" + nameWithType: "RecordingContent.AUDIO_VIDEO" + summary: "Static value audioVideo for RecordingContent." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final RecordingContent AUDIO_VIDEO" + desc: "Static value audioVideo for RecordingContent." +methods: +- uid: "com.azure.communication.callautomation.models.RecordingContent.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.RecordingContent.fromString(String name)" + name: "fromString(String name)" + nameWithType: "RecordingContent.fromString(String name)" + summary: "Creates or finds a RecordingContent from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static RecordingContent fromString(String name)" + desc: "Creates or finds a RecordingContent from its string representation." + returns: + description: "the corresponding RecordingContent." + type: "" +- uid: "com.azure.communication.callautomation.models.RecordingContent.values()" + fullName: "com.azure.communication.callautomation.models.RecordingContent.values()" + name: "values()" + nameWithType: "RecordingContent.values()" + modifiers: + - "static" + syntax: "public static Collection values()" + returns: + description: "known RecordingContent values." + type: "Collection<>" +type: "class" +desc: "Defines values for RecordingContent." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingFormat.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingFormat.yml new file mode 100644 index 000000000000..76022a5ce22d --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingFormat.yml @@ -0,0 +1,103 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RecordingFormat" +fullName: "com.azure.communication.callautomation.models.RecordingFormat" +name: "RecordingFormat" +nameWithType: "RecordingFormat" +summary: "Defines values for RecordingFormat." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecordingFormat**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.RecordingFormat.RecordingFormat()" + fullName: "com.azure.communication.callautomation.models.RecordingFormat.RecordingFormat()" + name: "RecordingFormat()" + nameWithType: "RecordingFormat.RecordingFormat()" + syntax: "public RecordingFormat()" +fields: +- uid: "com.azure.communication.callautomation.models.RecordingFormat.MP3" + fullName: "com.azure.communication.callautomation.models.RecordingFormat.MP3" + name: "MP3" + nameWithType: "RecordingFormat.MP3" + summary: "Static value mp3 for RecordingFormat." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final RecordingFormat MP3" + desc: "Static value mp3 for RecordingFormat." +- uid: "com.azure.communication.callautomation.models.RecordingFormat.MP4" + fullName: "com.azure.communication.callautomation.models.RecordingFormat.MP4" + name: "MP4" + nameWithType: "RecordingFormat.MP4" + summary: "Static value mp4 for RecordingFormat." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final RecordingFormat MP4" + desc: "Static value mp4 for RecordingFormat." +- uid: "com.azure.communication.callautomation.models.RecordingFormat.WAV" + fullName: "com.azure.communication.callautomation.models.RecordingFormat.WAV" + name: "WAV" + nameWithType: "RecordingFormat.WAV" + summary: "Static value wav for RecordingFormat." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final RecordingFormat WAV" + desc: "Static value wav for RecordingFormat." +methods: +- uid: "com.azure.communication.callautomation.models.RecordingFormat.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.RecordingFormat.fromString(String name)" + name: "fromString(String name)" + nameWithType: "RecordingFormat.fromString(String name)" + summary: "Creates or finds a RecordingFormat from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static RecordingFormat fromString(String name)" + desc: "Creates or finds a RecordingFormat from its string representation." + returns: + description: "the corresponding RecordingFormat." + type: "" +- uid: "com.azure.communication.callautomation.models.RecordingFormat.values()" + fullName: "com.azure.communication.callautomation.models.RecordingFormat.values()" + name: "values()" + nameWithType: "RecordingFormat.values()" + modifiers: + - "static" + syntax: "public static Collection values()" + returns: + description: "known RecordingFormat values." + type: "Collection<>" +type: "class" +desc: "Defines values for RecordingFormat." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingState.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingState.yml new file mode 100644 index 000000000000..a3cbcb4731dc --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingState.yml @@ -0,0 +1,91 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RecordingState" +fullName: "com.azure.communication.callautomation.models.RecordingState" +name: "RecordingState" +nameWithType: "RecordingState" +summary: "Defines values for RecordingStateInternal." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecordingState**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.RecordingState.RecordingState()" + fullName: "com.azure.communication.callautomation.models.RecordingState.RecordingState()" + name: "RecordingState()" + nameWithType: "RecordingState.RecordingState()" + syntax: "public RecordingState()" +fields: +- uid: "com.azure.communication.callautomation.models.RecordingState.ACTIVE" + fullName: "com.azure.communication.callautomation.models.RecordingState.ACTIVE" + name: "ACTIVE" + nameWithType: "RecordingState.ACTIVE" + summary: "Static value active for RecordingStateInternal." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final RecordingState ACTIVE" + desc: "Static value active for RecordingStateInternal." +- uid: "com.azure.communication.callautomation.models.RecordingState.INACTIVE" + fullName: "com.azure.communication.callautomation.models.RecordingState.INACTIVE" + name: "INACTIVE" + nameWithType: "RecordingState.INACTIVE" + summary: "Static value inactive for RecordingStateInternal." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final RecordingState INACTIVE" + desc: "Static value inactive for RecordingStateInternal." +methods: +- uid: "com.azure.communication.callautomation.models.RecordingState.fromString(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.RecordingState.fromString(String name)" + name: "fromString(String name)" + nameWithType: "RecordingState.fromString(String name)" + summary: "Creates or finds a RecordingStateInternal from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static RecordingState fromString(String name)" + desc: "Creates or finds a RecordingStateInternal from its string representation." + returns: + description: "the corresponding RecordingStateInternal." + type: "" +- uid: "com.azure.communication.callautomation.models.RecordingState.values()" + fullName: "com.azure.communication.callautomation.models.RecordingState.values()" + name: "values()" + nameWithType: "RecordingState.values()" + modifiers: + - "static" + syntax: "public static Collection values()" + returns: + description: "known RecordingStateInternal values." + type: "Collection<>" +type: "class" +desc: "Defines values for RecordingStateInternal." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingStateResult.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingStateResult.yml new file mode 100644 index 000000000000..b35d1362a45c --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RecordingStateResult.yml @@ -0,0 +1,57 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RecordingStateResult" +fullName: "com.azure.communication.callautomation.models.RecordingStateResult" +name: "RecordingStateResult" +nameWithType: "RecordingStateResult" +summary: "The response payload of start call recording operation." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecordingStateResult**" +constructors: +- uid: "com.azure.communication.callautomation.models.RecordingStateResult.RecordingStateResult()" + fullName: "com.azure.communication.callautomation.models.RecordingStateResult.RecordingStateResult()" + name: "RecordingStateResult()" + nameWithType: "RecordingStateResult.RecordingStateResult()" + summary: "Public constructor." + syntax: "public RecordingStateResult()" + desc: "Public constructor." +methods: +- uid: "com.azure.communication.callautomation.models.RecordingStateResult.getRecordingId()" + fullName: "com.azure.communication.callautomation.models.RecordingStateResult.getRecordingId()" + name: "getRecordingId()" + nameWithType: "RecordingStateResult.getRecordingId()" + summary: "Get the recordingId property: The recording id of the started recording." + syntax: "public String getRecordingId()" + desc: "Get the recordingId property: The recording id of the started recording." + returns: + description: "the recordingId value." + type: "String" +- uid: "com.azure.communication.callautomation.models.RecordingStateResult.getRecordingState()" + fullName: "com.azure.communication.callautomation.models.RecordingStateResult.getRecordingState()" + name: "getRecordingState()" + nameWithType: "RecordingStateResult.getRecordingState()" + summary: "Get the RecordingState property: The recording status of the recording." + syntax: "public RecordingState getRecordingState()" + desc: "Get the RecordingState property: The recording status of the recording." + returns: + description: "the recordingState value." + type: "" +type: "class" +desc: "The response payload of start call recording operation." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RedirectCallOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RedirectCallOptions.yml new file mode 100644 index 000000000000..47605033aee1 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RedirectCallOptions.yml @@ -0,0 +1,88 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RedirectCallOptions" +fullName: "com.azure.communication.callautomation.models.RedirectCallOptions" +name: "RedirectCallOptions" +nameWithType: "RedirectCallOptions" +summary: "The options for creating a call." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **RedirectCallOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.RedirectCallOptions.RedirectCallOptions(java.lang.String,com.azure.communication.common.CommunicationIdentifier)" + fullName: "com.azure.communication.callautomation.models.RedirectCallOptions.RedirectCallOptions(String incomingCallContext, CommunicationIdentifier target)" + name: "RedirectCallOptions(String incomingCallContext, CommunicationIdentifier target)" + nameWithType: "RedirectCallOptions.RedirectCallOptions(String incomingCallContext, CommunicationIdentifier target)" + summary: "Constructor" + parameters: + - description: "The incoming call context." + name: "incomingCallContext" + type: "String" + - description: "The target of being redirected to." + name: "target" + type: "" + syntax: "public RedirectCallOptions(String incomingCallContext, CommunicationIdentifier target)" + desc: "Constructor" +methods: +- uid: "com.azure.communication.callautomation.models.RedirectCallOptions.getIncomingCallContext()" + fullName: "com.azure.communication.callautomation.models.RedirectCallOptions.getIncomingCallContext()" + name: "getIncomingCallContext()" + nameWithType: "RedirectCallOptions.getIncomingCallContext()" + summary: "Get the incomingCallContext." + syntax: "public String getIncomingCallContext()" + desc: "Get the incomingCallContext." + returns: + description: "the incomingCallContext." + type: "String" +- uid: "com.azure.communication.callautomation.models.RedirectCallOptions.getRepeatabilityHeaders()" + fullName: "com.azure.communication.callautomation.models.RedirectCallOptions.getRepeatabilityHeaders()" + name: "getRepeatabilityHeaders()" + nameWithType: "RedirectCallOptions.getRepeatabilityHeaders()" + summary: "Get the Repeatability headers configuration." + syntax: "public RepeatabilityHeaders getRepeatabilityHeaders()" + desc: "Get the Repeatability headers configuration." + returns: + description: "the repeatabilityHeaders" + type: "" +- uid: "com.azure.communication.callautomation.models.RedirectCallOptions.getTarget()" + fullName: "com.azure.communication.callautomation.models.RedirectCallOptions.getTarget()" + name: "getTarget()" + nameWithType: "RedirectCallOptions.getTarget()" + summary: "Get the target" + syntax: "public CommunicationIdentifier getTarget()" + desc: "Get the target" + returns: + description: "the target" + type: "" +- uid: "com.azure.communication.callautomation.models.RedirectCallOptions.setRepeatabilityHeaders(com.azure.communication.callautomation.models.RepeatabilityHeaders)" + fullName: "com.azure.communication.callautomation.models.RedirectCallOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + name: "setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + nameWithType: "RedirectCallOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + summary: "Set the repeatability headers" + parameters: + - description: "The repeatability headers configuration." + name: "repeatabilityHeaders" + type: "" + syntax: "public RedirectCallOptions setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + desc: "Set the repeatability headers" + returns: + description: "the RedirectCallOptions object itself." + type: "" +type: "class" +desc: "The options for creating a call." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RejectCallOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RejectCallOptions.yml new file mode 100644 index 000000000000..820b535a789f --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RejectCallOptions.yml @@ -0,0 +1,99 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RejectCallOptions" +fullName: "com.azure.communication.callautomation.models.RejectCallOptions" +name: "RejectCallOptions" +nameWithType: "RejectCallOptions" +summary: "The options for creating a call." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **RejectCallOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.RejectCallOptions.RejectCallOptions(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.RejectCallOptions.RejectCallOptions(String incomingCallContext)" + name: "RejectCallOptions(String incomingCallContext)" + nameWithType: "RejectCallOptions.RejectCallOptions(String incomingCallContext)" + summary: "Constructor" + parameters: + - description: "The incoming call context." + name: "incomingCallContext" + type: "String" + syntax: "public RejectCallOptions(String incomingCallContext)" + desc: "Constructor" +methods: +- uid: "com.azure.communication.callautomation.models.RejectCallOptions.getCallRejectReason()" + fullName: "com.azure.communication.callautomation.models.RejectCallOptions.getCallRejectReason()" + name: "getCallRejectReason()" + nameWithType: "RejectCallOptions.getCallRejectReason()" + summary: "Get the callRejectReason" + syntax: "public CallRejectReason getCallRejectReason()" + desc: "Get the callRejectReason" + returns: + description: "the callRejectReason" + type: "" +- uid: "com.azure.communication.callautomation.models.RejectCallOptions.getIncomingCallContext()" + fullName: "com.azure.communication.callautomation.models.RejectCallOptions.getIncomingCallContext()" + name: "getIncomingCallContext()" + nameWithType: "RejectCallOptions.getIncomingCallContext()" + summary: "Get the incomingCallContext." + syntax: "public String getIncomingCallContext()" + desc: "Get the incomingCallContext." + returns: + description: "the incomingCallContext." + type: "String" +- uid: "com.azure.communication.callautomation.models.RejectCallOptions.getRepeatabilityHeaders()" + fullName: "com.azure.communication.callautomation.models.RejectCallOptions.getRepeatabilityHeaders()" + name: "getRepeatabilityHeaders()" + nameWithType: "RejectCallOptions.getRepeatabilityHeaders()" + summary: "Get the Repeatability headers configuration." + syntax: "public RepeatabilityHeaders getRepeatabilityHeaders()" + desc: "Get the Repeatability headers configuration." + returns: + description: "the repeatabilityHeaders" + type: "" +- uid: "com.azure.communication.callautomation.models.RejectCallOptions.setCallRejectReason(com.azure.communication.callautomation.models.CallRejectReason)" + fullName: "com.azure.communication.callautomation.models.RejectCallOptions.setCallRejectReason(CallRejectReason callRejectReason)" + name: "setCallRejectReason(CallRejectReason callRejectReason)" + nameWithType: "RejectCallOptions.setCallRejectReason(CallRejectReason callRejectReason)" + summary: "Set the callRejectReason" + parameters: + - description: "The callRejectReason" + name: "callRejectReason" + type: "" + syntax: "public RejectCallOptions setCallRejectReason(CallRejectReason callRejectReason)" + desc: "Set the callRejectReason" + returns: + description: "the RejectCallOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.RejectCallOptions.setRepeatabilityHeaders(com.azure.communication.callautomation.models.RepeatabilityHeaders)" + fullName: "com.azure.communication.callautomation.models.RejectCallOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + name: "setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + nameWithType: "RejectCallOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + summary: "Set the repeatability headers" + parameters: + - description: "The repeatability headers configuration." + name: "repeatabilityHeaders" + type: "" + syntax: "public RejectCallOptions setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + desc: "Set the repeatability headers" + returns: + description: "the RejectCallOptions object itself." + type: "" +type: "class" +desc: "The options for creating a call." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RemoveParticipantsOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RemoveParticipantsOptions.yml new file mode 100644 index 000000000000..a4ba768b1539 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RemoveParticipantsOptions.yml @@ -0,0 +1,99 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RemoveParticipantsOptions" +fullName: "com.azure.communication.callautomation.models.RemoveParticipantsOptions" +name: "RemoveParticipantsOptions" +nameWithType: "RemoveParticipantsOptions" +summary: "The options for removing participants." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RemoveParticipantsOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.RemoveParticipantsOptions(java.util.List)" + fullName: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.RemoveParticipantsOptions(List participants)" + name: "RemoveParticipantsOptions(List participants)" + nameWithType: "RemoveParticipantsOptions.RemoveParticipantsOptions(List participants)" + summary: "Constructor" + parameters: + - description: "The list of participants to invite." + name: "participants" + type: "List<>" + syntax: "public RemoveParticipantsOptions(List participants)" + desc: "Constructor" +methods: +- uid: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.getOperationContext()" + fullName: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.getOperationContext()" + name: "getOperationContext()" + nameWithType: "RemoveParticipantsOptions.getOperationContext()" + summary: "Get the operationContext." + syntax: "public String getOperationContext()" + desc: "Get the operationContext." + returns: + description: "the operationContext" + type: "String" +- uid: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.getParticipants()" + fullName: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.getParticipants()" + name: "getParticipants()" + nameWithType: "RemoveParticipantsOptions.getParticipants()" + summary: "Get the participants." + syntax: "public List getParticipants()" + desc: "Get the participants." + returns: + description: "the list of participants to be added" + type: "List<>" +- uid: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.getRepeatabilityHeaders()" + fullName: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.getRepeatabilityHeaders()" + name: "getRepeatabilityHeaders()" + nameWithType: "RemoveParticipantsOptions.getRepeatabilityHeaders()" + summary: "Get the Repeatability headers configuration." + syntax: "public RepeatabilityHeaders getRepeatabilityHeaders()" + desc: "Get the Repeatability headers configuration." + returns: + description: "the repeatabilityHeaders" + type: "" +- uid: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.setOperationContext(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.setOperationContext(String operationContext)" + name: "setOperationContext(String operationContext)" + nameWithType: "RemoveParticipantsOptions.setOperationContext(String operationContext)" + summary: "Set the operationContext." + parameters: + - description: "the operationContext to set" + name: "operationContext" + type: "String" + syntax: "public RemoveParticipantsOptions setOperationContext(String operationContext)" + desc: "Set the operationContext." + returns: + description: "the RemoveParticipantsOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.setRepeatabilityHeaders(com.azure.communication.callautomation.models.RepeatabilityHeaders)" + fullName: "com.azure.communication.callautomation.models.RemoveParticipantsOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + name: "setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + nameWithType: "RemoveParticipantsOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + summary: "Set the repeatability headers" + parameters: + - description: "The repeatability headers configuration." + name: "repeatabilityHeaders" + type: "" + syntax: "public RemoveParticipantsOptions setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + desc: "Set the repeatability headers" + returns: + description: "the RemoveParticipantsOptions object itself." + type: "" +type: "class" +desc: "The options for removing participants." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RemoveParticipantsResult.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RemoveParticipantsResult.yml new file mode 100644 index 000000000000..1d76cdcf3040 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RemoveParticipantsResult.yml @@ -0,0 +1,47 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RemoveParticipantsResult" +fullName: "com.azure.communication.callautomation.models.RemoveParticipantsResult" +name: "RemoveParticipantsResult" +nameWithType: "RemoveParticipantsResult" +summary: "The RemoveParticipantsResult model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RemoveParticipantsResult**" +constructors: +- uid: "com.azure.communication.callautomation.models.RemoveParticipantsResult.RemoveParticipantsResult()" + fullName: "com.azure.communication.callautomation.models.RemoveParticipantsResult.RemoveParticipantsResult()" + name: "RemoveParticipantsResult()" + nameWithType: "RemoveParticipantsResult.RemoveParticipantsResult()" + summary: "Public constructor." + syntax: "public RemoveParticipantsResult()" + desc: "Public constructor." +methods: +- uid: "com.azure.communication.callautomation.models.RemoveParticipantsResult.getOperationContext()" + fullName: "com.azure.communication.callautomation.models.RemoveParticipantsResult.getOperationContext()" + name: "getOperationContext()" + nameWithType: "RemoveParticipantsResult.getOperationContext()" + summary: "Get the operationContext property: The operation context provided by client." + syntax: "public String getOperationContext()" + desc: "Get the operationContext property: The operation context provided by client." + returns: + description: "the operationContext value." + type: "String" +type: "class" +desc: "The RemoveParticipantsResult model." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RepeatabilityHeaders.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RepeatabilityHeaders.yml new file mode 100644 index 000000000000..515206c912de --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.RepeatabilityHeaders.yml @@ -0,0 +1,74 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.RepeatabilityHeaders" +fullName: "com.azure.communication.callautomation.models.RepeatabilityHeaders" +name: "RepeatabilityHeaders" +nameWithType: "RepeatabilityHeaders" +summary: "The Repeatability Headers." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RepeatabilityHeaders**" +constructors: +- uid: "com.azure.communication.callautomation.models.RepeatabilityHeaders.RepeatabilityHeaders(java.util.UUID,java.time.Instant)" + fullName: "com.azure.communication.callautomation.models.RepeatabilityHeaders.RepeatabilityHeaders(UUID repeatabilityRequestId, Instant repeatabilityFirstSent)" + name: "RepeatabilityHeaders(UUID repeatabilityRequestId, Instant repeatabilityFirstSent)" + nameWithType: "RepeatabilityHeaders.RepeatabilityHeaders(UUID repeatabilityRequestId, Instant repeatabilityFirstSent)" + summary: "Constructor" + parameters: + - description: "The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request.\n It is a version 4 (random) UUID." + name: "repeatabilityRequestId" + type: "UUID" + - description: "The value should be the date and time at which the request was first created." + name: "repeatabilityFirstSent" + type: "Instant" + syntax: "public RepeatabilityHeaders(UUID repeatabilityRequestId, Instant repeatabilityFirstSent)" + desc: "Constructor" +methods: +- uid: "com.azure.communication.callautomation.models.RepeatabilityHeaders.getRepeatabilityFirstSent()" + fullName: "com.azure.communication.callautomation.models.RepeatabilityHeaders.getRepeatabilityFirstSent()" + name: "getRepeatabilityFirstSent()" + nameWithType: "RepeatabilityHeaders.getRepeatabilityFirstSent()" + summary: "Get the repeatabilityFirstSent : The value should be the date and time at which the request was first created." + syntax: "public Instant getRepeatabilityFirstSent()" + desc: "Get the repeatabilityFirstSent : The value should be the date and time at which the request was first created." + returns: + description: "the repeatabilityFirstSent." + type: "Instant" +- uid: "com.azure.communication.callautomation.models.RepeatabilityHeaders.getRepeatabilityFirstSentInHttpDateFormat()" + fullName: "com.azure.communication.callautomation.models.RepeatabilityHeaders.getRepeatabilityFirstSentInHttpDateFormat()" + name: "getRepeatabilityFirstSentInHttpDateFormat()" + nameWithType: "RepeatabilityHeaders.getRepeatabilityFirstSentInHttpDateFormat()" + summary: "Get the repeatabilityFirstSent in IMF-fixdate form of HTTP-date format." + syntax: "public String getRepeatabilityFirstSentInHttpDateFormat()" + desc: "Get the repeatabilityFirstSent in IMF-fixdate form of HTTP-date format." + returns: + description: "the repeatabilityFirstSent in a string with IMF-fixdate form of HTTP-date format." + type: "String" +- uid: "com.azure.communication.callautomation.models.RepeatabilityHeaders.getRepeatabilityRequestId()" + fullName: "com.azure.communication.callautomation.models.RepeatabilityHeaders.getRepeatabilityRequestId()" + name: "getRepeatabilityRequestId()" + nameWithType: "RepeatabilityHeaders.getRepeatabilityRequestId()" + summary: "Get the repeatabilityRequestId : The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request." + syntax: "public UUID getRepeatabilityRequestId()" + desc: "Get the repeatabilityRequestId : The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID." + returns: + description: "the repeatabilityRequestId." + type: "UUID" +type: "class" +desc: "The Repeatability Headers." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.ServerCallLocator.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.ServerCallLocator.yml new file mode 100644 index 000000000000..4892459a5cce --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.ServerCallLocator.yml @@ -0,0 +1,55 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.ServerCallLocator" +fullName: "com.azure.communication.callautomation.models.ServerCallLocator" +name: "ServerCallLocator" +nameWithType: "ServerCallLocator" +summary: "The locator used for joining or taking action on a call." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **ServerCallLocator**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.ServerCallLocator.ServerCallLocator(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.ServerCallLocator.ServerCallLocator(String serverCallId)" + name: "ServerCallLocator(String serverCallId)" + nameWithType: "ServerCallLocator.ServerCallLocator(String serverCallId)" + summary: "Group call locator" + parameters: + - description: "Specify the group call id." + name: "serverCallId" + type: "String" + syntax: "public ServerCallLocator(String serverCallId)" + desc: "Group call locator" +methods: +- uid: "com.azure.communication.callautomation.models.ServerCallLocator.getServerCallId()" + fullName: "com.azure.communication.callautomation.models.ServerCallLocator.getServerCallId()" + name: "getServerCallId()" + nameWithType: "ServerCallLocator.getServerCallId()" + summary: "Get the serverCallId property: The server call id." + syntax: "public String getServerCallId()" + desc: "Get the serverCallId property: The server call id." + returns: + description: "the serverCallId value." + type: "String" +type: "class" +desc: "The locator used for joining or taking action on a call." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.StartRecordingOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.StartRecordingOptions.yml new file mode 100644 index 000000000000..ee8d894501c2 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.StartRecordingOptions.yml @@ -0,0 +1,195 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.StartRecordingOptions" +fullName: "com.azure.communication.callautomation.models.StartRecordingOptions" +name: "StartRecordingOptions" +nameWithType: "StartRecordingOptions" +summary: "The options for creating a call." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **StartRecordingOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.StartRecordingOptions(com.azure.communication.callautomation.models.CallLocator)" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.StartRecordingOptions(CallLocator callLocator)" + name: "StartRecordingOptions(CallLocator callLocator)" + nameWithType: "StartRecordingOptions.StartRecordingOptions(CallLocator callLocator)" + summary: "Constructor" + parameters: + - description: "Either a or for locating the call." + name: "callLocator" + type: "" + syntax: "public StartRecordingOptions(CallLocator callLocator)" + desc: "Constructor" +methods: +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.getAudioChannelParticipantOrdering()" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.getAudioChannelParticipantOrdering()" + name: "getAudioChannelParticipantOrdering()" + nameWithType: "StartRecordingOptions.getAudioChannelParticipantOrdering()" + summary: "Get the audioChannelParticipantOrdering property: The sequential order in which audio channels are assigned to participants in the unmixed recording." + syntax: "public List getAudioChannelParticipantOrdering()" + desc: "Get the audioChannelParticipantOrdering property: The sequential order in which audio channels are assigned to participants in the unmixed recording. When 'recordingChannelType' is set to 'unmixed' and \\`audioChannelParticipantOrdering is not specified, the audio channel to participant mapping will be automatically assigned based on the order in which participant first audio was detected. Channel to participant mapping details can be found in the metadata of the recording." + returns: + description: "the audioChannelParticipantOrdering value." + type: "List<>" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.getCallLocator()" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.getCallLocator()" + name: "getCallLocator()" + nameWithType: "StartRecordingOptions.getCallLocator()" + summary: "Get the call locator." + syntax: "public CallLocator getCallLocator()" + desc: "Get the call locator." + returns: + description: "the call locator." + type: "" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.getRecordingChannel()" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.getRecordingChannel()" + name: "getRecordingChannel()" + nameWithType: "StartRecordingOptions.getRecordingChannel()" + summary: "Get the channel property." + syntax: "public RecordingChannel getRecordingChannel()" + desc: "Get the channel property." + returns: + description: "the channel property." + type: "" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.getRecordingContent()" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.getRecordingContent()" + name: "getRecordingContent()" + nameWithType: "StartRecordingOptions.getRecordingContent()" + summary: "Get the content property." + syntax: "public RecordingContent getRecordingContent()" + desc: "Get the content property." + returns: + description: "the content property." + type: "" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.getRecordingFormat()" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.getRecordingFormat()" + name: "getRecordingFormat()" + nameWithType: "StartRecordingOptions.getRecordingFormat()" + summary: "Get the recording format." + syntax: "public RecordingFormat getRecordingFormat()" + desc: "Get the recording format." + returns: + description: "the recording format." + type: "" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.getRecordingStateCallbackUrl()" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.getRecordingStateCallbackUrl()" + name: "getRecordingStateCallbackUrl()" + nameWithType: "StartRecordingOptions.getRecordingStateCallbackUrl()" + summary: "Uri to send state change callbacks." + syntax: "public String getRecordingStateCallbackUrl()" + desc: "Uri to send state change callbacks." + returns: + description: "url to send state change callbacks." + type: "String" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.getRepeatabilityHeaders()" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.getRepeatabilityHeaders()" + name: "getRepeatabilityHeaders()" + nameWithType: "StartRecordingOptions.getRepeatabilityHeaders()" + summary: "Get the Repeatability headers configuration." + syntax: "public RepeatabilityHeaders getRepeatabilityHeaders()" + desc: "Get the Repeatability headers configuration." + returns: + description: "the repeatabilityHeaders" + type: "" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.setAudioChannelParticipantOrdering(java.util.List)" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.setAudioChannelParticipantOrdering(List audioChannelParticipantOrdering)" + name: "setAudioChannelParticipantOrdering(List audioChannelParticipantOrdering)" + nameWithType: "StartRecordingOptions.setAudioChannelParticipantOrdering(List audioChannelParticipantOrdering)" + summary: "Set the audioChannelParticipantOrdering property: The sequential order in which audio channels are assigned to participants in the unmixed recording." + parameters: + - description: "the list of ." + name: "audioChannelParticipantOrdering" + type: "List<>" + syntax: "public StartRecordingOptions setAudioChannelParticipantOrdering(List audioChannelParticipantOrdering)" + desc: "Set the audioChannelParticipantOrdering property: The sequential order in which audio channels are assigned to participants in the unmixed recording. When 'recordingChannelType' is set to 'unmixed' and \\`audioChannelParticipantOrdering is not specified, the audio channel to participant mapping will be automatically assigned based on the order in which participant first audio was detected. Channel to participant mapping details can be found in the metadata of the recording." + returns: + description: "the " + type: "" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.setRecordingChannel(com.azure.communication.callautomation.models.RecordingChannel)" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.setRecordingChannel(RecordingChannel recordingChannel)" + name: "setRecordingChannel(RecordingChannel recordingChannel)" + nameWithType: "StartRecordingOptions.setRecordingChannel(RecordingChannel recordingChannel)" + summary: "Set the channel property." + parameters: + - description: "the ." + name: "recordingChannel" + type: "" + syntax: "public StartRecordingOptions setRecordingChannel(RecordingChannel recordingChannel)" + desc: "Set the channel property." + returns: + description: "the " + type: "" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.setRecordingContent(com.azure.communication.callautomation.models.RecordingContent)" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.setRecordingContent(RecordingContent recordingContent)" + name: "setRecordingContent(RecordingContent recordingContent)" + nameWithType: "StartRecordingOptions.setRecordingContent(RecordingContent recordingContent)" + summary: "Set the content property." + parameters: + - description: "the ." + name: "recordingContent" + type: "" + syntax: "public StartRecordingOptions setRecordingContent(RecordingContent recordingContent)" + desc: "Set the content property." + returns: + description: "the " + type: "" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.setRecordingFormat(com.azure.communication.callautomation.models.RecordingFormat)" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.setRecordingFormat(RecordingFormat recordingFormat)" + name: "setRecordingFormat(RecordingFormat recordingFormat)" + nameWithType: "StartRecordingOptions.setRecordingFormat(RecordingFormat recordingFormat)" + summary: "Set the recording format property." + parameters: + - description: "the ." + name: "recordingFormat" + type: "" + syntax: "public StartRecordingOptions setRecordingFormat(RecordingFormat recordingFormat)" + desc: "Set the recording format property." + returns: + description: "the " + type: "" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.setRecordingStateCallbackUrl(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.setRecordingStateCallbackUrl(String recordingStateCallbackUrl)" + name: "setRecordingStateCallbackUrl(String recordingStateCallbackUrl)" + nameWithType: "StartRecordingOptions.setRecordingStateCallbackUrl(String recordingStateCallbackUrl)" + summary: "Set the recordingStateCallbackUrl" + parameters: + - description: "to send state change callbacks." + name: "recordingStateCallbackUrl" + type: "String" + syntax: "public StartRecordingOptions setRecordingStateCallbackUrl(String recordingStateCallbackUrl)" + desc: "Set the recordingStateCallbackUrl" + returns: + description: "the " + type: "" +- uid: "com.azure.communication.callautomation.models.StartRecordingOptions.setRepeatabilityHeaders(com.azure.communication.callautomation.models.RepeatabilityHeaders)" + fullName: "com.azure.communication.callautomation.models.StartRecordingOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + name: "setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + nameWithType: "StartRecordingOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + summary: "Set the repeatability headers" + parameters: + - description: "The repeatability headers configuration." + name: "repeatabilityHeaders" + type: "" + syntax: "public StartRecordingOptions setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + desc: "Set the repeatability headers" + returns: + description: "the StartRecordingOptions object itself." + type: "" +type: "class" +desc: "The options for creating a call." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.TransferCallResult.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.TransferCallResult.yml new file mode 100644 index 000000000000..b28704c7f9dc --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.TransferCallResult.yml @@ -0,0 +1,47 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.TransferCallResult" +fullName: "com.azure.communication.callautomation.models.TransferCallResult" +name: "TransferCallResult" +nameWithType: "TransferCallResult" +summary: "The TransferCallResult model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **TransferCallResult**" +constructors: +- uid: "com.azure.communication.callautomation.models.TransferCallResult.TransferCallResult()" + fullName: "com.azure.communication.callautomation.models.TransferCallResult.TransferCallResult()" + name: "TransferCallResult()" + nameWithType: "TransferCallResult.TransferCallResult()" + summary: "Public constructor." + syntax: "public TransferCallResult()" + desc: "Public constructor." +methods: +- uid: "com.azure.communication.callautomation.models.TransferCallResult.getOperationContext()" + fullName: "com.azure.communication.callautomation.models.TransferCallResult.getOperationContext()" + name: "getOperationContext()" + nameWithType: "TransferCallResult.getOperationContext()" + summary: "Get the operationContext property: The operation context provided by client." + syntax: "public String getOperationContext()" + desc: "Get the operationContext property: The operation context provided by client." + returns: + description: "the operationContext value." + type: "String" +type: "class" +desc: "The TransferCallResult model." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.TransferToParticipantCallOptions.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.TransferToParticipantCallOptions.yml new file mode 100644 index 000000000000..49c97ba5de91 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.TransferToParticipantCallOptions.yml @@ -0,0 +1,123 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions" +fullName: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions" +name: "TransferToParticipantCallOptions" +nameWithType: "TransferToParticipantCallOptions" +summary: "The options for adding participants." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public class **TransferToParticipantCallOptions**" +constructors: +- uid: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.TransferToParticipantCallOptions(com.azure.communication.common.CommunicationIdentifier)" + fullName: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.TransferToParticipantCallOptions(CommunicationIdentifier targetParticipant)" + name: "TransferToParticipantCallOptions(CommunicationIdentifier targetParticipant)" + nameWithType: "TransferToParticipantCallOptions.TransferToParticipantCallOptions(CommunicationIdentifier targetParticipant)" + summary: "Constructor" + parameters: + - description: "A representing the target participant of this transfer." + name: "targetParticipant" + type: "" + syntax: "public TransferToParticipantCallOptions(CommunicationIdentifier targetParticipant)" + desc: "Constructor" +methods: +- uid: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.getOperationContext()" + fullName: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.getOperationContext()" + name: "getOperationContext()" + nameWithType: "TransferToParticipantCallOptions.getOperationContext()" + summary: "Get the operationContext." + syntax: "public String getOperationContext()" + desc: "Get the operationContext." + returns: + description: "the operationContext" + type: "String" +- uid: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.getRepeatabilityHeaders()" + fullName: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.getRepeatabilityHeaders()" + name: "getRepeatabilityHeaders()" + nameWithType: "TransferToParticipantCallOptions.getRepeatabilityHeaders()" + summary: "Get the Repeatability headers configuration." + syntax: "public RepeatabilityHeaders getRepeatabilityHeaders()" + desc: "Get the Repeatability headers configuration." + returns: + description: "the repeatabilityHeaders" + type: "" +- uid: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.getTargetParticipant()" + fullName: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.getTargetParticipant()" + name: "getTargetParticipant()" + nameWithType: "TransferToParticipantCallOptions.getTargetParticipant()" + summary: "Get the target participant." + syntax: "public CommunicationIdentifier getTargetParticipant()" + desc: "Get the target participant." + returns: + description: "the target participant." + type: "" +- uid: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.getTransfereeCallerId()" + fullName: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.getTransfereeCallerId()" + name: "getTransfereeCallerId()" + nameWithType: "TransferToParticipantCallOptions.getTransfereeCallerId()" + summary: "Get the transfereeCallerId." + syntax: "public PhoneNumberIdentifier getTransfereeCallerId()" + desc: "Get the transfereeCallerId." + returns: + description: "the transfereeCallerId." + type: "" +- uid: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.setOperationContext(java.lang.String)" + fullName: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.setOperationContext(String operationContext)" + name: "setOperationContext(String operationContext)" + nameWithType: "TransferToParticipantCallOptions.setOperationContext(String operationContext)" + summary: "Set the operationContext." + parameters: + - description: "the operationContext to set" + name: "operationContext" + type: "String" + syntax: "public TransferToParticipantCallOptions setOperationContext(String operationContext)" + desc: "Set the operationContext." + returns: + description: "the TransferToParticipantCallOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.setRepeatabilityHeaders(com.azure.communication.callautomation.models.RepeatabilityHeaders)" + fullName: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + name: "setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + nameWithType: "TransferToParticipantCallOptions.setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + summary: "Set the repeatability headers" + parameters: + - description: "The repeatability headers configuration." + name: "repeatabilityHeaders" + type: "" + syntax: "public TransferToParticipantCallOptions setRepeatabilityHeaders(RepeatabilityHeaders repeatabilityHeaders)" + desc: "Set the repeatability headers" + returns: + description: "the TransferToParticipantCallOptions object itself." + type: "" +- uid: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.setSourceCallerId(com.azure.communication.common.PhoneNumberIdentifier)" + fullName: "com.azure.communication.callautomation.models.TransferToParticipantCallOptions.setSourceCallerId(PhoneNumberIdentifier transfereeCallerId)" + name: "setSourceCallerId(PhoneNumberIdentifier transfereeCallerId)" + nameWithType: "TransferToParticipantCallOptions.setSourceCallerId(PhoneNumberIdentifier transfereeCallerId)" + summary: "Set the transfereeCallerId." + parameters: + - description: "A representing the caller ID of the transferee\n if transferring to a pstn number." + name: "transfereeCallerId" + type: "" + syntax: "public TransferToParticipantCallOptions setSourceCallerId(PhoneNumberIdentifier transfereeCallerId)" + desc: "Set the transfereeCallerId." + returns: + description: "the TransferToParticipantCallOptions object itself." + type: "" +type: "class" +desc: "The options for adding participants." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.AddParticipantsFailed.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.AddParticipantsFailed.yml new file mode 100644 index 000000000000..4dcfa16f1a68 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.AddParticipantsFailed.yml @@ -0,0 +1,56 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.AddParticipantsFailed" +fullName: "com.azure.communication.callautomation.models.events.AddParticipantsFailed" +name: "AddParticipantsFailed" +nameWithType: "AddParticipantsFailed" +summary: "The AddParticipantsFailed model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **AddParticipantsFailed**
extends " +methods: +- uid: "com.azure.communication.callautomation.models.events.AddParticipantsFailed.getParticipants()" + fullName: "com.azure.communication.callautomation.models.events.AddParticipantsFailed.getParticipants()" + name: "getParticipants()" + nameWithType: "AddParticipantsFailed.getParticipants()" + summary: "Get the participants property: Participants failed to be added." + syntax: "public List getParticipants()" + desc: "Get the participants property: Participants failed to be added." + returns: + description: "the participants value." + type: "List<>" +- uid: "com.azure.communication.callautomation.models.events.AddParticipantsFailed.getResultInformation()" + fullName: "com.azure.communication.callautomation.models.events.AddParticipantsFailed.getResultInformation()" + name: "getResultInformation()" + nameWithType: "AddParticipantsFailed.getResultInformation()" + summary: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + syntax: "public ResultInformation getResultInformation()" + desc: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + returns: + description: "the resultInformation value." + type: "" +type: "class" +desc: "The AddParticipantsFailed model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.AddParticipantsSucceeded.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.AddParticipantsSucceeded.yml new file mode 100644 index 000000000000..d89adbec4af4 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.AddParticipantsSucceeded.yml @@ -0,0 +1,56 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.AddParticipantsSucceeded" +fullName: "com.azure.communication.callautomation.models.events.AddParticipantsSucceeded" +name: "AddParticipantsSucceeded" +nameWithType: "AddParticipantsSucceeded" +summary: "The AddParticipantsSucceeded model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **AddParticipantsSucceeded**
extends " +methods: +- uid: "com.azure.communication.callautomation.models.events.AddParticipantsSucceeded.getParticipants()" + fullName: "com.azure.communication.callautomation.models.events.AddParticipantsSucceeded.getParticipants()" + name: "getParticipants()" + nameWithType: "AddParticipantsSucceeded.getParticipants()" + summary: "Get the participants property: Participants added." + syntax: "public List getParticipants()" + desc: "Get the participants property: Participants added." + returns: + description: "the participants value." + type: "List<>" +- uid: "com.azure.communication.callautomation.models.events.AddParticipantsSucceeded.getResultInformation()" + fullName: "com.azure.communication.callautomation.models.events.AddParticipantsSucceeded.getResultInformation()" + name: "getResultInformation()" + nameWithType: "AddParticipantsSucceeded.getResultInformation()" + summary: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + syntax: "public ResultInformation getResultInformation()" + desc: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + returns: + description: "the resultInformation value." + type: "" +type: "class" +desc: "The AddParticipantsSucceeded model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallAutomationEventBase.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallAutomationEventBase.yml new file mode 100644 index 000000000000..1aeffd3baa0b --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallAutomationEventBase.yml @@ -0,0 +1,69 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.CallAutomationEventBase" +fullName: "com.azure.communication.callautomation.models.events.CallAutomationEventBase" +name: "CallAutomationEventBase" +nameWithType: "CallAutomationEventBase" +summary: "The base event interface." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public abstract class **CallAutomationEventBase**" +methods: +- uid: "com.azure.communication.callautomation.models.events.CallAutomationEventBase.getCallConnectionId()" + fullName: "com.azure.communication.callautomation.models.events.CallAutomationEventBase.getCallConnectionId()" + name: "getCallConnectionId()" + nameWithType: "CallAutomationEventBase.getCallConnectionId()" + summary: "Get the callConnectionId property: Call connection ID." + syntax: "public String getCallConnectionId()" + desc: "Get the callConnectionId property: Call connection ID." + returns: + description: "the callConnectionId value." + type: "String" +- uid: "com.azure.communication.callautomation.models.events.CallAutomationEventBase.getCorrelationId()" + fullName: "com.azure.communication.callautomation.models.events.CallAutomationEventBase.getCorrelationId()" + name: "getCorrelationId()" + nameWithType: "CallAutomationEventBase.getCorrelationId()" + summary: "Get the correlationId property: Correlation ID for event to call correlation." + syntax: "public String getCorrelationId()" + desc: "Get the correlationId property: Correlation ID for event to call correlation. Also called ChainId for skype chain ID." + returns: + description: "the correlationId value." + type: "String" +- uid: "com.azure.communication.callautomation.models.events.CallAutomationEventBase.getOperationContext()" + fullName: "com.azure.communication.callautomation.models.events.CallAutomationEventBase.getOperationContext()" + name: "getOperationContext()" + nameWithType: "CallAutomationEventBase.getOperationContext()" + summary: "Get the operationContext property: Operation context." + syntax: "public String getOperationContext()" + desc: "Get the operationContext property: Operation context." + returns: + description: "the operationContext value." + type: "String" +- uid: "com.azure.communication.callautomation.models.events.CallAutomationEventBase.getServerCallId()" + fullName: "com.azure.communication.callautomation.models.events.CallAutomationEventBase.getServerCallId()" + name: "getServerCallId()" + nameWithType: "CallAutomationEventBase.getServerCallId()" + summary: "Get the serverCallId property: Server call ID." + syntax: "public String getServerCallId()" + desc: "Get the serverCallId property: Server call ID." + returns: + description: "the serverCallId value." + type: "String" +type: "class" +desc: "The base event interface." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase.yml new file mode 100644 index 000000000000..c0ba3841c39c --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase.yml @@ -0,0 +1,56 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase" +fullName: "com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase" +name: "CallAutomationEventWithReasonCodeBase" +nameWithType: "CallAutomationEventWithReasonCodeBase" +summary: "The base event interface with ReasonCode added." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public abstract class **CallAutomationEventWithReasonCodeBase**
extends " +methods: +- uid: "com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase.getReasonCode()" + fullName: "com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase.getReasonCode()" + name: "getReasonCode()" + nameWithType: "CallAutomationEventWithReasonCodeBase.getReasonCode()" + summary: "Returns the reason code of the event" + syntax: "public ReasonCode getReasonCode()" + desc: "Returns the reason code of the event" + returns: + description: "a ReasonCode object." + type: "" +- uid: "com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase.getResultInformation()" + fullName: "com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase.getResultInformation()" + name: "getResultInformation()" + nameWithType: "CallAutomationEventWithReasonCodeBase.getResultInformation()" + summary: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + syntax: "public ResultInformation getResultInformation()" + desc: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + returns: + description: "the resultInformation value." + type: "" +type: "class" +desc: "The base event interface with ReasonCode added." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallConnected.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallConnected.yml new file mode 100644 index 000000000000..3ce8fd3ae5fc --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallConnected.yml @@ -0,0 +1,35 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.CallConnected" +fullName: "com.azure.communication.callautomation.models.events.CallConnected" +name: "CallConnected" +nameWithType: "CallConnected" +summary: "The CallConnected model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallConnected**
extends " +type: "class" +desc: "The CallConnected model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallDisconnected.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallDisconnected.yml new file mode 100644 index 000000000000..f6505c77d4fc --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallDisconnected.yml @@ -0,0 +1,35 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.CallDisconnected" +fullName: "com.azure.communication.callautomation.models.events.CallDisconnected" +name: "CallDisconnected" +nameWithType: "CallDisconnected" +summary: "The CallDisconnected model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallDisconnected**
extends " +type: "class" +desc: "The CallDisconnected model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallTransferAccepted.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallTransferAccepted.yml new file mode 100644 index 000000000000..2c344cc81065 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallTransferAccepted.yml @@ -0,0 +1,46 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.CallTransferAccepted" +fullName: "com.azure.communication.callautomation.models.events.CallTransferAccepted" +name: "CallTransferAccepted" +nameWithType: "CallTransferAccepted" +summary: "The CallTransferAccepted model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallTransferAccepted**
extends " +methods: +- uid: "com.azure.communication.callautomation.models.events.CallTransferAccepted.getResultInformation()" + fullName: "com.azure.communication.callautomation.models.events.CallTransferAccepted.getResultInformation()" + name: "getResultInformation()" + nameWithType: "CallTransferAccepted.getResultInformation()" + summary: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + syntax: "public ResultInformation getResultInformation()" + desc: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + returns: + description: "the resultInformation value." + type: "" +type: "class" +desc: "The CallTransferAccepted model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallTransferFailed.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallTransferFailed.yml new file mode 100644 index 000000000000..38130da8dbbc --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.CallTransferFailed.yml @@ -0,0 +1,46 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.CallTransferFailed" +fullName: "com.azure.communication.callautomation.models.events.CallTransferFailed" +name: "CallTransferFailed" +nameWithType: "CallTransferFailed" +summary: "The CallTransferFailed model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **CallTransferFailed**
extends " +methods: +- uid: "com.azure.communication.callautomation.models.events.CallTransferFailed.getResultInformation()" + fullName: "com.azure.communication.callautomation.models.events.CallTransferFailed.getResultInformation()" + name: "getResultInformation()" + nameWithType: "CallTransferFailed.getResultInformation()" + summary: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + syntax: "public ResultInformation getResultInformation()" + desc: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + returns: + description: "the resultInformation value." + type: "" +type: "class" +desc: "The CallTransferFailed model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ParticipantsUpdated.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ParticipantsUpdated.yml new file mode 100644 index 000000000000..8cbead0f6af4 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ParticipantsUpdated.yml @@ -0,0 +1,46 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.ParticipantsUpdated" +fullName: "com.azure.communication.callautomation.models.events.ParticipantsUpdated" +name: "ParticipantsUpdated" +nameWithType: "ParticipantsUpdated" +summary: "The ParticipantsUpdated model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **ParticipantsUpdated**
extends " +methods: +- uid: "com.azure.communication.callautomation.models.events.ParticipantsUpdated.getParticipants()" + fullName: "com.azure.communication.callautomation.models.events.ParticipantsUpdated.getParticipants()" + name: "getParticipants()" + nameWithType: "ParticipantsUpdated.getParticipants()" + summary: "Get the participants property: List of current participants in the call." + syntax: "public List getParticipants()" + desc: "Get the participants property: List of current participants in the call." + returns: + description: "the participants value." + type: "List<>" +type: "class" +desc: "The ParticipantsUpdated model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayCanceled.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayCanceled.yml new file mode 100644 index 000000000000..f8d6fd303ad4 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayCanceled.yml @@ -0,0 +1,41 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.PlayCanceled" +fullName: "com.azure.communication.callautomation.models.events.PlayCanceled" +name: "PlayCanceled" +nameWithType: "PlayCanceled" +summary: "The PlayCanceled model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **PlayCanceled**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.events.PlayCanceled.PlayCanceled()" + fullName: "com.azure.communication.callautomation.models.events.PlayCanceled.PlayCanceled()" + name: "PlayCanceled()" + nameWithType: "PlayCanceled.PlayCanceled()" + syntax: "public PlayCanceled()" +type: "class" +desc: "The PlayCanceled model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayCompleted.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayCompleted.yml new file mode 100644 index 000000000000..e241e3867887 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayCompleted.yml @@ -0,0 +1,52 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.PlayCompleted" +fullName: "com.azure.communication.callautomation.models.events.PlayCompleted" +name: "PlayCompleted" +nameWithType: "PlayCompleted" +summary: "The PlayCompleted model." +inheritances: +- "" +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "" + methodsRef: + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **PlayCompleted**
extends " +methods: +- uid: "com.azure.communication.callautomation.models.events.PlayCompleted.getResultInformation()" + fullName: "com.azure.communication.callautomation.models.events.PlayCompleted.getResultInformation()" + name: "getResultInformation()" + nameWithType: "PlayCompleted.getResultInformation()" + summary: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + overridden: "com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase.getResultInformation()" + syntax: "public ResultInformation getResultInformation()" + desc: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + returns: + description: "the resultInformation value." + type: "" +type: "class" +desc: "The PlayCompleted model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayFailed.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayFailed.yml new file mode 100644 index 000000000000..0d985cc681e0 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.PlayFailed.yml @@ -0,0 +1,52 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.PlayFailed" +fullName: "com.azure.communication.callautomation.models.events.PlayFailed" +name: "PlayFailed" +nameWithType: "PlayFailed" +summary: "The PlayFailed model." +inheritances: +- "" +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "" + methodsRef: + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **PlayFailed**
extends " +methods: +- uid: "com.azure.communication.callautomation.models.events.PlayFailed.getResultInformation()" + fullName: "com.azure.communication.callautomation.models.events.PlayFailed.getResultInformation()" + name: "getResultInformation()" + nameWithType: "PlayFailed.getResultInformation()" + summary: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + overridden: "com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase.getResultInformation()" + syntax: "public ResultInformation getResultInformation()" + desc: "Get the resultInformation property: Contains the resulting SIP code/sub-code and message from NGC services." + returns: + description: "the resultInformation value." + type: "" +type: "class" +desc: "The PlayFailed model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.Play.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.Play.yml new file mode 100644 index 000000000000..c8656f93ce50 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.Play.yml @@ -0,0 +1,64 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.ReasonCode.Play" +fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Play" +name: "ReasonCode.Play" +nameWithType: "ReasonCode.Play" +summary: "Reason code names for the Play operation" +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public static class **ReasonCode.Play**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.Play.Play()" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Play.Play()" + name: "Play()" + nameWithType: "ReasonCode.Play.Play()" + syntax: "public Play()" +fields: +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.Play.DOWNLOAD_FAILED" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Play.DOWNLOAD_FAILED" + name: "DOWNLOAD_FAILED" + nameWithType: "ReasonCode.Play.DOWNLOAD_FAILED" + summary: "Action failed, file could not be downloaded." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonCode DOWNLOAD_FAILED" + desc: "Action failed, file could not be downloaded." +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.Play.INVALID_FILE_FORMAT" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Play.INVALID_FILE_FORMAT" + name: "INVALID_FILE_FORMAT" + nameWithType: "ReasonCode.Play.INVALID_FILE_FORMAT" + summary: "Action failed, file could not be downloaded." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonCode INVALID_FILE_FORMAT" + desc: "Action failed, file could not be downloaded." +type: "class" +desc: "Reason code names for the Play operation" +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.Recognize.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.Recognize.yml new file mode 100644 index 000000000000..15f7adadb1c7 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.Recognize.yml @@ -0,0 +1,100 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize" +fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize" +name: "ReasonCode.Recognize" +nameWithType: "ReasonCode.Recognize" +summary: "Reason code names for the Recognize operation" +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public static class **ReasonCode.Recognize**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.Recognize()" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.Recognize()" + name: "Recognize()" + nameWithType: "ReasonCode.Recognize.Recognize()" + syntax: "public Recognize()" +fields: +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.INITIAL_SILENCE_TIMEOUT" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.INITIAL_SILENCE_TIMEOUT" + name: "INITIAL_SILENCE_TIMEOUT" + nameWithType: "ReasonCode.Recognize.INITIAL_SILENCE_TIMEOUT" + summary: "Action failed, initial silence timeout reached." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonCode INITIAL_SILENCE_TIMEOUT" + desc: "Action failed, initial silence timeout reached." +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.INTER_DIGIT_TIMEOUT" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.INTER_DIGIT_TIMEOUT" + name: "INTER_DIGIT_TIMEOUT" + nameWithType: "ReasonCode.Recognize.INTER_DIGIT_TIMEOUT" + summary: "Action failed, inter-digit silence timeout reached." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonCode INTER_DIGIT_TIMEOUT" + desc: "Action failed, inter-digit silence timeout reached." +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.MAX_DIGITS_RECEIVED" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.MAX_DIGITS_RECEIVED" + name: "MAX_DIGITS_RECEIVED" + nameWithType: "ReasonCode.Recognize.MAX_DIGITS_RECEIVED" + summary: "Action completed, max digits received." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonCode MAX_DIGITS_RECEIVED" + desc: "Action completed, max digits received." +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.PLAY_PROMPT_FAILED" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.PLAY_PROMPT_FAILED" + name: "PLAY_PROMPT_FAILED" + nameWithType: "ReasonCode.Recognize.PLAY_PROMPT_FAILED" + summary: "Action failed, encountered failure while trying to play the prompt." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonCode PLAY_PROMPT_FAILED" + desc: "Action failed, encountered failure while trying to play the prompt." +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.STOP_TONE_DETECTED" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.Recognize.STOP_TONE_DETECTED" + name: "STOP_TONE_DETECTED" + nameWithType: "ReasonCode.Recognize.STOP_TONE_DETECTED" + summary: "Action completed as stop tone was detected." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonCode STOP_TONE_DETECTED" + desc: "Action completed as stop tone was detected." +type: "class" +desc: "Reason code names for the Recognize operation" +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.yml new file mode 100644 index 000000000000..b07223135052 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ReasonCode.yml @@ -0,0 +1,64 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.ReasonCode" +fullName: "com.azure.communication.callautomation.models.events.ReasonCode" +name: "ReasonCode" +nameWithType: "ReasonCode" +summary: "Defines values for ReasonCode." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public class **ReasonCode**
extends <>" +constructors: +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.ReasonCode()" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.ReasonCode()" + name: "ReasonCode()" + nameWithType: "ReasonCode.ReasonCode()" + syntax: "public ReasonCode()" +fields: +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.COMPLETED_SUCCESSFULLY" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.COMPLETED_SUCCESSFULLY" + name: "COMPLETED_SUCCESSFULLY" + nameWithType: "ReasonCode.COMPLETED_SUCCESSFULLY" + summary: "Action completed successfully." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonCode COMPLETED_SUCCESSFULLY" + desc: "Action completed successfully." +- uid: "com.azure.communication.callautomation.models.events.ReasonCode.UNSPECIFIED_ERROR" + fullName: "com.azure.communication.callautomation.models.events.ReasonCode.UNSPECIFIED_ERROR" + name: "UNSPECIFIED_ERROR" + nameWithType: "ReasonCode.UNSPECIFIED_ERROR" + summary: "Unknown internal server error." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonCode UNSPECIFIED_ERROR" + desc: "Unknown internal server error." +type: "class" +desc: "Defines values for ReasonCode." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeCanceled.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeCanceled.yml new file mode 100644 index 000000000000..14c1fc502981 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeCanceled.yml @@ -0,0 +1,41 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.RecognizeCanceled" +fullName: "com.azure.communication.callautomation.models.events.RecognizeCanceled" +name: "RecognizeCanceled" +nameWithType: "RecognizeCanceled" +summary: "The RecognizeCanceled model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecognizeCanceled**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.events.RecognizeCanceled.RecognizeCanceled()" + fullName: "com.azure.communication.callautomation.models.events.RecognizeCanceled.RecognizeCanceled()" + name: "RecognizeCanceled()" + nameWithType: "RecognizeCanceled.RecognizeCanceled()" + syntax: "public RecognizeCanceled()" +type: "class" +desc: "The RecognizeCanceled model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeCompleted.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeCompleted.yml new file mode 100644 index 000000000000..b573ddf61938 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeCompleted.yml @@ -0,0 +1,67 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.RecognizeCompleted" +fullName: "com.azure.communication.callautomation.models.events.RecognizeCompleted" +name: "RecognizeCompleted" +nameWithType: "RecognizeCompleted" +summary: "The RecognizeCompleted model." +inheritances: +- "" +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "" + methodsRef: + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecognizeCompleted**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.events.RecognizeCompleted.RecognizeCompleted()" + fullName: "com.azure.communication.callautomation.models.events.RecognizeCompleted.RecognizeCompleted()" + name: "RecognizeCompleted()" + nameWithType: "RecognizeCompleted.RecognizeCompleted()" + syntax: "public RecognizeCompleted()" +methods: +- uid: "com.azure.communication.callautomation.models.events.RecognizeCompleted.getCollectTonesResult()" + fullName: "com.azure.communication.callautomation.models.events.RecognizeCompleted.getCollectTonesResult()" + name: "getCollectTonesResult()" + nameWithType: "RecognizeCompleted.getCollectTonesResult()" + summary: "Get the collectTonesResult property: Defines the result for CallMediaRecognitionType = Dtmf." + syntax: "public CollectTonesResult getCollectTonesResult()" + desc: "Get the collectTonesResult property: Defines the result for CallMediaRecognitionType = Dtmf." + returns: + description: "the collectTonesResult value." + type: "" +- uid: "com.azure.communication.callautomation.models.events.RecognizeCompleted.getRecognitionType()" + fullName: "com.azure.communication.callautomation.models.events.RecognizeCompleted.getRecognitionType()" + name: "getRecognitionType()" + nameWithType: "RecognizeCompleted.getRecognitionType()" + summary: "Get the recognitionType property: Determines the sub-type of the recognize operation." + syntax: "public CallMediaRecognitionType getRecognitionType()" + desc: "Get the recognitionType property: Determines the sub-type of the recognize operation. In case of cancel operation the this field is not set and is returned empty." + returns: + description: "the recognitionType value." + type: "" +type: "class" +desc: "The RecognizeCompleted model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeFailed.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeFailed.yml new file mode 100644 index 000000000000..bb43d7311967 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecognizeFailed.yml @@ -0,0 +1,46 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.RecognizeFailed" +fullName: "com.azure.communication.callautomation.models.events.RecognizeFailed" +name: "RecognizeFailed" +nameWithType: "RecognizeFailed" +summary: "The RecognizeFailed model." +inheritances: +- "" +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "" + methodsRef: + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecognizeFailed**
extends " +constructors: +- uid: "com.azure.communication.callautomation.models.events.RecognizeFailed.RecognizeFailed()" + fullName: "com.azure.communication.callautomation.models.events.RecognizeFailed.RecognizeFailed()" + name: "RecognizeFailed()" + nameWithType: "RecognizeFailed.RecognizeFailed()" + syntax: "public RecognizeFailed()" +type: "class" +desc: "The RecognizeFailed model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecordingStateChanged.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecordingStateChanged.yml new file mode 100644 index 000000000000..e88c4bdb67f2 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.RecordingStateChanged.yml @@ -0,0 +1,66 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.RecordingStateChanged" +fullName: "com.azure.communication.callautomation.models.events.RecordingStateChanged" +name: "RecordingStateChanged" +nameWithType: "RecordingStateChanged" +summary: "The RecordingStateChanged model." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecordingStateChanged**
extends " +methods: +- uid: "com.azure.communication.callautomation.models.events.RecordingStateChanged.getRecordingId()" + fullName: "com.azure.communication.callautomation.models.events.RecordingStateChanged.getRecordingId()" + name: "getRecordingId()" + nameWithType: "RecordingStateChanged.getRecordingId()" + summary: "Get the recordingId property: Recording Id." + syntax: "public String getRecordingId()" + desc: "Get the recordingId property: Recording Id." + returns: + description: "the recordingId value." + type: "String" +- uid: "com.azure.communication.callautomation.models.events.RecordingStateChanged.getRecordingState()" + fullName: "com.azure.communication.callautomation.models.events.RecordingStateChanged.getRecordingState()" + name: "getRecordingState()" + nameWithType: "RecordingStateChanged.getRecordingState()" + summary: "Get the recordingState property: Recording State." + syntax: "public RecordingState getRecordingState()" + desc: "Get the recordingState property: Recording State." + returns: + description: "the recordingState value." + type: "" +- uid: "com.azure.communication.callautomation.models.events.RecordingStateChanged.getStartDateTime()" + fullName: "com.azure.communication.callautomation.models.events.RecordingStateChanged.getStartDateTime()" + name: "getStartDateTime()" + nameWithType: "RecordingStateChanged.getStartDateTime()" + summary: "Get the startDateTime property: Start Date time." + syntax: "public OffsetDateTime getStartDateTime()" + desc: "Get the startDateTime property: Start Date time." + returns: + description: "the startDateTime value." + type: "OffsetDateTime" +type: "class" +desc: "The RecordingStateChanged model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ResultInformation.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ResultInformation.yml new file mode 100644 index 000000000000..6fe13cd5ecdb --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.ResultInformation.yml @@ -0,0 +1,59 @@ +### YamlMime:JavaType +uid: "com.azure.communication.callautomation.models.events.ResultInformation" +fullName: "com.azure.communication.callautomation.models.events.ResultInformation" +name: "ResultInformation" +nameWithType: "ResultInformation" +summary: "The ResultInformation model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **ResultInformation**" +methods: +- uid: "com.azure.communication.callautomation.models.events.ResultInformation.getCode()" + fullName: "com.azure.communication.callautomation.models.events.ResultInformation.getCode()" + name: "getCode()" + nameWithType: "ResultInformation.getCode()" + summary: "Get the code property: The code property." + syntax: "public Integer getCode()" + desc: "Get the code property: The code property." + returns: + description: "the code value." + type: "Integer" +- uid: "com.azure.communication.callautomation.models.events.ResultInformation.getMessage()" + fullName: "com.azure.communication.callautomation.models.events.ResultInformation.getMessage()" + name: "getMessage()" + nameWithType: "ResultInformation.getMessage()" + summary: "Get the message property: The message property." + syntax: "public String getMessage()" + desc: "Get the message property: The message property." + returns: + description: "the message value." + type: "String" +- uid: "com.azure.communication.callautomation.models.events.ResultInformation.getSubCode()" + fullName: "com.azure.communication.callautomation.models.events.ResultInformation.getSubCode()" + name: "getSubCode()" + nameWithType: "ResultInformation.getSubCode()" + summary: "Get the subCode property: The subCode property." + syntax: "public Integer getSubCode()" + desc: "Get the subCode property: The subCode property." + returns: + description: "the subCode value." + type: "Integer" +type: "class" +desc: "The ResultInformation model." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.yml new file mode 100644 index 000000000000..add2b8cde46b --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.events.yml @@ -0,0 +1,30 @@ +### YamlMime:JavaPackage +uid: "com.azure.communication.callautomation.models.events" +fullName: "com.azure.communication.callautomation.models.events" +name: "com.azure.communication.callautomation.models.events" +summary: "Package containing events for AzureCommunicationCallingServerService." +classes: +- "com.azure.communication.callautomation.models.events.AddParticipantsFailed" +- "com.azure.communication.callautomation.models.events.AddParticipantsSucceeded" +- "com.azure.communication.callautomation.models.events.CallAutomationEventBase" +- "com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase" +- "com.azure.communication.callautomation.models.events.CallConnected" +- "com.azure.communication.callautomation.models.events.CallDisconnected" +- "com.azure.communication.callautomation.models.events.CallTransferAccepted" +- "com.azure.communication.callautomation.models.events.CallTransferFailed" +- "com.azure.communication.callautomation.models.events.ParticipantsUpdated" +- "com.azure.communication.callautomation.models.events.PlayCanceled" +- "com.azure.communication.callautomation.models.events.PlayCompleted" +- "com.azure.communication.callautomation.models.events.PlayFailed" +- "com.azure.communication.callautomation.models.events.ReasonCode" +- "com.azure.communication.callautomation.models.events.ReasonCode.Play" +- "com.azure.communication.callautomation.models.events.ReasonCode.Recognize" +- "com.azure.communication.callautomation.models.events.RecognizeCanceled" +- "com.azure.communication.callautomation.models.events.RecognizeCompleted" +- "com.azure.communication.callautomation.models.events.RecognizeFailed" +- "com.azure.communication.callautomation.models.events.RecordingStateChanged" +- "com.azure.communication.callautomation.models.events.ResultInformation" +desc: "Package containing events for AzureCommunicationCallingServerService. null." +metadata: {} +package: "com.azure.communication.callautomation.models.events" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.models.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.yml new file mode 100644 index 000000000000..6f0d23ec9b55 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.models.yml @@ -0,0 +1,56 @@ +### YamlMime:JavaPackage +uid: "com.azure.communication.callautomation.models" +fullName: "com.azure.communication.callautomation.models" +name: "com.azure.communication.callautomation.models" +summary: "Package containing classes for AzureCommunicationCallAutomationService." +classes: +- "com.azure.communication.callautomation.models.AddParticipantsOptions" +- "com.azure.communication.callautomation.models.AddParticipantsResult" +- "com.azure.communication.callautomation.models.AnswerCallOptions" +- "com.azure.communication.callautomation.models.AnswerCallResult" +- "com.azure.communication.callautomation.models.CallConnectionProperties" +- "com.azure.communication.callautomation.models.CallConnectionState" +- "com.azure.communication.callautomation.models.CallLocator" +- "com.azure.communication.callautomation.models.CallLocatorKind" +- "com.azure.communication.callautomation.models.CallMediaRecognitionType" +- "com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions" +- "com.azure.communication.callautomation.models.CallMediaRecognizeOptions" +- "com.azure.communication.callautomation.models.CallParticipant" +- "com.azure.communication.callautomation.models.CallRejectReason" +- "com.azure.communication.callautomation.models.CallResult" +- "com.azure.communication.callautomation.models.CallSource" +- "com.azure.communication.callautomation.models.CallingOperationStatus" +- "com.azure.communication.callautomation.models.CallingServerError" +- "com.azure.communication.callautomation.models.CallingServerErrorException" +- "com.azure.communication.callautomation.models.CollectTonesResult" +- "com.azure.communication.callautomation.models.CreateCallOptions" +- "com.azure.communication.callautomation.models.CreateCallResult" +- "com.azure.communication.callautomation.models.DownloadToFileOptions" +- "com.azure.communication.callautomation.models.DtmfTone" +- "com.azure.communication.callautomation.models.FileSource" +- "com.azure.communication.callautomation.models.GroupCallLocator" +- "com.azure.communication.callautomation.models.HangUpOptions" +- "com.azure.communication.callautomation.models.ListParticipantsResult" +- "com.azure.communication.callautomation.models.ParallelDownloadOptions" +- "com.azure.communication.callautomation.models.PlayOptions" +- "com.azure.communication.callautomation.models.PlaySource" +- "com.azure.communication.callautomation.models.PlaySourceType" +- "com.azure.communication.callautomation.models.RecognizeInputType" +- "com.azure.communication.callautomation.models.RecordingChannel" +- "com.azure.communication.callautomation.models.RecordingContent" +- "com.azure.communication.callautomation.models.RecordingFormat" +- "com.azure.communication.callautomation.models.RecordingState" +- "com.azure.communication.callautomation.models.RecordingStateResult" +- "com.azure.communication.callautomation.models.RedirectCallOptions" +- "com.azure.communication.callautomation.models.RejectCallOptions" +- "com.azure.communication.callautomation.models.RemoveParticipantsOptions" +- "com.azure.communication.callautomation.models.RemoveParticipantsResult" +- "com.azure.communication.callautomation.models.RepeatabilityHeaders" +- "com.azure.communication.callautomation.models.ServerCallLocator" +- "com.azure.communication.callautomation.models.StartRecordingOptions" +- "com.azure.communication.callautomation.models.TransferCallResult" +- "com.azure.communication.callautomation.models.TransferToParticipantCallOptions" +desc: "Package containing classes for AzureCommunicationCallAutomationService. Azure Communication Service Call Automation\n APIs." +metadata: {} +package: "com.azure.communication.callautomation.models" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.communication.callautomation.yml b/preview/docs-ref-autogen/com.azure.communication.callautomation.yml new file mode 100644 index 000000000000..b2e50319b2ea --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.communication.callautomation.yml @@ -0,0 +1,22 @@ +### YamlMime:JavaPackage +uid: "com.azure.communication.callautomation" +fullName: "com.azure.communication.callautomation" +name: "com.azure.communication.callautomation" +summary: "Package containing the classes for AzureCommunicationCallingServer." +classes: +- "com.azure.communication.callautomation.CallAutomationAsyncClient" +- "com.azure.communication.callautomation.CallAutomationClient" +- "com.azure.communication.callautomation.CallAutomationClientBuilder" +- "com.azure.communication.callautomation.CallConnection" +- "com.azure.communication.callautomation.CallConnectionAsync" +- "com.azure.communication.callautomation.CallMedia" +- "com.azure.communication.callautomation.CallMediaAsync" +- "com.azure.communication.callautomation.CallRecording" +- "com.azure.communication.callautomation.CallRecordingAsync" +- "com.azure.communication.callautomation.EventHandler" +enums: +- "com.azure.communication.callautomation.CallingServerServiceVersion" +desc: "Package containing the classes for AzureCommunicationCallingServer. Azure Communication CallingServer Service." +metadata: {} +package: "com.azure.communication.callautomation" +artifact: com.azure:azure-communication-callautomation:1.0.0-beta.1 diff --git a/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxAsyncHttpClientBuilder.yml b/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxAsyncHttpClientBuilder.yml index 9fcc57cdfc53..3530ed375c8f 100644 --- a/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxAsyncHttpClientBuilder.yml +++ b/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxAsyncHttpClientBuilder.yml @@ -154,4 +154,4 @@ type: "class" desc: "Builds a ." metadata: {} package: "com.azure.core.http.vertx" -artifact: com.azure:azure-core-http-vertx:1.0.0-beta.1 +artifact: com.azure:azure-core-http-vertx:1.0.0-beta.2 diff --git a/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxAsyncHttpClientProvider.yml b/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxAsyncHttpClientProvider.yml index 55408faaf1d3..429365a4111f 100644 --- a/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxAsyncHttpClientProvider.yml +++ b/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxAsyncHttpClientProvider.yml @@ -53,4 +53,4 @@ implements: - "" metadata: {} package: "com.azure.core.http.vertx" -artifact: com.azure:azure-core-http-vertx:1.0.0-beta.1 +artifact: com.azure:azure-core-http-vertx:1.0.0-beta.2 diff --git a/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxProvider.yml b/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxProvider.yml index 026f749ef8db..516426a0af6a 100644 --- a/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxProvider.yml +++ b/preview/docs-ref-autogen/com.azure.core.http.vertx.VertxProvider.yml @@ -22,4 +22,4 @@ type: "interface" desc: "Service provider interface providing platforms and applications the means to have their own managed be resolved by the ." metadata: {} package: "com.azure.core.http.vertx" -artifact: com.azure:azure-core-http-vertx:1.0.0-beta.1 +artifact: com.azure:azure-core-http-vertx:1.0.0-beta.2 diff --git a/preview/docs-ref-autogen/com.azure.core.http.vertx.yml b/preview/docs-ref-autogen/com.azure.core.http.vertx.yml index 51434314952c..30349c098ff1 100644 --- a/preview/docs-ref-autogen/com.azure.core.http.vertx.yml +++ b/preview/docs-ref-autogen/com.azure.core.http.vertx.yml @@ -11,4 +11,4 @@ interfaces: desc: "Package containing Vert.x HTTP client plugin for azure-core." metadata: {} package: "com.azure.core.http.vertx" -artifact: com.azure:azure-core-http-vertx:1.0.0-beta.1 +artifact: com.azure:azure-core-http-vertx:1.0.0-beta.2 diff --git a/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.OpenTelemetryMeterProvider.yml b/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.OpenTelemetryMeterProvider.yml index 516691a0cb58..178bd32124d5 100644 --- a/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.OpenTelemetryMeterProvider.yml +++ b/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.OpenTelemetryMeterProvider.yml @@ -54,4 +54,4 @@ implements: - "" metadata: {} package: "com.azure.core.metrics.opentelemetry" -artifact: com.azure:azure-core-metrics-opentelemetry:1.0.0-beta.2 +artifact: com.azure:azure-core-metrics-opentelemetry:1.0.0-beta.3 diff --git a/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.OpenTelemetryMetricsOptions.yml b/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.OpenTelemetryMetricsOptions.yml index b9f00fbbff37..360dcc150fc2 100644 --- a/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.OpenTelemetryMetricsOptions.yml +++ b/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.OpenTelemetryMetricsOptions.yml @@ -73,4 +73,4 @@ type: "class" desc: "OpenTelemetry-specific Azure SDK metrics options." metadata: {} package: "com.azure.core.metrics.opentelemetry" -artifact: com.azure:azure-core-metrics-opentelemetry:1.0.0-beta.2 +artifact: com.azure:azure-core-metrics-opentelemetry:1.0.0-beta.3 diff --git a/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.yml b/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.yml index b1de156f9ffe..fbfc3e7b8049 100644 --- a/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.yml +++ b/preview/docs-ref-autogen/com.azure.core.metrics.opentelemetry.yml @@ -9,4 +9,4 @@ classes: desc: "OpenTelemetry implementation of azure-core metrics API." metadata: {} package: "com.azure.core.metrics.opentelemetry" -artifact: com.azure:azure-core-metrics-opentelemetry:1.0.0-beta.2 +artifact: com.azure:azure-core-metrics-opentelemetry:1.0.0-beta.3 diff --git a/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializer.yml b/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializer.yml index 04c75a55a448..14b85a90414a 100644 --- a/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializer.yml +++ b/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializer.yml @@ -98,4 +98,4 @@ implements: - "" metadata: {} package: "com.azure.core.serializer.avro.apache" -artifact: com.azure:azure-core-serializer-avro-apache:1.0.0-beta.29 +artifact: com.azure:azure-core-serializer-avro-apache:1.0.0-beta.30 diff --git a/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializerBuilder.yml b/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializerBuilder.yml index 7d2d7f7ac2af..9ec07bdeb2d4 100644 --- a/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializerBuilder.yml +++ b/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializerBuilder.yml @@ -98,4 +98,4 @@ type: "class" desc: "Fluent builder class that configures and instantiates instances of ." metadata: {} package: "com.azure.core.serializer.avro.apache" -artifact: com.azure:azure-core-serializer-avro-apache:1.0.0-beta.29 +artifact: com.azure:azure-core-serializer-avro-apache:1.0.0-beta.30 diff --git a/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializerProvider.yml b/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializerProvider.yml index 8a9dea95c7d3..b85c6b8caa95 100644 --- a/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializerProvider.yml +++ b/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.ApacheAvroSerializerProvider.yml @@ -64,4 +64,4 @@ implements: - "" metadata: {} package: "com.azure.core.serializer.avro.apache" -artifact: com.azure:azure-core-serializer-avro-apache:1.0.0-beta.29 +artifact: com.azure:azure-core-serializer-avro-apache:1.0.0-beta.30 diff --git a/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.yml b/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.yml index 3a9863dd73d8..605061828790 100644 --- a/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.yml +++ b/preview/docs-ref-autogen/com.azure.core.serializer.avro.apache.yml @@ -10,4 +10,4 @@ classes: desc: "Package containing the types for instantiating and using the Apache Avro serializer." metadata: {} package: "com.azure.core.serializer.avro.apache" -artifact: com.azure:azure-core-serializer-avro-apache:1.0.0-beta.29 +artifact: com.azure:azure-core-serializer-avro-apache:1.0.0-beta.30 diff --git a/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.OpenTelemetryHttpPolicy.yml b/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.OpenTelemetryHttpPolicy.yml index a7737d293531..a63babe5f5ff 100644 --- a/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.OpenTelemetryHttpPolicy.yml +++ b/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.OpenTelemetryHttpPolicy.yml @@ -57,4 +57,4 @@ implements: - "" metadata: {} package: "com.azure.core.tracing.opentelemetry" -artifact: com.azure:azure-core-tracing-opentelemetry:1.0.0-beta.29 +artifact: com.azure:azure-core-tracing-opentelemetry:1.0.0-beta.30 diff --git a/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.OpenTelemetryTracer.yml b/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.OpenTelemetryTracer.yml index 6359eb1469be..4b21890fb7e3 100644 --- a/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.OpenTelemetryTracer.yml +++ b/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.OpenTelemetryTracer.yml @@ -192,4 +192,4 @@ implements: - "" metadata: {} package: "com.azure.core.tracing.opentelemetry" -artifact: com.azure:azure-core-tracing-opentelemetry:1.0.0-beta.29 +artifact: com.azure:azure-core-tracing-opentelemetry:1.0.0-beta.30 diff --git a/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.yml b/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.yml index dd66dd64364c..2b0d9b354dbb 100644 --- a/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.yml +++ b/preview/docs-ref-autogen/com.azure.core.tracing.opentelemetry.yml @@ -9,4 +9,4 @@ classes: desc: "An OpenTelemetry implementation of the tracing APIs required by azure-core to enable users to effectively trace their\n calls and have this information submitted to an OpenTelemetry backend." metadata: {} package: "com.azure.core.tracing.opentelemetry" -artifact: com.azure:azure-core-tracing-opentelemetry:1.0.0-beta.29 +artifact: com.azure:azure-core-tracing-opentelemetry:1.0.0-beta.30 diff --git a/preview/docs-ref-autogen/toc.yml b/preview/docs-ref-autogen/toc.yml index 0975b8b8867e..aa9de45133d2 100644 --- a/preview/docs-ref-autogen/toc.yml +++ b/preview/docs-ref-autogen/toc.yml @@ -65786,3 +65786,166 @@ name: TestRunAsyncClient - uid: com.azure.developer.loadtesting.TestRunClient name: TestRunClient +- uid: com.azure.communication.callautomation + name: com.azure.communication.callautomation + items: + - uid: com.azure.communication.callautomation.CallAutomationAsyncClient + name: CallAutomationAsyncClient + - uid: com.azure.communication.callautomation.CallAutomationClient + name: CallAutomationClient + - uid: com.azure.communication.callautomation.CallAutomationClientBuilder + name: CallAutomationClientBuilder + - uid: com.azure.communication.callautomation.CallConnection + name: CallConnection + - uid: com.azure.communication.callautomation.CallConnectionAsync + name: CallConnectionAsync + - uid: com.azure.communication.callautomation.CallMedia + name: CallMedia + - uid: com.azure.communication.callautomation.CallMediaAsync + name: CallMediaAsync + - uid: com.azure.communication.callautomation.CallRecording + name: CallRecording + - uid: com.azure.communication.callautomation.CallRecordingAsync + name: CallRecordingAsync + - uid: com.azure.communication.callautomation.CallingServerServiceVersion + name: CallingServerServiceVersion + - uid: com.azure.communication.callautomation.EventHandler + name: EventHandler +- uid: com.azure.communication.callautomation.models.events + name: com.azure.communication.callautomation.models.events + items: + - uid: com.azure.communication.callautomation.models.events.AddParticipantsFailed + name: AddParticipantsFailed + - uid: com.azure.communication.callautomation.models.events.AddParticipantsSucceeded + name: AddParticipantsSucceeded + - uid: com.azure.communication.callautomation.models.events.CallAutomationEventBase + name: CallAutomationEventBase + - uid: com.azure.communication.callautomation.models.events.CallAutomationEventWithReasonCodeBase + name: CallAutomationEventWithReasonCodeBase + - uid: com.azure.communication.callautomation.models.events.CallConnected + name: CallConnected + - uid: com.azure.communication.callautomation.models.events.CallDisconnected + name: CallDisconnected + - uid: com.azure.communication.callautomation.models.events.CallTransferAccepted + name: CallTransferAccepted + - uid: com.azure.communication.callautomation.models.events.CallTransferFailed + name: CallTransferFailed + - uid: com.azure.communication.callautomation.models.events.ParticipantsUpdated + name: ParticipantsUpdated + - uid: com.azure.communication.callautomation.models.events.PlayCanceled + name: PlayCanceled + - uid: com.azure.communication.callautomation.models.events.PlayCompleted + name: PlayCompleted + - uid: com.azure.communication.callautomation.models.events.PlayFailed + name: PlayFailed + - uid: com.azure.communication.callautomation.models.events.ReasonCode + name: ReasonCode + - uid: com.azure.communication.callautomation.models.events.ReasonCode.Play + name: ReasonCode.Play + - uid: com.azure.communication.callautomation.models.events.ReasonCode.Recognize + name: ReasonCode.Recognize + - uid: com.azure.communication.callautomation.models.events.RecognizeCanceled + name: RecognizeCanceled + - uid: com.azure.communication.callautomation.models.events.RecognizeCompleted + name: RecognizeCompleted + - uid: com.azure.communication.callautomation.models.events.RecognizeFailed + name: RecognizeFailed + - uid: com.azure.communication.callautomation.models.events.RecordingStateChanged + name: RecordingStateChanged + - uid: com.azure.communication.callautomation.models.events.ResultInformation + name: ResultInformation +- uid: com.azure.communication.callautomation.models + name: com.azure.communication.callautomation.models + items: + - uid: com.azure.communication.callautomation.models.AddParticipantsOptions + name: AddParticipantsOptions + - uid: com.azure.communication.callautomation.models.AddParticipantsResult + name: AddParticipantsResult + - uid: com.azure.communication.callautomation.models.AnswerCallOptions + name: AnswerCallOptions + - uid: com.azure.communication.callautomation.models.AnswerCallResult + name: AnswerCallResult + - uid: com.azure.communication.callautomation.models.CallConnectionProperties + name: CallConnectionProperties + - uid: com.azure.communication.callautomation.models.CallConnectionState + name: CallConnectionState + - uid: com.azure.communication.callautomation.models.CallLocator + name: CallLocator + - uid: com.azure.communication.callautomation.models.CallLocatorKind + name: CallLocatorKind + - uid: com.azure.communication.callautomation.models.CallMediaRecognitionType + name: CallMediaRecognitionType + - uid: com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions + name: CallMediaRecognizeDtmfOptions + - uid: com.azure.communication.callautomation.models.CallMediaRecognizeOptions + name: CallMediaRecognizeOptions + - uid: com.azure.communication.callautomation.models.CallParticipant + name: CallParticipant + - uid: com.azure.communication.callautomation.models.CallRejectReason + name: CallRejectReason + - uid: com.azure.communication.callautomation.models.CallResult + name: CallResult + - uid: com.azure.communication.callautomation.models.CallSource + name: CallSource + - uid: com.azure.communication.callautomation.models.CallingOperationStatus + name: CallingOperationStatus + - uid: com.azure.communication.callautomation.models.CallingServerError + name: CallingServerError + - uid: com.azure.communication.callautomation.models.CallingServerErrorException + name: CallingServerErrorException + - uid: com.azure.communication.callautomation.models.CollectTonesResult + name: CollectTonesResult + - uid: com.azure.communication.callautomation.models.CreateCallOptions + name: CreateCallOptions + - uid: com.azure.communication.callautomation.models.CreateCallResult + name: CreateCallResult + - uid: com.azure.communication.callautomation.models.DownloadToFileOptions + name: DownloadToFileOptions + - uid: com.azure.communication.callautomation.models.DtmfTone + name: DtmfTone + - uid: com.azure.communication.callautomation.models.FileSource + name: FileSource + - uid: com.azure.communication.callautomation.models.GroupCallLocator + name: GroupCallLocator + - uid: com.azure.communication.callautomation.models.HangUpOptions + name: HangUpOptions + - uid: com.azure.communication.callautomation.models.ListParticipantsResult + name: ListParticipantsResult + - uid: com.azure.communication.callautomation.models.ParallelDownloadOptions + name: ParallelDownloadOptions + - uid: com.azure.communication.callautomation.models.PlayOptions + name: PlayOptions + - uid: com.azure.communication.callautomation.models.PlaySource + name: PlaySource + - uid: com.azure.communication.callautomation.models.PlaySourceType + name: PlaySourceType + - uid: com.azure.communication.callautomation.models.RecognizeInputType + name: RecognizeInputType + - uid: com.azure.communication.callautomation.models.RecordingChannel + name: RecordingChannel + - uid: com.azure.communication.callautomation.models.RecordingContent + name: RecordingContent + - uid: com.azure.communication.callautomation.models.RecordingFormat + name: RecordingFormat + - uid: com.azure.communication.callautomation.models.RecordingState + name: RecordingState + - uid: com.azure.communication.callautomation.models.RecordingStateResult + name: RecordingStateResult + - uid: com.azure.communication.callautomation.models.RedirectCallOptions + name: RedirectCallOptions + - uid: com.azure.communication.callautomation.models.RejectCallOptions + name: RejectCallOptions + - uid: com.azure.communication.callautomation.models.RemoveParticipantsOptions + name: RemoveParticipantsOptions + - uid: com.azure.communication.callautomation.models.RemoveParticipantsResult + name: RemoveParticipantsResult + - uid: com.azure.communication.callautomation.models.RepeatabilityHeaders + name: RepeatabilityHeaders + - uid: com.azure.communication.callautomation.models.ServerCallLocator + name: ServerCallLocator + - uid: com.azure.communication.callautomation.models.StartRecordingOptions + name: StartRecordingOptions + - uid: com.azure.communication.callautomation.models.TransferCallResult + name: TransferCallResult + - uid: com.azure.communication.callautomation.models.TransferToParticipantCallOptions + name: TransferToParticipantCallOptions diff --git a/preview/docs-ref-mapping/reference-preview.yml b/preview/docs-ref-mapping/reference-preview.yml index 02b9262d271e..c811c6279011 100644 --- a/preview/docs-ref-mapping/reference-preview.yml +++ b/preview/docs-ref-mapping/reference-preview.yml @@ -265,6 +265,10 @@ href: ~/docs-ref-services/preview/communication.md landingPageType: Service items: + - name: Communication Call Automation + landingPageType: Service + children: + - com.azure.communication.callautomation - name: Communication Common href: ~/docs-ref-services/preview/communication-common-readme.md children: @@ -1365,7 +1369,7 @@ - com.azure.resourcemanager.managedapplications.fluent - com.azure.resourcemanager.managedapplications.fluent.models - com.azure.resourcemanager.managedapplications.models - - name: Maps + - name: maps href: ~/docs-ref-services/preview/maps.md landingPageType: Service items: