AliasesApi.GetAliasByName (Solr 9.6.0 solrj API)

java.lang.Object
- org.apache.solr.client.solrj.SolrRequest<AliasesApi.GetAliasByNameResponse>
- - org.apache.solr.client.solrj.request.AliasesApi.GetAliasByName

All Implemented Interfaces:: Serializable

Enclosing class:: AliasesApi

public static class AliasesApi.GetAliasByName
extends SolrRequest<AliasesApi.GetAliasByNameResponse>

See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.solr.client.solrj.SolrRequest
  SolrRequest.METHOD, SolrRequest.SolrClientContext, SolrRequest.SolrRequestType

Field Summary
- Fields inherited from class org.apache.solr.client.solrj.SolrRequest
  SUPPORTED_METHODS, useBinaryV2, usev2

Constructor Summary

Constructors
Constructor Description

GetAliasByName(String aliasName)
Create a GetAliasByName request object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected AliasesApi.GetAliasByNameResponse`	`createResponse(SolrClient client)`	Create a new SolrResponse to hold the response from the server
`SolrParams`	`getParams()`
`String`	`getRequestType()`	This method defines the type of this Solr request.
`ResponseParser`	`getResponseParser()`

Methods inherited from class org.apache.solr.client.solrj.SolrRequest
addHeader, addHeaders, getBasePath, getBasicAuthPassword, getBasicAuthUser, getCollection, getContentStreams, getContentWriter, getHeaders, getMethod, getPath, getPreferredNodes, getQueryParams, getStreamingResponseCallback, getUserPrincipal, process, process, requiresCollection, setBasePath, setBasicAuthCredentials, setMethod, setPath, setPreferredNodes, setQueryParams, setResponseParser, setStreamingResponseCallback, setUseBinaryV2, setUserPrincipal, setUseV2

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GetAliasByName
```
public GetAliasByName(String aliasName)
```
    Create a GetAliasByName request object.
    
    Parameters:
    
    aliasName - Path param - Alias name.
- Method Detail
  - getRequestType
```
public String getRequestType()
```
    Description copied from class: SolrRequest
    
    This method defines the type of this Solr request.
    
    Specified by:
    
    getRequestType in class SolrRequest<AliasesApi.GetAliasByNameResponse>
  - getParams
```
public SolrParams getParams()
```
    Specified by:
    
    getParams in class SolrRequest<AliasesApi.GetAliasByNameResponse>
  - createResponse
```
protected AliasesApi.GetAliasByNameResponse createResponse(SolrClient client)
```
    Description copied from class: SolrRequest
    
    Create a new SolrResponse to hold the response from the server
    
    Specified by:
    
    createResponse in class SolrRequest<AliasesApi.GetAliasByNameResponse>
    
    Parameters:
    
    client - the SolrClient the request will be sent to
  - getResponseParser
```
public ResponseParser getResponseParser()
```
    Overrides:
    
    getResponseParser in class SolrRequest<AliasesApi.GetAliasByNameResponse>
    
    Returns:
    
    The ResponseParser