com.pulumi.azurenative.apimanagement.outputs.GetApiOperationResult Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** 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.azurenative.apimanagement.outputs;
import com.pulumi.azurenative.apimanagement.outputs.ParameterContractResponse;
import com.pulumi.azurenative.apimanagement.outputs.RequestContractResponse;
import com.pulumi.azurenative.apimanagement.outputs.ResponseContractResponse;
import com.pulumi.core.annotations.CustomType;
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;
@CustomType
public final class GetApiOperationResult {
/**
* @return Description of the operation. May include HTML formatting tags.
*
*/
private @Nullable String description;
/**
* @return Operation Name.
*
*/
private String displayName;
/**
* @return Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*
*/
private String id;
/**
* @return A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
*
*/
private String method;
/**
* @return The name of the resource
*
*/
private String name;
/**
* @return Operation Policies
*
*/
private @Nullable String policies;
/**
* @return An entity containing request details.
*
*/
private @Nullable RequestContractResponse request;
/**
* @return Array of Operation responses.
*
*/
private @Nullable List responses;
/**
* @return Collection of URL template parameters.
*
*/
private @Nullable List templateParameters;
/**
* @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
private String type;
/**
* @return Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
*
*/
private String urlTemplate;
private GetApiOperationResult() {}
/**
* @return Description of the operation. May include HTML formatting tags.
*
*/
public Optional description() {
return Optional.ofNullable(this.description);
}
/**
* @return Operation Name.
*
*/
public String displayName() {
return this.displayName;
}
/**
* @return Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*
*/
public String id() {
return this.id;
}
/**
* @return A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
*
*/
public String method() {
return this.method;
}
/**
* @return The name of the resource
*
*/
public String name() {
return this.name;
}
/**
* @return Operation Policies
*
*/
public Optional policies() {
return Optional.ofNullable(this.policies);
}
/**
* @return An entity containing request details.
*
*/
public Optional request() {
return Optional.ofNullable(this.request);
}
/**
* @return Array of Operation responses.
*
*/
public List responses() {
return this.responses == null ? List.of() : this.responses;
}
/**
* @return Collection of URL template parameters.
*
*/
public List templateParameters() {
return this.templateParameters == null ? List.of() : this.templateParameters;
}
/**
* @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
public String type() {
return this.type;
}
/**
* @return Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
*
*/
public String urlTemplate() {
return this.urlTemplate;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(GetApiOperationResult defaults) {
return new Builder(defaults);
}
@CustomType.Builder
public static final class Builder {
private @Nullable String description;
private String displayName;
private String id;
private String method;
private String name;
private @Nullable String policies;
private @Nullable RequestContractResponse request;
private @Nullable List responses;
private @Nullable List templateParameters;
private String type;
private String urlTemplate;
public Builder() {}
public Builder(GetApiOperationResult defaults) {
Objects.requireNonNull(defaults);
this.description = defaults.description;
this.displayName = defaults.displayName;
this.id = defaults.id;
this.method = defaults.method;
this.name = defaults.name;
this.policies = defaults.policies;
this.request = defaults.request;
this.responses = defaults.responses;
this.templateParameters = defaults.templateParameters;
this.type = defaults.type;
this.urlTemplate = defaults.urlTemplate;
}
@CustomType.Setter
public Builder description(@Nullable String description) {
this.description = description;
return this;
}
@CustomType.Setter
public Builder displayName(String displayName) {
if (displayName == null) {
throw new MissingRequiredPropertyException("GetApiOperationResult", "displayName");
}
this.displayName = displayName;
return this;
}
@CustomType.Setter
public Builder id(String id) {
if (id == null) {
throw new MissingRequiredPropertyException("GetApiOperationResult", "id");
}
this.id = id;
return this;
}
@CustomType.Setter
public Builder method(String method) {
if (method == null) {
throw new MissingRequiredPropertyException("GetApiOperationResult", "method");
}
this.method = method;
return this;
}
@CustomType.Setter
public Builder name(String name) {
if (name == null) {
throw new MissingRequiredPropertyException("GetApiOperationResult", "name");
}
this.name = name;
return this;
}
@CustomType.Setter
public Builder policies(@Nullable String policies) {
this.policies = policies;
return this;
}
@CustomType.Setter
public Builder request(@Nullable RequestContractResponse request) {
this.request = request;
return this;
}
@CustomType.Setter
public Builder responses(@Nullable List responses) {
this.responses = responses;
return this;
}
public Builder responses(ResponseContractResponse... responses) {
return responses(List.of(responses));
}
@CustomType.Setter
public Builder templateParameters(@Nullable List templateParameters) {
this.templateParameters = templateParameters;
return this;
}
public Builder templateParameters(ParameterContractResponse... templateParameters) {
return templateParameters(List.of(templateParameters));
}
@CustomType.Setter
public Builder type(String type) {
if (type == null) {
throw new MissingRequiredPropertyException("GetApiOperationResult", "type");
}
this.type = type;
return this;
}
@CustomType.Setter
public Builder urlTemplate(String urlTemplate) {
if (urlTemplate == null) {
throw new MissingRequiredPropertyException("GetApiOperationResult", "urlTemplate");
}
this.urlTemplate = urlTemplate;
return this;
}
public GetApiOperationResult build() {
final var _resultValue = new GetApiOperationResult();
_resultValue.description = description;
_resultValue.displayName = displayName;
_resultValue.id = id;
_resultValue.method = method;
_resultValue.name = name;
_resultValue.policies = policies;
_resultValue.request = request;
_resultValue.responses = responses;
_resultValue.templateParameters = templateParameters;
_resultValue.type = type;
_resultValue.urlTemplate = urlTemplate;
return _resultValue;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy