Package org.azd.serviceendpoint.endpoints

Class EndpointsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.serviceendpoint.endpoints.EndpointsRequestBuilder

public class EndpointsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Service endpoint Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EndpointsRequestBuilder.DeleteQueryParameters	Represents the delete query parameters.
static class	EndpointsRequestBuilder.DeleteRequestConfiguration	Request configuration object for the query parameters.
static class	EndpointsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	EndpointsRequestBuilder.RequestConfiguration	Request configuration object for the query parameters.

Nested classes/interfaces inherited from class org.azd.abstractions.BaseRequestBuilder

BaseRequestBuilder.ProjectExcludeParameter

Field Summary

Fields inherited from class org.azd.abstractions.BaseRequestBuilder

accessTokenCredential, apiVersion, area, locationId, organizationUrl, serializer

Constructor Summary

Constructors

Constructor	Description
EndpointsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
ServiceEndpoint	create(ServiceEndpoint serviceEndpoint)	Creates a new service endpoint
CompletableFuture<ServiceEndpoint>	createAsync(ServiceEndpoint serviceEndpoint)	Creates a new service endpoint
Void	delete(String endpointId, Consumer<EndpointsRequestBuilder.DeleteRequestConfiguration> requestConfiguration)	Delete a service endpoint.
CompletableFuture<Void>	deleteAsync(String endpointId, Consumer<EndpointsRequestBuilder.DeleteRequestConfiguration> requestConfiguration)	Delete a service endpoint.
ServiceEndpoint	get(String endpointId)	Get the service endpoint details.
ServiceEndpoint	get(String endpointId, ServiceEndpointActionFilter actionFilter)	Get the service endpoint details.
CompletableFuture<ServiceEndpoint>	getAsync(String endpointId)	Get the service endpoint details.
CompletableFuture<ServiceEndpoint>	getAsync(String endpointId, ServiceEndpointActionFilter actionFilter)	Get the service endpoint details.
ServiceEndpoints	getByNames(String... endpointNames)	Get the service endpoints by name.
ServiceEndpoints	getByNames(Consumer<EndpointsRequestBuilder.RequestConfiguration> requestConfiguration)	Get the service endpoints by name.
CompletableFuture<ServiceEndpoints>	getByNamesAsync(String... endpointNames)	Get the service endpoints by name.
CompletableFuture<ServiceEndpoints>	getByNamesAsync(Consumer<EndpointsRequestBuilder.RequestConfiguration> requestConfiguration)	Get the service endpoints by name.
ServiceEndpoints	getWithRefreshedAuthentication(String[] endpointIds, List<RefreshAuthenticationParameters> refreshAuthenticationParameters)	Gets the service endpoints and patch new authorization parameters
CompletableFuture<ServiceEndpoints>	getWithRefreshedAuthenticationAsync(String[] endpointIds, List<RefreshAuthenticationParameters> refreshAuthenticationParameters)	Gets the service endpoints and patch new authorization parameters
ServiceEndpoints	list()	Get the service endpoints.
ServiceEndpoints	list(Consumer<EndpointsRequestBuilder.RequestConfiguration> requestConfiguration)	Get the service endpoints.
CompletableFuture<ServiceEndpoints>	listAsync()	Get the service endpoints.
CompletableFuture<ServiceEndpoints>	listAsync(Consumer<EndpointsRequestBuilder.RequestConfiguration> requestConfiguration)	Get the service endpoints.
Void	share(String endpointId, List<ServiceEndpointProjectReference> serviceEndpointProjectReferences)	Share service endpoint across projects
CompletableFuture<Void>	shareAsync(String endpointId, List<ServiceEndpointProjectReference> serviceEndpointProjectReferences)	Share service endpoint across projects
ServiceEndpoint	update(String endpointId, ServiceEndpoint serviceEndpoint)	Update the service endpoint
ServiceEndpoint	update(String endpointId, ServiceEndpoint serviceEndpoint, String operation)	Update the service endpoint
ServiceEndpoints	update(ServiceEndpoints serviceEndpoints)	Update the service endpoints.
CompletableFuture<ServiceEndpoint>	updateAsync(String endpointId, ServiceEndpoint serviceEndpoint)	Update the service endpoint
CompletableFuture<ServiceEndpoint>	updateAsync(String endpointId, ServiceEndpoint serviceEndpoint, String operation)	Update the service endpoint
CompletableFuture<ServiceEndpoints>	updateAsync(ServiceEndpoints serviceEndpoints)	Update the service endpoints.

