Class DataProductAccessRequest.Builder (1.91.0)

public static final class DataProductAccessRequest.Builder extends GeneratedMessage.Builder<DataProductAccessRequest.Builder> implements DataProductAccessRequestOrBuilder

Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS.

Protobuf type google.cloud.dataplex.v1.DataProductAccessRequest

Static Methods

getDescriptor()

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

Methods

build()

public DataProductAccessRequest build()
Returns
Type Description
DataProductAccessRequest

buildPartial()

public DataProductAccessRequest buildPartial()
Returns
Type Description
DataProductAccessRequest

clear()

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

clearAccessGroupDisplayName()

public DataProductAccessRequest.Builder clearAccessGroupDisplayName()

Output only. The display name of the access group defined in the Data Product for which access is being requested.

string access_group_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.

clearAccessGroupId()

public DataProductAccessRequest.Builder clearAccessGroupId()

Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.

string access_group_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.

clearParent()

public DataProductAccessRequest.Builder clearParent()

Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}

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

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.

clearRequestedPrincipal()

public DataProductAccessRequest.Builder clearRequestedPrincipal()

Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers

optional string requested_principal = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.

getAccessGroupDisplayName()

public String getAccessGroupDisplayName()

Output only. The display name of the access group defined in the Data Product for which access is being requested.

string access_group_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The accessGroupDisplayName.

getAccessGroupDisplayNameBytes()

public ByteString getAccessGroupDisplayNameBytes()

Output only. The display name of the access group defined in the Data Product for which access is being requested.

string access_group_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for accessGroupDisplayName.

getAccessGroupId()

public String getAccessGroupId()

Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.

string access_group_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The accessGroupId.

getAccessGroupIdBytes()

public ByteString getAccessGroupIdBytes()

Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.

string access_group_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for accessGroupId.

getDefaultInstanceForType()

public DataProductAccessRequest getDefaultInstanceForType()
Returns
Type Description
DataProductAccessRequest

getDescriptorForType()

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

getParent()

public String getParent()

Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}

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

Returns
Type Description
ByteString

The bytes for parent.

getRequestedPrincipal()

public String getRequestedPrincipal()

Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers

optional string requested_principal = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The requestedPrincipal.

getRequestedPrincipalBytes()

public ByteString getRequestedPrincipalBytes()

Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers

optional string requested_principal = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for requestedPrincipal.

hasRequestedPrincipal()

public boolean hasRequestedPrincipal()

Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers

optional string requested_principal = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the requestedPrincipal field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataProductAccessRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setAccessGroupDisplayName(String value)

public DataProductAccessRequest.Builder setAccessGroupDisplayName(String value)

Output only. The display name of the access group defined in the Data Product for which access is being requested.

string access_group_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The accessGroupDisplayName to set.

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.

setAccessGroupDisplayNameBytes(ByteString value)

public DataProductAccessRequest.Builder setAccessGroupDisplayNameBytes(ByteString value)

Output only. The display name of the access group defined in the Data Product for which access is being requested.

string access_group_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for accessGroupDisplayName to set.

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.

setAccessGroupId(String value)

public DataProductAccessRequest.Builder setAccessGroupId(String value)

Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.

string access_group_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The accessGroupId to set.

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.

setAccessGroupIdBytes(ByteString value)

public DataProductAccessRequest.Builder setAccessGroupIdBytes(ByteString value)

Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.

string access_group_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for accessGroupId to set.

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.

setParent(String value)

public DataProductAccessRequest.Builder setParent(String value)

Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public DataProductAccessRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}

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

This builder for chaining.

setRequestedPrincipal(String value)

public DataProductAccessRequest.Builder setRequestedPrincipal(String value)

Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers

optional string requested_principal = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The requestedPrincipal to set.

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.

setRequestedPrincipalBytes(ByteString value)

public DataProductAccessRequest.Builder setRequestedPrincipalBytes(ByteString value)

Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers

optional string requested_principal = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for requestedPrincipal to set.

Returns
Type Description
DataProductAccessRequest.Builder

This builder for chaining.