Klasse UpdateApiOperationSpec

java.lang.Object

io.github.primelib.webmethodsapigateway4j.operations.UpdateApiOperationSpec

@Generated("io.github.primelib.primecodegen")
public class UpdateApiOperationSpec
extends Object

UpdateApi

This REST operation is used to update an API by importing a file, url or inline. While updating the API, visibility of the operations can be set by enabling or disabling the operations. Disabled operations will not be exposed to the customers. By default, all the operations are exposed to the consumers. When updating the API using file or url, API Gateway overwrite the resources/operations for the API. But it will retain the maturity state, scopes, visibility and if API mocking is enabled, then default mocked responses, mocked conditions and IS services will also be retained.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static Boolean	VALIDATION_ENABLED	allows to disable validation of the spec, use with care!

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
UpdateApiOperationSpec(Consumer<UpdateApiOperationSpec> spec)	Constructs a validated instance of UpdateApiOperationSpec.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
@NonNull String	apiId()	API Id for the API to be updated
UpdateApiOperationSpec	apiId(@NonNull String apiId)	API Id for the API to be updated
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
@Nullable Boolean	overwriteTags()	When an API is updated using a URL / file, the existing tags will be overwritten if this value is true.
UpdateApiOperationSpec	overwriteTags(@Nullable Boolean overwriteTags)	When an API is updated using a URL / file, the existing tags will be overwritten if this value is true.
@NonNull UpdateAPIB	payload()	payload
UpdateApiOperationSpec	payload(@NonNull UpdateAPIB payload)	payload
String	toString()
void	validate()	Validates the Spec, will throw a exception if required parameters are missing

Von Klasse geerbte Methoden java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Felddetails

VALIDATION_ENABLED

@Experimental
public static Boolean VALIDATION_ENABLED

allows to disable validation of the spec, use with care!

Konstruktordetails

UpdateApiOperationSpec

@Internal
public UpdateApiOperationSpec(Consumer<UpdateApiOperationSpec> spec)

Constructs a validated instance of UpdateApiOperationSpec.

Parameter:

spec - the specification to process

Methodendetails

validate

public void validate()

Validates the Spec, will throw a exception if required parameters are missing

Löst aus:

NullPointerException

apiId

public @NonNull String apiId()

API Id for the API to be updated

overwriteTags

public @Nullable Boolean overwriteTags()

When an API is updated using a URL / file, the existing tags will be overwritten if this value is true.

payload

public @NonNull UpdateAPIB payload()

payload

apiId

public UpdateApiOperationSpec apiId(@NonNull String apiId)

API Id for the API to be updated

Gibt zurück:

this.

overwriteTags

public UpdateApiOperationSpec overwriteTags(@Nullable Boolean overwriteTags)

When an API is updated using a URL / file, the existing tags will be overwritten if this value is true.

Gibt zurück:

this.

payload

public UpdateApiOperationSpec payload(@NonNull UpdateAPIB payload)

payload

Gibt zurück:

this.

equals

public boolean equals(Object o)

Setzt außer Kraft:

equals in Klasse Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Setzt außer Kraft:

hashCode in Klasse Object

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object