Methods inherited from class org.azd.abstractions.BaseRequestBuilder

builder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EndpointsRequestBuilder

public EndpointsRequestBuilder(String organizationUrl,
 AccessTokenCredential accessTokenCredential)

Instantiates a new RequestBuilder instance and sets the default values.

Parameters:

organizationUrl - Represents organization location request url.

accessTokenCredential - Access token credential object.

Method Details

createAsync

public CompletableFuture<ServiceEndpoint> createAsync(ServiceEndpoint serviceEndpoint)
                                               throws AzDException

Creates a new service endpoint

Parameters:

serviceEndpoint - Service endpoint object to create.

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(String endpointId,
 Consumer<EndpointsRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
                                    throws AzDException

Delete a service endpoint.

Parameters:

endpointId - Endpoint Id of endpoint to delete.

requestConfiguration - Consumer of delete request configuration.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<ServiceEndpoint> getAsync(String endpointId)
                                            throws AzDException

Get the service endpoint details.

Parameters:

endpointId - Id of the service endpoint.

Returns:

Service endpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<ServiceEndpoint> getAsync(String endpointId,
 ServiceEndpointActionFilter actionFilter)
                                            throws AzDException

Get the service endpoint details.

Parameters:

endpointId - Id of the service endpoint.

actionFilter - Action filter for the service connection. It specifies the action which can be performed on the service connection.

Returns:

Service endpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<ServiceEndpoints> listAsync()
                                              throws AzDException

Get the service endpoints.

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<ServiceEndpoints> listAsync(Consumer<EndpointsRequestBuilder.RequestConfiguration> requestConfiguration)
                                              throws AzDException

Get the service endpoints.

Parameters:

requestConfiguration - Represents the query parameters

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

getByNamesAsync

public CompletableFuture<ServiceEndpoints> getByNamesAsync(String... endpointNames)
                                                    throws AzDException

Get the service endpoints by name.

Parameters:

endpointNames - Names of the service endpoints.

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

getByNamesAsync

public CompletableFuture<ServiceEndpoints> getByNamesAsync(Consumer<EndpointsRequestBuilder.RequestConfiguration> requestConfiguration)
                                                    throws AzDException

Get the service endpoints by name.

Parameters:

requestConfiguration - Represents the query parameters

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

getWithRefreshedAuthenticationAsync

public CompletableFuture<ServiceEndpoints> getWithRefreshedAuthenticationAsync(String[] endpointIds,
 List<RefreshAuthenticationParameters> refreshAuthenticationParameters)
                                                                        throws AzDException

Gets the service endpoints and patch new authorization parameters

Parameters:

endpointIds - Ids of the service endpoints.

refreshAuthenticationParameters - Scope, Validity of Token requested.

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

shareAsync

public CompletableFuture<Void> shareAsync(String endpointId,
 List<ServiceEndpointProjectReference> serviceEndpointProjectReferences)
                                   throws AzDException

Share service endpoint across projects

Parameters:

endpointId - Endpoint Id of the endpoint to share

serviceEndpointProjectReferences - Project reference details of the target project

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<ServiceEndpoint> updateAsync(String endpointId,
 ServiceEndpoint serviceEndpoint)
                                               throws AzDException

Update the service endpoint

Parameters:

endpointId - Endpoint Id of the endpoint to update

serviceEndpoint - Service endpoint object to update.

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<ServiceEndpoint> updateAsync(String endpointId,
 ServiceEndpoint serviceEndpoint,
 String operation)
                                               throws AzDException

Update the service endpoint

Parameters:

endpointId - Endpoint Id of the endpoint to update

serviceEndpoint - Service endpoint object to update.

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<ServiceEndpoints> updateAsync(ServiceEndpoints serviceEndpoints)
                                                throws AzDException

Update the service endpoints.

Parameters:

serviceEndpoints - service endpoints object to update

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

create

public ServiceEndpoint create(ServiceEndpoint serviceEndpoint)
                       throws AzDException

Creates a new service endpoint

Parameters:

serviceEndpoint - Service endpoint object to create.

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(String endpointId,
 Consumer<EndpointsRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
            throws AzDException

Delete a service endpoint.

Parameters:

endpointId - Endpoint Id of endpoint to delete.

requestConfiguration - Consumer of delete request configuration that represents the query parameters.

Throws:

AzDException - Default Api Exception handler.

get

public ServiceEndpoint get(String endpointId)
                    throws AzDException

Get the service endpoint details.

Parameters:

endpointId - Id of the service endpoint.

Returns:

Service endpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

get

public ServiceEndpoint get(String endpointId,
 ServiceEndpointActionFilter actionFilter)
                    throws AzDException

Get the service endpoint details.

Parameters:

endpointId - Id of the service endpoint.

actionFilter - Action filter for the service connection. It specifies the action which can be performed on the service connection.

Returns:

Service endpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

list

public ServiceEndpoints list()
                      throws AzDException

Get the service endpoints.

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

list

public ServiceEndpoints list(Consumer<EndpointsRequestBuilder.RequestConfiguration> requestConfiguration)
                      throws AzDException

Get the service endpoints.

Parameters:

requestConfiguration - Represents the query parameters

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

getByNames

public ServiceEndpoints getByNames(String... endpointNames)
                            throws AzDException

Get the service endpoints by name.

Parameters:

endpointNames - Names of the service endpoints.

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

getByNames

public ServiceEndpoints getByNames(Consumer<EndpointsRequestBuilder.RequestConfiguration> requestConfiguration)
                            throws AzDException

Get the service endpoints by name.

Parameters:

requestConfiguration - Represents the query parameters

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

getWithRefreshedAuthentication

public ServiceEndpoints getWithRefreshedAuthentication(String[] endpointIds,
 List<RefreshAuthenticationParameters> refreshAuthenticationParameters)
                                                throws AzDException

Gets the service endpoints and patch new authorization parameters

Parameters:

endpointIds - Ids of the service endpoints.

refreshAuthenticationParameters - Scope, Validity of Token requested.

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

share

public Void share(String endpointId,
 List<ServiceEndpointProjectReference> serviceEndpointProjectReferences)
           throws AzDException

Share service endpoint across projects

Parameters:

endpointId - Endpoint Id of the endpoint to share

serviceEndpointProjectReferences - Project reference details of the target project

Throws:

AzDException - Default Api Exception handler.

update

public ServiceEndpoint update(String endpointId,
 ServiceEndpoint serviceEndpoint)
                       throws AzDException

Update the service endpoint

Parameters:

endpointId - Endpoint Id of the endpoint to update

serviceEndpoint - Service endpoint object to update.

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

update

public ServiceEndpoint update(String endpointId,
 ServiceEndpoint serviceEndpoint,
 String operation)
                       throws AzDException

Update the service endpoint

Parameters:

endpointId - Endpoint Id of the endpoint to update

serviceEndpoint - Service endpoint object to update.

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

update

public ServiceEndpoints update(ServiceEndpoints serviceEndpoints)
                        throws AzDException

Update the service endpoints.

Parameters:

serviceEndpoints - service endpoints object to update

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.