com.amazonaws.services.cognitoidp.model.CreateResourceServerRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidp Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cognitoidp.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateResourceServerRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The user pool ID for the user pool.
*
*/
private String userPoolId;
/**
*
* A unique resource server identifier for the resource server. The identifier can be an API friendly name like
* solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
*
*
* Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access
* tokens.
*
*/
private String identifier;
/**
*
* A friendly name for the resource server.
*
*/
private String name;
/**
*
* A list of scopes. Each scope is a key-value map with the keys name and description.
*
*/
private java.util.List scopes;
/**
*
* The user pool ID for the user pool.
*
*
* @param userPoolId
* The user pool ID for the user pool.
*/
public void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
/**
*
* The user pool ID for the user pool.
*
*
* @return The user pool ID for the user pool.
*/
public String getUserPoolId() {
return this.userPoolId;
}
/**
*
* The user pool ID for the user pool.
*
*
* @param userPoolId
* The user pool ID for the user pool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResourceServerRequest withUserPoolId(String userPoolId) {
setUserPoolId(userPoolId);
return this;
}
/**
*
* A unique resource server identifier for the resource server. The identifier can be an API friendly name like
* solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
*
*
* Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access
* tokens.
*
*
* @param identifier
* A unique resource server identifier for the resource server. The identifier can be an API friendly name
* like solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
*
* Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your
* access tokens.
*/
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
/**
*
* A unique resource server identifier for the resource server. The identifier can be an API friendly name like
* solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
*
*
* Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access
* tokens.
*
*
* @return A unique resource server identifier for the resource server. The identifier can be an API friendly name
* like solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
*
* Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of
* your access tokens.
*/
public String getIdentifier() {
return this.identifier;
}
/**
*
* A unique resource server identifier for the resource server. The identifier can be an API friendly name like
* solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
*
*
* Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access
* tokens.
*
*
* @param identifier
* A unique resource server identifier for the resource server. The identifier can be an API friendly name
* like solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
*
* Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your
* access tokens.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResourceServerRequest withIdentifier(String identifier) {
setIdentifier(identifier);
return this;
}
/**
*
* A friendly name for the resource server.
*
*
* @param name
* A friendly name for the resource server.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name for the resource server.
*
*
* @return A friendly name for the resource server.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name for the resource server.
*
*
* @param name
* A friendly name for the resource server.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResourceServerRequest withName(String name) {
setName(name);
return this;
}
/**
*
* A list of scopes. Each scope is a key-value map with the keys name and description.
*
*
* @return A list of scopes. Each scope is a key-value map with the keys name and
* description.
*/
public java.util.List getScopes() {
return scopes;
}
/**
*
* A list of scopes. Each scope is a key-value map with the keys name and description.
*
*
* @param scopes
* A list of scopes. Each scope is a key-value map with the keys name and
* description.
*/
public void setScopes(java.util.Collection scopes) {
if (scopes == null) {
this.scopes = null;
return;
}
this.scopes = new java.util.ArrayList(scopes);
}
/**
*
* A list of scopes. Each scope is a key-value map with the keys name and description.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setScopes(java.util.Collection)} or {@link #withScopes(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param scopes
* A list of scopes. Each scope is a key-value map with the keys name and
* description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResourceServerRequest withScopes(ResourceServerScopeType... scopes) {
if (this.scopes == null) {
setScopes(new java.util.ArrayList(scopes.length));
}
for (ResourceServerScopeType ele : scopes) {
this.scopes.add(ele);
}
return this;
}
/**
*
* A list of scopes. Each scope is a key-value map with the keys name and description.
*
*
* @param scopes
* A list of scopes. Each scope is a key-value map with the keys name and
* description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResourceServerRequest withScopes(java.util.Collection scopes) {
setScopes(scopes);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUserPoolId() != null)
sb.append("UserPoolId: ").append(getUserPoolId()).append(",");
if (getIdentifier() != null)
sb.append("Identifier: ").append(getIdentifier()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getScopes() != null)
sb.append("Scopes: ").append(getScopes());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateResourceServerRequest == false)
return false;
CreateResourceServerRequest other = (CreateResourceServerRequest) obj;
if (other.getUserPoolId() == null ^ this.getUserPoolId() == null)
return false;
if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false)
return false;
if (other.getIdentifier() == null ^ this.getIdentifier() == null)
return false;
if (other.getIdentifier() != null && other.getIdentifier().equals(this.getIdentifier()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getScopes() == null ^ this.getScopes() == null)
return false;
if (other.getScopes() != null && other.getScopes().equals(this.getScopes()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode());
hashCode = prime * hashCode + ((getIdentifier() == null) ? 0 : getIdentifier().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getScopes() == null) ? 0 : getScopes().hashCode());
return hashCode;
}
@Override
public CreateResourceServerRequest clone() {
return (CreateResourceServerRequest) super.clone();
}
}