Interface CreateApiOperationRequestOrBuilder (0.28.0)

public interface CreateApiOperationRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiOperation()

public abstract ApiOperation getApiOperation()

Required. The operation resource to create.

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

Returns
Type Description
ApiOperation

The apiOperation.

getApiOperationId()

public abstract String getApiOperationId()

Optional. The ID to use for the operation resource, which will become the final component of the operation'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 operation resource in the API hub.
  • If not provided, a system generated id will be used.

    This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}, its length is limited to 700 characters, and valid characters are /a-z[0-9]-_/.

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

Returns
Type Description
String

The apiOperationId.

getApiOperationIdBytes()

public abstract ByteString getApiOperationIdBytes()

Optional. The ID to use for the operation resource, which will become the final component of the operation'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 operation resource in the API hub.
  • If not provided, a system generated id will be used.

    This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}, its length is limited to 700 characters, and valid characters are /a-z[0-9]-_/.

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

Returns
Type Description
ByteString

The bytes for apiOperationId.

getApiOperationOrBuilder()

public abstract ApiOperationOrBuilder getApiOperationOrBuilder()

Required. The operation resource to create.

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

Returns
Type Description
ApiOperationOrBuilder

getParent()

public abstract String getParent()

Required. The parent resource for the operation resource. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

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

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The parent resource for the operation resource. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

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

Returns
Type Description
ByteString

The bytes for parent.

hasApiOperation()

public abstract boolean hasApiOperation()

Required. The operation resource to create.

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

Returns
Type Description
boolean

Whether the apiOperation field is set.