Class CreateExternalApiRequest.Builder (0.5.0)

public static final class CreateExternalApiRequest.Builder extends GeneratedMessageV3.Builder<CreateExternalApiRequest.Builder> implements CreateExternalApiRequestOrBuilder

The CreateExternalApi method's request.

Protobuf type google.cloud.apihub.v1.CreateExternalApiRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateExternalApiRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides

build()

public CreateExternalApiRequest build()
Returns
Type Description
CreateExternalApiRequest

buildPartial()

public CreateExternalApiRequest buildPartial()
Returns
Type Description
CreateExternalApiRequest

clear()

public CreateExternalApiRequest.Builder clear()
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides

clearExternalApi()

public CreateExternalApiRequest.Builder clearExternalApi()

Required. The External API resource to create.

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

Returns
Type Description
CreateExternalApiRequest.Builder

clearExternalApiId()

public CreateExternalApiRequest.Builder clearExternalApiId()

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
CreateExternalApiRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateExternalApiRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateExternalApiRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides

clearParent()

public CreateExternalApiRequest.Builder clearParent()

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
CreateExternalApiRequest.Builder

This builder for chaining.

clone()

public CreateExternalApiRequest.Builder clone()
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides

getDefaultInstanceForType()

public CreateExternalApiRequest getDefaultInstanceForType()
Returns
Type Description
CreateExternalApiRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExternalApiBuilder()

public ExternalApi.Builder getExternalApiBuilder()

Required. The External API resource to create.

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

Returns
Type Description
ExternalApi.Builder

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExternalApi(ExternalApi value)

public CreateExternalApiRequest.Builder mergeExternalApi(ExternalApi value)

Required. The External API resource to create.

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

Parameter
Name Description
value ExternalApi
Returns
Type Description
CreateExternalApiRequest.Builder

mergeFrom(CreateExternalApiRequest other)

public CreateExternalApiRequest.Builder mergeFrom(CreateExternalApiRequest other)
Parameter
Name Description
other CreateExternalApiRequest
Returns
Type Description
CreateExternalApiRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateExternalApiRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateExternalApiRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateExternalApiRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides

setExternalApi(ExternalApi value)

public CreateExternalApiRequest.Builder setExternalApi(ExternalApi value)

Required. The External API resource to create.

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

Parameter
Name Description
value ExternalApi
Returns
Type Description
CreateExternalApiRequest.Builder

setExternalApi(ExternalApi.Builder builderForValue)

public CreateExternalApiRequest.Builder setExternalApi(ExternalApi.Builder builderForValue)

Required. The External API resource to create.

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

Parameter
Name Description
builderForValue ExternalApi.Builder
Returns
Type Description
CreateExternalApiRequest.Builder

setExternalApiId(String value)

public CreateExternalApiRequest.Builder setExternalApiId(String value)

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];

Parameter
Name Description
value String

The externalApiId to set.

Returns
Type Description
CreateExternalApiRequest.Builder

This builder for chaining.

setExternalApiIdBytes(ByteString value)

public CreateExternalApiRequest.Builder setExternalApiIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for externalApiId to set.

Returns
Type Description
CreateExternalApiRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateExternalApiRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides

setParent(String value)

public CreateExternalApiRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateExternalApiRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateExternalApiRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateExternalApiRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreateExternalApiRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateExternalApiRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateExternalApiRequest.Builder
Overrides