Index
All Classes and Interfaces|All Packages
A
- addConnectionToGroupWithResponse(String, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Add a connection to the target group.
- addConnectionToGroupWithResponse(String, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Add a connection to the target group.
- addGroup(String) - Method in class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
-
Adds a group to the requested authentication token.
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Adds a
pipeline policyto apply on each request sent. - addRole(String) - Method in class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
-
Adds a role to the requested authentication token.
- addUserToGroupWithResponse(String, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Add a user to the target group.
- addUserToGroupWithResponse(String, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Add a user to the target group.
- APPLICATION_JSON - Enum constant in enum com.azure.messaging.webpubsub.models.WebPubSubContentType
-
Enum value application/json.
- APPLICATION_OCTET_STREAM - Enum constant in enum com.azure.messaging.webpubsub.models.WebPubSubContentType
-
Enum value application/octet-stream.
B
- buildAsyncClient() - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Builds an instance of WebPubSubAsyncServiceClient with the provided parameters.
- buildClient() - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Builds an instance of WebPubSubServiceClient with the provided parameters.
C
- checkPermissionWithResponse(WebPubSubPermission, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Check if a connection has permission to the specified action.
- checkPermissionWithResponse(WebPubSubPermission, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Check if a connection has permission to the specified action.
- clientOptions(ClientOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Allows for setting common properties such as application ID, headers, proxy configuration, etc.
- closeAllConnectionsWithResponse(RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Close the connections in the hub.
- closeAllConnectionsWithResponse(RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Close the connections in the hub.
- closeConnectionWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Close the client connection.
- closeConnectionWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Close the client connection.
- closeGroupConnectionsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Close connections in the specific group.
- closeGroupConnectionsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Close connections in the specific group.
- closeUserConnectionsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Close connections for the specific user.
- closeUserConnectionsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Close connections for the specific user.
- com.azure.messaging.webpubsub - package com.azure.messaging.webpubsub
-
Package containing classes for creating clients to perform operations on the Azure Web Pub Sub Service.
- com.azure.messaging.webpubsub.models - package com.azure.messaging.webpubsub.models
-
Package containing model classes for use with the Azure Web Pub Sub Service.
- configuration(Configuration) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the configuration store that is used during construction of the service client.
- connectionExistsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Check if the connection with the given connectionId exists.
- connectionExistsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Check if the connection with the given connectionId exists.
- connectionString(String) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the credential to use when authenticating HTTP requests.
- credential(AzureKeyCredential) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the
AzureKeyCredentialused to authenticate HTTP requests. - credential(TokenCredential) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the
TokenCredentialused to authorize requests sent to the service.
E
- endpoint(String) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the service endpoint for the Azure Web Pub Sub instance.
F
- fromString(String) - Static method in enum com.azure.messaging.webpubsub.models.WebPubSubContentType
-
Parses a serialized value to a ContentType instance.
- fromString(String) - Static method in class com.azure.messaging.webpubsub.models.WebPubSubPermission
-
Creates or finds a WebPubSubPermission from its string representation.
G
- getClientAccessToken(GetClientAccessTokenOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Creates a client access token.
- getClientAccessToken(GetClientAccessTokenOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Creates a client access token.
- GetClientAccessTokenOptions - Class in com.azure.messaging.webpubsub.models
-
Options class for configuring the
getClientAccessToken(GetClientAccessTokenOptions)andWebPubSubServiceClient.getClientAccessToken(GetClientAccessTokenOptions)methods. - GetClientAccessTokenOptions() - Constructor for class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
- getExpiresAfter() - Method in class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
-
Returns the duration after which the requested authentication token will expire.
- getGroups() - Method in class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
-
Returns the complete set of groups to be included when creating the authentication token.
- getLatest() - Static method in enum com.azure.messaging.webpubsub.WebPubSubServiceVersion
-
Gets the latest service version supported by this client library.
- getRoles() - Method in class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
-
Returns the complete set of roles to be included when creating the authentication token.
- getToken() - Method in class com.azure.messaging.webpubsub.models.WebPubSubClientAccessToken
-
Returns the client access token that may be used to access the service.
- getUrl() - Method in class com.azure.messaging.webpubsub.models.WebPubSubClientAccessToken
-
Returns the url that may be used to access the service.
- getUserId() - Method in class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
-
Returns the user ID to be used when creating the authentication token.
- getVersion() - Method in enum com.azure.messaging.webpubsub.WebPubSubServiceVersion
- grantPermissionWithResponse(WebPubSubPermission, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Grant permission to the connection.
- grantPermissionWithResponse(WebPubSubPermission, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Grant permission to the connection.
- groupExistsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Check if there are any client connections inside the given group.
- groupExistsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Check if there are any client connections inside the given group.
H
- httpClient(HttpClient) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the
HttpClientto use for sending and receiving requests to and from the service. - httpLogOptions(HttpLogOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the
logging configurationto use when sending and receiving requests to and from the service. - hub(String) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
J
- JOIN_LEAVE_GROUP - Static variable in class com.azure.messaging.webpubsub.models.WebPubSubPermission
-
Static value joinLeaveGroup for WebPubSubPermission.
P
- pipeline(HttpPipeline) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the
HttpPipelineto use for the service client. - process(HttpPipelineCallContext, HttpPipelineNextPolicy) - Method in class com.azure.messaging.webpubsub.WebPubSubAuthenticationPolicy
R
- removeConnectionFromAllGroupsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Remove a connection from all groups.
- removeConnectionFromAllGroupsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Remove a connection from all groups.
- removeConnectionFromGroupWithResponse(String, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Remove a connection from the target group.
- removeConnectionFromGroupWithResponse(String, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Remove a connection from the target group.
- removeUserFromAllGroupsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Remove a user from all groups.
- removeUserFromAllGroupsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Remove a user from all groups.
- removeUserFromGroupWithResponse(String, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Remove a user from the target group.
- removeUserFromGroupWithResponse(String, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Remove a user from the target group.
- retryOptions(RetryOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the
RetryOptionsfor all the requests made through the client. - retryPolicy(RetryPolicy) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the
HttpPipelinePolicythat is used when each request is sent. - reverseProxyEndpoint(String) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the reverse proxy endpoint.
- revokePermissionWithResponse(WebPubSubPermission, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Revoke permission for the connection.
- revokePermissionWithResponse(WebPubSubPermission, String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Revoke permission for the connection.
S
- SEND_TO_GROUP - Static variable in class com.azure.messaging.webpubsub.models.WebPubSubPermission
-
Static value sendToGroup for WebPubSubPermission.
- sendToAll(String, WebPubSubContentType) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Broadcast content inside request body to all the connected client connections.
- sendToAll(String, WebPubSubContentType) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Broadcast content inside request body to all the connected client connections.
- sendToAllWithResponse(BinaryData, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Broadcast content inside request body to all the connected client connections.
- sendToAllWithResponse(BinaryData, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Broadcast content inside request body to all the connected client connections.
- sendToAllWithResponse(BinaryData, WebPubSubContentType, long, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Broadcast content inside request body to all the connected client connections.
- sendToAllWithResponse(BinaryData, WebPubSubContentType, long, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Broadcast content inside request body to all the connected client connections.
- sendToConnection(String, String, WebPubSubContentType) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Send content inside request body to the specific connection.
- sendToConnection(String, String, WebPubSubContentType) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Send content inside request body to the specific connection.
- sendToConnectionWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Send content inside request body to the specific connection.
- sendToConnectionWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Send content inside request body to the specific connection.
- sendToConnectionWithResponse(String, BinaryData, WebPubSubContentType, long, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Send content inside request body to the specific connection.
- sendToConnectionWithResponse(String, BinaryData, WebPubSubContentType, long, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Send content inside request body to the specific connection.
- sendToGroup(String, String, WebPubSubContentType) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Send content inside request body to a group of connections.
- sendToGroup(String, String, WebPubSubContentType) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Send content inside request body to a group of connections.
- sendToGroupWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Send content inside request body to a group of connections.
- sendToGroupWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Send content inside request body to a group of connections.
- sendToGroupWithResponse(String, BinaryData, WebPubSubContentType, long, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Send content inside request body to a group of connections.
- sendToGroupWithResponse(String, BinaryData, WebPubSubContentType, long, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Send content inside request body to a group of connections.
- sendToUser(String, String, WebPubSubContentType) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Send content inside request body to the specific user.
- sendToUser(String, String, WebPubSubContentType) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Send content inside request body to the specific user.
- sendToUserWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Send content inside request body to the specific user.
- sendToUserWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Send content inside request body to the specific user.
- sendToUserWithResponse(String, BinaryData, WebPubSubContentType, long, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Send content inside request body to the specific user.
- sendToUserWithResponse(String, BinaryData, WebPubSubContentType, long, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Send content inside request body to the specific user.
- serviceVersion(WebPubSubServiceVersion) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Sets the
WebPubSubServiceVersionthat is used when making API requests. - setExpiresAfter(Duration) - Method in class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
-
Specifies when the duration after which the requested authentication token will expire.
- setGroups(List<String>) - Method in class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
-
Specifies the complete set of groups to be included when creating the authentication token, overwriting any other groups previously set on this instance.
- setRoles(List<String>) - Method in class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
-
Specifies the complete set of roles to be included when creating the authentication token, overwriting any other roles previously set on this instance.
- setUserId(String) - Method in class com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions
-
Specifies the user ID to be used when creating the authentication token.
T
- TEXT_PLAIN - Enum constant in enum com.azure.messaging.webpubsub.models.WebPubSubContentType
-
Enum value text/plain.
- toString() - Method in enum com.azure.messaging.webpubsub.models.WebPubSubContentType
U
- userExistsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient
-
Check if there are any client connections connected for the given user.
- userExistsWithResponse(String, RequestOptions) - Method in class com.azure.messaging.webpubsub.WebPubSubServiceClient
-
Check if there are any client connections connected for the given user.
V
- V2021_10_01 - Enum constant in enum com.azure.messaging.webpubsub.WebPubSubServiceVersion
-
Enum value 2021-10-01.
- V2022_11_01 - Enum constant in enum com.azure.messaging.webpubsub.WebPubSubServiceVersion
-
Enum value 2022-11-01.
- valueOf(String) - Static method in enum com.azure.messaging.webpubsub.models.WebPubSubContentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.messaging.webpubsub.WebPubSubServiceVersion
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.azure.messaging.webpubsub.models.WebPubSubContentType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.messaging.webpubsub.models.WebPubSubPermission
- values() - Static method in enum com.azure.messaging.webpubsub.WebPubSubServiceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WebPubSubAuthenticationPolicy - Class in com.azure.messaging.webpubsub
-
An
HttpPipelinePolicyfor authenticating against the Azure Web Pub Sub service. - WebPubSubAuthenticationPolicy(AzureKeyCredential) - Constructor for class com.azure.messaging.webpubsub.WebPubSubAuthenticationPolicy
-
Creates a new instance of the WebPubSubAuthenticationPolicy, where it will make use of the provided
AzureKeyCredentialwhenever a HTTP request is made to apply the appropriate modifications to the HTTP request to gain access to the Azure Web Pub Sub service. - WebPubSubClientAccessToken - Class in com.azure.messaging.webpubsub.models
-
A wrapper class for results of the
getClientAccessTokenAPIs onWebPubSubServiceAsyncClientandWebPubSubServiceClient. - WebPubSubClientAccessToken(String, String) - Constructor for class com.azure.messaging.webpubsub.models.WebPubSubClientAccessToken
-
Creates a new instance with the given values set as immutable properties.
- WebPubSubContentType - Enum in com.azure.messaging.webpubsub.models
-
Defines values for ContentType.
- WebPubSubPermission - Class in com.azure.messaging.webpubsub.models
-
Defines values for WebPubSubPermission.
- WebPubSubPermission() - Constructor for class com.azure.messaging.webpubsub.models.WebPubSubPermission
- WebPubSubServiceAsyncClient - Class in com.azure.messaging.webpubsub
-
Initializes a new instance of the asynchronous AzureWebPubSubServiceRestAPI type.
- WebPubSubServiceClient - Class in com.azure.messaging.webpubsub
-
Initializes a new instance of the synchronous AzureWebPubSubServiceRestAPI type.
- WebPubSubServiceClientBuilder - Class in com.azure.messaging.webpubsub
-
This class provides a fluent builder API to aid the configuration and instantiation of
syncandasyncAzure Web Pub Sub clients, using thebuildClientandbuildAsyncClientmethods respectively. - WebPubSubServiceClientBuilder() - Constructor for class com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder
-
Creates a new builder instance with all values set to their default value.
- WebPubSubServiceVersion - Enum in com.azure.messaging.webpubsub
-
Service version of WebPubSubService.
All Classes and Interfaces|All Packages