Class CreateExternalApiRequest (0.5.0)

public final class CreateExternalApiRequest extends GeneratedMessageV3 implements CreateExternalApiRequestOrBuilder

The CreateExternalApi method's request.

Protobuf type google.cloud.apihub.v1.CreateExternalApiRequest

Static Fields

EXTERNAL_API_FIELD_NUMBER

public static final int EXTERNAL_API_FIELD_NUMBER
Field Value
Type Description
int

EXTERNAL_API_ID_FIELD_NUMBER

public static final int EXTERNAL_API_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateExternalApiRequest getDefaultInstance()
Returns
Type Description
CreateExternalApiRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateExternalApiRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreateExternalApiRequest getDefaultInstanceForType()
Returns
Type Description
CreateExternalApiRequest

getExternalApi()

public ExternalApi getExternalApi()

Required. The External API resource to create.

.google.cloud.apihub.v1.ExternalApi external_api = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExternalApi

The externalApi.

getExternalApiId()

public String getExternalApiId()

Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.

  • If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub.
  • If not provided, a system generated id will be used.

    This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.

string external_api_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The externalApiId.

getExternalApiIdBytes()

public ByteString getExternalApiIdBytes()

Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.

  • If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub.
  • If not provided, a system generated id will be used.

    This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.

string external_api_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for externalApiId.

getExternalApiOrBuilder()

public ExternalApiOrBuilder getExternalApiOrBuilder()

Required. The External API resource to create.

.google.cloud.apihub.v1.ExternalApi external_api = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExternalApiOrBuilder

getParent()

public String getParent()

Required. The parent resource for the External API resource. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource for the External API resource. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasExternalApi()

public boolean hasExternalApi()

Required. The External API resource to create.

.google.cloud.apihub.v1.ExternalApi external_api = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the externalApi field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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