com.pulumi.azure.apimanagement.ApiOperationArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.apimanagement;
import com.pulumi.azure.apimanagement.inputs.ApiOperationRequestArgs;
import com.pulumi.azure.apimanagement.inputs.ApiOperationResponseArgs;
import com.pulumi.azure.apimanagement.inputs.ApiOperationTemplateParameterArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ApiOperationArgs extends com.pulumi.resources.ResourceArgs {
public static final ApiOperationArgs Empty = new ApiOperationArgs();
/**
* The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
*
*/
@Import(name="apiManagementName", required=true)
private Output apiManagementName;
/**
* @return The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
*
*/
public Output apiManagementName() {
return this.apiManagementName;
}
/**
* The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
*
*/
@Import(name="apiName", required=true)
private Output apiName;
/**
* @return The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
*
*/
public Output apiName() {
return this.apiName;
}
/**
* A description for this API Operation, which may include HTML formatting tags.
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return A description for this API Operation, which may include HTML formatting tags.
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* The Display Name for this API Management Operation.
*
*/
@Import(name="displayName", required=true)
private Output displayName;
/**
* @return The Display Name for this API Management Operation.
*
*/
public Output displayName() {
return this.displayName;
}
/**
* The HTTP Method used for this API Management Operation, like `GET`, `DELETE`, `PUT` or `POST` - but not limited to these values.
*
*/
@Import(name="method", required=true)
private Output method;
/**
* @return The HTTP Method used for this API Management Operation, like `GET`, `DELETE`, `PUT` or `POST` - but not limited to these values.
*
*/
public Output method() {
return this.method;
}
/**
* A unique identifier for this API Operation. Changing this forces a new resource to be created.
*
*/
@Import(name="operationId", required=true)
private Output operationId;
/**
* @return A unique identifier for this API Operation. Changing this forces a new resource to be created.
*
*/
public Output operationId() {
return this.operationId;
}
/**
* A `request` block as defined below.
*
*/
@Import(name="request")
private @Nullable Output request;
/**
* @return A `request` block as defined below.
*
*/
public Optional> request() {
return Optional.ofNullable(this.request);
}
/**
* The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
*
*/
@Import(name="resourceGroupName", required=true)
private Output resourceGroupName;
/**
* @return The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* One or more `response` blocks as defined below.
*
*/
@Import(name="responses")
private @Nullable Output> responses;
/**
* @return One or more `response` blocks as defined below.
*
*/
public Optional>> responses() {
return Optional.ofNullable(this.responses);
}
/**
* One or more `template_parameter` blocks as defined below. Required if `url_template` contains one or more parameters.
*
*/
@Import(name="templateParameters")
private @Nullable Output> templateParameters;
/**
* @return One or more `template_parameter` blocks as defined below. Required if `url_template` contains one or more parameters.
*
*/
public Optional>> templateParameters() {
return Optional.ofNullable(this.templateParameters);
}
/**
* The relative URL Template identifying the target resource for this operation, which may include parameters.
*
*/
@Import(name="urlTemplate", required=true)
private Output urlTemplate;
/**
* @return The relative URL Template identifying the target resource for this operation, which may include parameters.
*
*/
public Output urlTemplate() {
return this.urlTemplate;
}
private ApiOperationArgs() {}
private ApiOperationArgs(ApiOperationArgs $) {
this.apiManagementName = $.apiManagementName;
this.apiName = $.apiName;
this.description = $.description;
this.displayName = $.displayName;
this.method = $.method;
this.operationId = $.operationId;
this.request = $.request;
this.resourceGroupName = $.resourceGroupName;
this.responses = $.responses;
this.templateParameters = $.templateParameters;
this.urlTemplate = $.urlTemplate;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ApiOperationArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ApiOperationArgs $;
public Builder() {
$ = new ApiOperationArgs();
}
public Builder(ApiOperationArgs defaults) {
$ = new ApiOperationArgs(Objects.requireNonNull(defaults));
}
/**
* @param apiManagementName The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder apiManagementName(Output apiManagementName) {
$.apiManagementName = apiManagementName;
return this;
}
/**
* @param apiManagementName The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder apiManagementName(String apiManagementName) {
return apiManagementName(Output.of(apiManagementName));
}
/**
* @param apiName The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder apiName(Output apiName) {
$.apiName = apiName;
return this;
}
/**
* @param apiName The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder apiName(String apiName) {
return apiName(Output.of(apiName));
}
/**
* @param description A description for this API Operation, which may include HTML formatting tags.
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description A description for this API Operation, which may include HTML formatting tags.
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param displayName The Display Name for this API Management Operation.
*
* @return builder
*
*/
public Builder displayName(Output displayName) {
$.displayName = displayName;
return this;
}
/**
* @param displayName The Display Name for this API Management Operation.
*
* @return builder
*
*/
public Builder displayName(String displayName) {
return displayName(Output.of(displayName));
}
/**
* @param method The HTTP Method used for this API Management Operation, like `GET`, `DELETE`, `PUT` or `POST` - but not limited to these values.
*
* @return builder
*
*/
public Builder method(Output method) {
$.method = method;
return this;
}
/**
* @param method The HTTP Method used for this API Management Operation, like `GET`, `DELETE`, `PUT` or `POST` - but not limited to these values.
*
* @return builder
*
*/
public Builder method(String method) {
return method(Output.of(method));
}
/**
* @param operationId A unique identifier for this API Operation. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder operationId(Output operationId) {
$.operationId = operationId;
return this;
}
/**
* @param operationId A unique identifier for this API Operation. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder operationId(String operationId) {
return operationId(Output.of(operationId));
}
/**
* @param request A `request` block as defined below.
*
* @return builder
*
*/
public Builder request(@Nullable Output request) {
$.request = request;
return this;
}
/**
* @param request A `request` block as defined below.
*
* @return builder
*
*/
public Builder request(ApiOperationRequestArgs request) {
return request(Output.of(request));
}
/**
* @param resourceGroupName The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder resourceGroupName(Output resourceGroupName) {
$.resourceGroupName = resourceGroupName;
return this;
}
/**
* @param resourceGroupName The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder resourceGroupName(String resourceGroupName) {
return resourceGroupName(Output.of(resourceGroupName));
}
/**
* @param responses One or more `response` blocks as defined below.
*
* @return builder
*
*/
public Builder responses(@Nullable Output> responses) {
$.responses = responses;
return this;
}
/**
* @param responses One or more `response` blocks as defined below.
*
* @return builder
*
*/
public Builder responses(List responses) {
return responses(Output.of(responses));
}
/**
* @param responses One or more `response` blocks as defined below.
*
* @return builder
*
*/
public Builder responses(ApiOperationResponseArgs... responses) {
return responses(List.of(responses));
}
/**
* @param templateParameters One or more `template_parameter` blocks as defined below. Required if `url_template` contains one or more parameters.
*
* @return builder
*
*/
public Builder templateParameters(@Nullable Output> templateParameters) {
$.templateParameters = templateParameters;
return this;
}
/**
* @param templateParameters One or more `template_parameter` blocks as defined below. Required if `url_template` contains one or more parameters.
*
* @return builder
*
*/
public Builder templateParameters(List templateParameters) {
return templateParameters(Output.of(templateParameters));
}
/**
* @param templateParameters One or more `template_parameter` blocks as defined below. Required if `url_template` contains one or more parameters.
*
* @return builder
*
*/
public Builder templateParameters(ApiOperationTemplateParameterArgs... templateParameters) {
return templateParameters(List.of(templateParameters));
}
/**
* @param urlTemplate The relative URL Template identifying the target resource for this operation, which may include parameters.
*
* @return builder
*
*/
public Builder urlTemplate(Output urlTemplate) {
$.urlTemplate = urlTemplate;
return this;
}
/**
* @param urlTemplate The relative URL Template identifying the target resource for this operation, which may include parameters.
*
* @return builder
*
*/
public Builder urlTemplate(String urlTemplate) {
return urlTemplate(Output.of(urlTemplate));
}
public ApiOperationArgs build() {
if ($.apiManagementName == null) {
throw new MissingRequiredPropertyException("ApiOperationArgs", "apiManagementName");
}
if ($.apiName == null) {
throw new MissingRequiredPropertyException("ApiOperationArgs", "apiName");
}
if ($.displayName == null) {
throw new MissingRequiredPropertyException("ApiOperationArgs", "displayName");
}
if ($.method == null) {
throw new MissingRequiredPropertyException("ApiOperationArgs", "method");
}
if ($.operationId == null) {
throw new MissingRequiredPropertyException("ApiOperationArgs", "operationId");
}
if ($.resourceGroupName == null) {
throw new MissingRequiredPropertyException("ApiOperationArgs", "resourceGroupName");
}
if ($.urlTemplate == null) {
throw new MissingRequiredPropertyException("ApiOperationArgs", "urlTemplate");
}
return $;
}
}
}