Class CreateApiRequest (0.8.0) 

public final class CreateApiRequest extends GeneratedMessageV3 implements CreateApiRequestOrBuilder

The CreateApi method's request.

Protobuf type google.cloud.apihub.v1.CreateApiRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CreateApiRequest

Static Fields

API_FIELD_NUMBER

public static final int API_FIELD_NUMBER
Field Value
Type Description
int

API_ID_FIELD_NUMBER

public static final int 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 CreateApiRequest getDefaultInstance()
Returns
Type Description
CreateApiRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateApiRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getApi()

public Api getApi()

Required. The API resource to create.

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

Returns
Type Description
Api

The api.

getApiId()

public String getApiId()

Optional. The ID to use for the API resource, which will become the final component of the 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 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 api_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The apiId.

getApiIdBytes()

public ByteString getApiIdBytes()

Optional. The ID to use for the API resource, which will become the final component of the 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 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 api_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for apiId.

getApiOrBuilder()

public ApiOrBuilder getApiOrBuilder()

Required. The API resource to create.

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

Returns
Type Description
ApiOrBuilder

getDefaultInstanceForType()

public CreateApiRequest getDefaultInstanceForType()
Returns
Type Description
CreateApiRequest

getParent()

public String getParent()

Required. The parent resource for the 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 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<CreateApiRequest> getParserForType()
Returns
Type Description
Parser<CreateApiRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasApi()

public boolean hasApi()

Required. The API resource to create.

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

Returns
Type Description
boolean

Whether the api 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 CreateApiRequest.Builder newBuilderForType()
Returns
Type Description
CreateApiRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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