Class HttpOperationDetails (0.28.0)

public final class HttpOperationDetails extends GeneratedMessageV3 implements HttpOperationDetailsOrBuilder

An HTTP-based API Operation, sometimes called a "REST" Operation.

Protobuf type google.cloud.apihub.v1.HttpOperationDetails

Static Fields

HTTP_OPERATION_FIELD_NUMBER

public static final int HTTP_OPERATION_FIELD_NUMBER
Field Value
Type Description
int

PATH_PARAMS_FIELD_NUMBER

public static final int PATH_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_PARAMS_FIELD_NUMBER

public static final int QUERY_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_FIELD_NUMBER

public static final int REQUEST_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_FIELD_NUMBER

public static final int RESPONSE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HttpOperationDetails getDefaultInstance()
Returns
Type Description
HttpOperationDetails

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HttpOperationDetails.Builder newBuilder()
Returns
Type Description
HttpOperationDetails.Builder

newBuilder(HttpOperationDetails prototype)

public static HttpOperationDetails.Builder newBuilder(HttpOperationDetails prototype)
Parameter
Name Description
prototype HttpOperationDetails
Returns
Type Description
HttpOperationDetails.Builder

parseDelimitedFrom(InputStream input)

public static HttpOperationDetails parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpOperationDetails parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HttpOperationDetails parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpOperationDetails parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpOperationDetails parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpOperationDetails parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HttpOperationDetails parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpOperationDetails parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HttpOperationDetails parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpOperationDetails parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HttpOperationDetails parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpOperationDetails parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpOperationDetails
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HttpOperationDetails> parser()
Returns
Type Description
Parser<HttpOperationDetails>

Methods

containsQueryParams(String key)

public boolean containsQueryParams(String key)

Optional. Query params of HttpOperation

map<string, .google.cloud.apihub.v1.HttpOperationDetails.QueryParam> query_params = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public HttpOperationDetails getDefaultInstanceForType()
Returns
Type Description
HttpOperationDetails

getHttpOperation()

public HttpOperation getHttpOperation()

Required. An HTTP Operation.

.google.cloud.apihub.v1.HttpOperation http_operation = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
HttpOperation

The httpOperation.

getHttpOperationOrBuilder()

public HttpOperationOrBuilder getHttpOperationOrBuilder()

Required. An HTTP Operation.

.google.cloud.apihub.v1.HttpOperation http_operation = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
HttpOperationOrBuilder

getParserForType()

public Parser<HttpOperationDetails> getParserForType()
Returns
Type Description
Parser<HttpOperationDetails>
Overrides

getPathParams(int index)

public HttpOperationDetails.PathParam getPathParams(int index)

Optional. Path params of HttpOperation

repeated .google.cloud.apihub.v1.HttpOperationDetails.PathParam path_params = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
HttpOperationDetails.PathParam

getPathParamsCount()

public int getPathParamsCount()

Optional. Path params of HttpOperation

repeated .google.cloud.apihub.v1.HttpOperationDetails.PathParam path_params = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getPathParamsList()

public List<HttpOperationDetails.PathParam> getPathParamsList()

Optional. Path params of HttpOperation

repeated .google.cloud.apihub.v1.HttpOperationDetails.PathParam path_params = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<PathParam>

getPathParamsOrBuilder(int index)

public HttpOperationDetails.PathParamOrBuilder getPathParamsOrBuilder(int index)

Optional. Path params of HttpOperation

repeated .google.cloud.apihub.v1.HttpOperationDetails.PathParam path_params = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
HttpOperationDetails.PathParamOrBuilder

getPathParamsOrBuilderList()

public List<? extends HttpOperationDetails.PathParamOrBuilder> getPathParamsOrBuilderList()

Optional. Path params of HttpOperation

repeated .google.cloud.apihub.v1.HttpOperationDetails.PathParam path_params = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.apihub.v1.HttpOperationDetails.PathParamOrBuilder>

getQueryParams() (deprecated)

public Map<String,HttpOperationDetails.QueryParam> getQueryParams()

Use #getQueryParamsMap() instead.

Returns
Type Description
Map<String,QueryParam>

getQueryParamsCount()

public int getQueryParamsCount()

Optional. Query params of HttpOperation

map<string, .google.cloud.apihub.v1.HttpOperationDetails.QueryParam> query_params = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getQueryParamsMap()

public Map<String,HttpOperationDetails.QueryParam> getQueryParamsMap()

Optional. Query params of HttpOperation

map<string, .google.cloud.apihub.v1.HttpOperationDetails.QueryParam> query_params = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,QueryParam>

getQueryParamsOrDefault(String key, HttpOperationDetails.QueryParam defaultValue)

public HttpOperationDetails.QueryParam getQueryParamsOrDefault(String key, HttpOperationDetails.QueryParam defaultValue)

Optional. Query params of HttpOperation

map<string, .google.cloud.apihub.v1.HttpOperationDetails.QueryParam> query_params = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue HttpOperationDetails.QueryParam
Returns
Type Description
HttpOperationDetails.QueryParam

getQueryParamsOrThrow(String key)

public HttpOperationDetails.QueryParam getQueryParamsOrThrow(String key)

Optional. Query params of HttpOperation

map<string, .google.cloud.apihub.v1.HttpOperationDetails.QueryParam> query_params = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
HttpOperationDetails.QueryParam

getRequest()

public HttpOperationDetails.HttpRequest getRequest()

Optional. Request metadata.

.google.cloud.apihub.v1.HttpOperationDetails.HttpRequest request = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HttpOperationDetails.HttpRequest

The request.

getRequestOrBuilder()

public HttpOperationDetails.HttpRequestOrBuilder getRequestOrBuilder()

Optional. Request metadata.

.google.cloud.apihub.v1.HttpOperationDetails.HttpRequest request = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HttpOperationDetails.HttpRequestOrBuilder

getResponse()

public HttpOperationDetails.HttpResponse getResponse()

Optional. Response metadata.

.google.cloud.apihub.v1.HttpOperationDetails.HttpResponse response = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HttpOperationDetails.HttpResponse

The response.

getResponseOrBuilder()

public HttpOperationDetails.HttpResponseOrBuilder getResponseOrBuilder()

Optional. Response metadata.

.google.cloud.apihub.v1.HttpOperationDetails.HttpResponse response = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HttpOperationDetails.HttpResponseOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasHttpOperation()

public boolean hasHttpOperation()

Required. An HTTP Operation.

.google.cloud.apihub.v1.HttpOperation http_operation = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the httpOperation field is set.

hasRequest()

public boolean hasRequest()

Optional. Request metadata.

.google.cloud.apihub.v1.HttpOperationDetails.HttpRequest request = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the request field is set.

hasResponse()

public boolean hasResponse()

Optional. Response metadata.

.google.cloud.apihub.v1.HttpOperationDetails.HttpResponse response = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the response field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HttpOperationDetails.Builder newBuilderForType()
Returns
Type Description
HttpOperationDetails.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpOperationDetails.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HttpOperationDetails.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HttpOperationDetails.Builder toBuilder()
Returns
Type Description
HttpOperationDetails.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException